Update docs

codetaylor · Dec 6, 2018 · fba650c · fba650c
1 parent ef9e82a
commit fba650c
Show file tree

Hide file tree

Showing 8 changed files with 100 additions and 19 deletions.
diff --git a/docs/examples/_template.md b/docs/examples/_template.md
@@ -1,6 +1,6 @@
 
 !!! note
-    If you find any issues with the examples, please [report them here](https://github.com/codetaylor/dropt/issues).
+    To report an issue, or to request a new example, please use the [issue tracker](https://github.com/codetaylor/dropt/issues).
 
 ---
 

diff --git a/docs/examples/advanced_fortune.md b/docs/examples/advanced_fortune.md
@@ -1,6 +1,6 @@
 
 !!! note
-    If you find any issues with the examples, please [report them here](https://github.com/codetaylor/dropt/issues).
+    To report an issue, or to request a new example, please use the [issue tracker](https://github.com/codetaylor/dropt/issues).
 
 ---
 
@@ -59,7 +59,7 @@ Dropt.list("list_name")
 
 ### JSON
 
-```js
+```json
 {
   "rules": [
     {

diff --git a/docs/examples/basic_replacement.md b/docs/examples/basic_replacement.md
@@ -1,6 +1,6 @@
 
 !!! note
-    If you find any issues with the examples, please [report them here](https://github.com/codetaylor/dropt/issues).
+    To report an issue, or to request a new example, please use the [issue tracker](https://github.com/codetaylor/dropt/issues).
 
 ---
 
@@ -16,9 +16,7 @@ import mods.dropt.Dropt;
 Dropt.list("list_name")
 
   .add(Dropt.rule()
-      // whitelist match against these blocks
       .matchBlocks(["minecraft:stone"])
-      // drop these items
       .addDrop(Dropt.drop()
           .items([<minecraft:string>])
       )
@@ -27,19 +25,17 @@ Dropt.list("list_name")
 
 ### JSON
 
-```js
+```json
 {
   "rules": [
     {
       "match": {
-        // whitelist match against these blocks
         "blocks": {
           "blocks": [
             "minecraft:stone:0"
           ]
         }
       },
-      // drop these items
       "drops": [
         {
           "item": {
@@ -63,11 +59,9 @@ public void on(DroptLoadRulesEvent event) {
   List<IDroptRuleBuilder> list = new ArrayList<>();
 
   list.add(DroptAPI.rule()
-      // whitelist match against these blocks
       .matchBlocks(new String[]{
           "minecraft:stone"
       })
-      // drop these items
       .addDrops(new IDroptDropBuilder[]{
           DroptAPI.drop().items(new String[]{
               DroptAPI.itemString(Items.STRING)

diff --git a/docs/examples/grass_drops.md b/docs/examples/grass_drops.md
@@ -1,6 +1,6 @@
 
 !!! note
-    If you find any issues with the examples, please [report them here](https://github.com/codetaylor/dropt/issues).
+    To report an issue, or to request a new example, please use the [issue tracker](https://github.com/codetaylor/dropt/issues).
 
 ---
 
@@ -34,7 +34,7 @@ Dropt.list("list_name")
 
 ### JSON
 
-```js
+```json
 {
   "rules": [
     {

diff --git a/docs/examples/leaf_drops.md b/docs/examples/leaf_drops.md
@@ -0,0 +1,86 @@
+
+!!! note
+    To report an issue, or to request a new example, please use the [issue tracker](https://github.com/codetaylor/dropt/issues).
+
+---
+
+Goal: Add `<minecraft:stick>` to leaf drops.
+
+---
+
+Leaf blocks have a different block state depending on whether or not they should check for decay. This makes it hard to know what metadata needs to be supplied to the matcher.
+
+Fortunately, Dropt has a command to assist: `/dropt verbose`.
+
+The command can be toggled on and off, and while on, will log the info of all broken blocks. So run the command, break some blocks, and inspect the results to extract the info you need.
+
+---
+
+### ZenScript
+
+```js
+import mods.dropt.Dropt;
+
+Dropt.list("list_name")
+
+  .add(Dropt.rule()
+      .matchBlocks(["minecraft:leaves:*"])
+      .addDrop(Dropt.drop()
+          .items([<minecraft:stick>])
+      )
+  );
+```
+
+### JSON
+
+```json
+{
+  "rules": [
+    {
+      "match": {
+        "blocks": {
+          "blocks": [
+            "minecraft:leaves:*"
+          ]
+        }
+      },
+      "replaceStrategy": "ADD",
+      "drops": [
+        {
+          "item": {
+            "items": [
+              "minecraft:stick"
+            ]
+          }
+        }
+      ]
+    }
+  ]
+}
+```
+
+### DroptAPI
+
+```java
+@SubscribeEvent
+public void on(DroptLoadRulesEvent event) {
+
+  List<IDroptRuleBuilder> list = new ArrayList<>();
+
+  list.add(DroptAPI.rule()
+      .matchBlocks(new String[]{
+          "minecraft:leaves:*"
+      })
+      .replaceStrategy(EnumReplaceStrategy.ADD)
+      .addDrops(new IDroptDropBuilder[]{
+          DroptAPI.drop().items(new String[]{
+              DroptAPI.itemString(Items.STICK)
+          })
+      })
+  );
+
+  ResourceLocation resourceLocation = new ResourceLocation("my_mod_id", "rule_list_name");
+  int priority = 0;
+  DroptAPI.registerRuleList(resourceLocation, priority, list);
+}
+```
diff --git a/docs/examples/basic_removal.md → docs/examples/selective_removal.md b/docs/examples/basic_removal.md → docs/examples/selective_removal.md
@@ -1,6 +1,6 @@
 
 !!! note
-    If you find any issues with the examples, please [report them here](https://github.com/codetaylor/dropt/issues).
+    To report an issue, or to request a new example, please use the [issue tracker](https://github.com/codetaylor/dropt/issues).
 
 ---
 
@@ -29,7 +29,7 @@ Dropt.list("list_name")
 
 ### JSON
 
-```js
+```json
 {
   "rules": [
     {
@@ -46,7 +46,7 @@ Dropt.list("list_name")
           ]
         }
       },
-      "replaceStrategy": "REPLACE_ITEMS"
+      "replaceStrategy": "REPLACE_ITEMS",
       "drops": [{}]
     }
   ]

diff --git a/docs/examples/tool_restriction.md b/docs/examples/tool_restriction.md
@@ -1,6 +1,6 @@
 
 !!! note
-    If you find any issues with the examples, please [report them here](https://github.com/codetaylor/dropt/issues).
+    To report an issue, or to request a new example, please use the [issue tracker](https://github.com/codetaylor/dropt/issues).
 
 ---
 
@@ -39,7 +39,7 @@ Dropt.list("list_name")
 
 ### JSON
 
-```js
+```json
 {
   "rules": [
     {

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,8 +10,9 @@ pages:
   - Debugging: debugging.md
 - Examples:
   - Basic Replacement: examples/basic_replacement.md
-  - Basic Removal: examples/basic_removal.md
+  - Selective Removal: examples/selective_removal.md
   - Grass Drops: examples/grass_drops.md
+  - Leaf Drops: examples/leaf_drops.md
   - Tool Restriction: examples/tool_restriction.md
   - Advanced Fortune: examples/advanced_fortune.md
 - ZenScript: