Add docs for tasks introduced in #642

6 files changed, 196 insertions, 0 deletions

diff --git a/docs/task-types/bucketentity-(task-type).md b/docs/task-types/bucketentity-(task-type).md
new file mode 100644
index 00000000..02dadbe5
--- /dev/null
+++ b/docs/task-types/bucketentity-(task-type).md
@@ -0,0 +1,36 @@
+---
+title: bucketentity
+parent: Built-in task types
+grand_parent: Task types
+---
+
+# bucketentity (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Capture specific entity in a bucket.
+
+## Options
+
+| Key           | Description                                            | Type                   | Required | Default | Notes                                                                                                                                                                                                                                                                        |
+|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `amount`      | The number of buckets to capture an entity in.         | Integer                | Yes      | \-      | \-                                                                                                                                                                                                                                                                           |
+| `item`        | The specific bucket to capture.                        | Material, or ItemStack | No       | \-      | Accepts standard [item definition](../configuration/defining-items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. |
+| `data`        | The data code for the item.                            | Integer                | No       | 0       | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions.                                                                                                                                                                         |
+| `exact-match` | Whether the item should exactly match what is defined. | Boolean                | No       | true    | \-                                                                                                                                                                                                                                                                           |
+| `worlds`      | Worlds which should count towards the progress.        | List of world names    | No       | \-      | \-                                                                                                                                                                                                                                                                           |
+
+## Examples
+
+Capture 8 axolotls in buckets:
+
+``` yaml
+bucketentity:
+  type: "bucketentity"
+  bucket: AXOLOTL_BUCKET                # (OPTIONAL) bucket to capture the entity
+  exact-match: false                    # (OPTIONAL) ignore the axolotl variation nbt
+  amount: 8                             # amount of times to capture entity
+  worlds:                               # (OPTIONAL) restrict to certain worlds
+   - "world"
+```
diff --git a/docs/task-types/curing-(task-type).md b/docs/task-types/curing-(task-type).md
new file mode 100644
index 00000000..22739471
--- /dev/null
+++ b/docs/task-types/curing-(task-type).md
@@ -0,0 +1,29 @@
+---
+title: curing
+parent: Built-in task types
+grand_parent: Task types
+---
+
+# curing (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Cure a set amount of zombie villagers.
+
+## Options
+
+| Key      | Description                                     | Type                | Required | Default | Notes |
+|----------|-------------------------------------------------|---------------------|----------|---------|-------|
+| `amount` | The number of zombie villagers to cure.         | Integer             | Yes      | \-      | \-    |
+| `worlds` | Worlds which should count towards the progress. | List of world names | No       | \-      | \-    |
+
+## Examples
+
+Cure 8 zombie villagers:
+
+``` yaml
+curing:
+  type: "curing"
+  amount: 8               # amount of times to cure a zombie villager
+```
diff --git a/docs/task-types/itembreaking-(task-type).md b/docs/task-types/itembreaking-(task-type).md
new file mode 100644
index 00000000..d1be9964
--- /dev/null
+++ b/docs/task-types/itembreaking-(task-type).md
@@ -0,0 +1,34 @@
+---
+title: itembreaking
+parent: Built-in task types
+grand_parent: Task types
+---
+
+# itembreaking (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Break a set amount of certain items (by reducing durability to 0).
+
+## Options
+
+| Key           | Description                                            | Type                   | Required | Default | Notes                                                                                                                                                                                                                                                       |
+|---------------|--------------------------------------------------------|------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `amount`      | The number of items to break.                          | Integer                | Yes      | \-      | \-                                                                                                                                                                                                                                                          |
+| `item`        | The specific item to break.                            | Material, or ItemStack | No       | \-      | Accepts standard [item definition](defining_items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. |
+| `data`        | The data code for the item.                            | Integer                | No       | 0       | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions.                                                                                                                                                        |
+| `exact-match` | Whether the item should exactly match what is defined. | Boolean                | No       | true    | \-                                                                                                                                                                                                                                                          |
+| `worlds`      | Worlds which should count towards the progress.        | List of world names    | No       | \-      | \-                                                                                                                                                                                                                                                          |
+
+## Examples
+
+Break 8 diamond pickaxes:
+
+``` yaml
+itembreaking:
+  type: "itembreaking"
+  amount: 8               # amount of items to break
+  item: DIAMOND_PICKAXE   # item to break
+  exact-match: false      # we need to ignore nbt
+```
diff --git a/docs/task-types/itemdamaging-(task-type).md b/docs/task-types/itemdamaging-(task-type).md
new file mode 100644
index 00000000..32c9dea0
--- /dev/null
+++ b/docs/task-types/itemdamaging-(task-type).md
@@ -0,0 +1,34 @@
+---
+title: itemdamaging
+parent: Built-in task types
+grand_parent: Task types
+---
+
+# itemdamaging (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Damage certain items with a set amount of damage (by reducing durability).
+
+## Options
+
+| Key           | Description                                            | Type                   | Required | Default | Notes                                                                                                                                                                                                                                                       |
+|---------------|--------------------------------------------------------|------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `amount`      | The number of damage to damage the item.               | Integer                | Yes      | \-      | \-                                                                                                                                                                                                                                                          |
+| `item`        | The specific item to damage.                           | Material, or ItemStack | No       | \-      | Accepts standard [item definition](defining_items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. |
+| `data`        | The data code for the item.                            | Integer                | No       | 0       | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions.                                                                                                                                                        |
+| `exact-match` | Whether the item should exactly match what is defined. | Boolean                | No       | true    | \-                                                                                                                                                                                                                                                          |
+| `worlds`      | Worlds which should count towards the progress.        | List of world names    | No       | \-      | \-                                                                                                                                                                                                                                                          |
+
+## Examples
+
+Damage diamond pickaxes with 12000 points of damage:
+
+``` yaml
+itemdamaging:
+  type: "itemdamaging"
+  amount: 12000           # amount of damage to damage the item
+  item: DIAMOND_PICKAXE   # item to damage
+  exact-match: false      # we need to ignore nbt
+```
diff --git a/docs/task-types/itemmending-(task-type).md b/docs/task-types/itemmending-(task-type).md
new file mode 100644
index 00000000..7d1355ec
--- /dev/null
+++ b/docs/task-types/itemmending-(task-type).md
@@ -0,0 +1,34 @@
+---
+title: itemmending
+parent: Built-in task types
+grand_parent: Task types
+---
+
+# itemmending (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Mend certain items with a set amount of repair (by increasing durability with mending enchantment).
+
+## Options
+
+| Key           | Description                                            | Type                   | Required | Default | Notes                                                                                                                                                                                                                                                       |
+|---------------|--------------------------------------------------------|------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `amount`      | The number of repair to mend the item.                 | Integer                | Yes      | \-      | \-                                                                                                                                                                                                                                                          |
+| `item`        | The specific item to mend.                             | Material, or ItemStack | No       | \-      | Accepts standard [item definition](defining_items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. |
+| `data`        | The data code for the item.                            | Integer                | No       | 0       | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions.                                                                                                                                                        |
+| `exact-match` | Whether the item should exactly match what is defined. | Boolean                | No       | true    | \-                                                                                                                                                                                                                                                          |
+| `worlds`      | Worlds which should count towards the progress.        | List of world names    | No       | \-      | \-                                                                                                                                                                                                                                                          |
+
+## Examples
+
+Mend diamond pickaxes with 12000 points of repair:
+
+``` yaml
+itemmending:
+  type: "itemmending"
+  amount: 12000           # amount of repair to mend the item
+  item: DIAMOND_PICKAXE   # item to mend
+  exact-match: false      # we need to ignore nbt
+```
diff --git a/docs/task-types/resurrecting-(task-type).md b/docs/task-types/resurrecting-(task-type).md
new file mode 100644
index 00000000..d2e70a3a
--- /dev/null
+++ b/docs/task-types/resurrecting-(task-type).md
@@ -0,0 +1,29 @@
+---
+title: resurrecting
+parent: Built-in task types
+grand_parent: Task types
+---
+
+# resurrecting (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Resurrect a set amount of times (by totem of undying usage).
+
+## Options
+
+| Key      | Description                                     | Type                | Required | Default | Notes |
+|----------|-------------------------------------------------|---------------------|----------|---------|-------|
+| `amount` | The number of times to resurrect.               | Integer             | Yes      | \-      | \-    |
+| `worlds` | Worlds which should count towards the progress. | List of world names | No       | \-      | \-    |
+
+## Examples
+
+Resurrect 5 times:
+
+``` yaml
+resurrecting:
+  type: "resurrecting"
+  amount: 5               # amount of times to resurrect
+```