📦 More progress on unlock challenges

Author: MrCrayfish

docs/custom-backpack/distribution.md

@@ -0,0 +1,2 @@
+# Distribution
+

docs/custom-backpack/setting-the-unlock-challenge/index.md

@@ -40,4 +40,4 @@ Every backpack has it's translation key created based on the **namespace** and t
 
 ## Next Step
 
-It's time to [add a challenge](/docs/custom-backpack/setting-the-unlock-challenge/index.md) to unlock the backpack and give the player a fun goal!
+It's time to [add a challenge](/docs/custom-backpack/unlock-challenges/introduction.md) to unlock the backpack and give the player a fun goal!

docs/custom-backpack/translations.md

@@ -0,0 +1,6 @@
+{
+  "label": "Unlock Challenges",
+  "position": 7,
+  "collapsible": true,
+  "collapsed": false
+}

docs/custom-backpack/unlock-challenges/_category_.json

@@ -1,3 +1,7 @@
+---
+sidebar_position: 3
+---
+
 # Challenge Types
 
 Backpacked comes with many built-in challenge types
@@ -69,7 +73,7 @@ Backpacked comes with many built-in challenge types
 
 | Key            | Type    | Required | Default | Description                                                                                                                                                                                                                                                                    |
 | -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `crafted_item` | Object  | No       | —       | A crafted item predicate object. If not defined or an empty object, any item will count towards the crafting goal. See [Crafted Item Predicate](/docs/custom-backpack/setting-the-unlock-challenge/predicates.mdx#crafted-item-predicate) for documentation and more examples. |
+| `crafted_item` | Object  | No       | —       | A crafted item predicate object. If not defined or an empty object, any item will count towards the crafting goal. See [Crafted Item Predicate](/docs/custom-backpack/unlock-challenges/predicates.mdx#crafted-item) for documentation and more examples. |
 | `count`        | Integer | No       | 1       | The amount of items to craft in total                                                                                                                                                                                                                                          |
 
 #### Examples
@@ -194,7 +198,7 @@ Backpacked comes with many built-in challenge types
 | Key      | Type    | Required | Default | Description                                                                                                                                                                |
 | -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `block`  | Object  | No       | —       | An optinal blockstate predicate to test the interacting block. See [Minecraft Wiki](https://minecraft.wiki/w/Advancement/Conditions/entity) for more details.              |
-| `item`   | Object  | No       | —       | An optional item predicate to test the held item of the interacting player. See [Minecraft Wiki](https://minecraft.wiki/w/Advancement/Conditions/entity) for more details. |
+| `item`   | Object  | No       | —       | An optional item predicate to test the held item of the interacting player. See [Minecraft Wiki](https://minecraft.wiki/w/Advancement/Conditions/item) for more details. |
 | `player` | Object  | No       | —       | An optional entity predicate for the player. See [Minecraft Wiki](https://minecraft.wiki/w/Advancement/Conditions/entity) for more details.                                |
 | `count`  | Integer | No       | 1       | The amount of times to perform the action                                                                                                                                  |
 

…the-unlock-challenge/challenge-types.mdx …ck/unlock-challenges/challenge-types.mdxdocs/custom-backpack/setting-the-unlock-challenge/challenge-types.mdx renamed to docs/custom-backpack/unlock-challenges/challenge-types.mdx docs/custom-backpack/setting-the-unlock-challenge/challenge-types.mdx renamed to docs/custom-backpack/unlock-challenges/challenge-types.mdx

@@ -0,0 +1,37 @@
+---
+sidebar_position: 2
+---
+
+# Creating the Challenge
+
+## Getting Started
+
+Unlock challenge are defined in the same file used to [register the backpack](/docs/custom-backpack/register-the-backpack.md#registering). If you have not registered a backpack at this point, what the helly are you doing? Go back! Next you'll want to create a new object called `unlock_challenge` under the root object. This is where the unlock challenge will be defined, which includes an implementation of one of the [challenge types](/docs/custom-backpack/unlock-challenges/challenge-types.mdx), and setting the progress formatter.
+
+The JSON should now look something similar to below:
+```json title="data/<namespace>/backpacked/<your_backpack_name>.json"
+{
+    "unlock_challenge": {
+        ...
+    }
+}
+```
+## Setting the Challenge
+
+TODO
+
+## Customise the Progress Formatter
+
+A progress formatter controls how the unlock challenge displays the progression label. This label is shown in a tooltip when the player hovers a locked backpack in the customisation menu. For example, a formatter type that is available for use in addons is `backpacked:percentage`, and this will display a percentage based completion label. If the challenge is to mine ten diamond blocks, and currently only four have been mined, the tooltip will display as `Completed 40%`. 
+
+There are many progress formatters available to use, and it's best to select the one that fits the most appropriately to the challenge. Simply select one of the [available progress formatters](/docs/custom-backpack/unlock-challenges/formatter-types.mdx) and apply it to the unlock challenge as follows:
+
+```json title="data/<namespace>/backpacked/<your_backpack_name>.json"
+{
+    "unlock_challenge": {
+        "formatter": "backpacked:percentage",
+        ...
+    }
+}
+```
+

docs/custom-backpack/unlock-challenges/creating-the-challenge.mdx

@@ -0,0 +1,7 @@
+---
+sidebar_position: 4
+---
+
+# Formatter Types
+
+TODO

docs/custom-backpack/unlock-challenges/formatter-types.mdx

@@ -0,0 +1,15 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+Every backpack has the option to set an unlock challenge. Unlock challenges are simply goals the player can complete in order to unlock new backpacks. They are inspired from Advancements from the vanilla game, except the main difference is that the player unlocks a reward (the backpack). 
+
+Unlock challenges are persistent per save/server, they do not transfer to different saves/servers, just like Advancements. Partial completion of unlock challenges is also saved. This means that if the player has to cut down one-hundred oak logs, and they have only cut fifty, the unlock challenge will remember fifty oak logs have already been cut.
+
+Backpacked comes equipped with the freedom to customise unlock challenge using one of the many available challenge types. All chellenge types have been designed to be highly customisable, allowing you to be creative as you want with your challenges. Kill ten zombies while holding a potato, you can do that! Travel one thousand blocks while driving a boat on land, sure, you can do that too!
+
+## Next Step
+
+

docs/custom-backpack/unlock-challenges/introduction.md

@@ -1,3 +1,7 @@
+---
+sidebar_position: 5
+---
+
 # Predicates
 
 ## List of Predicates