From 60ea3db93c416e3e05525fffa8591010d6696fbe Mon Sep 17 00:00:00 2001
From: Auxilor <william.favierparsons1@gmail.com>
Date: Wed, 17 Jul 2024 18:21:11 +0100
Subject: [PATCH] updated example scroll

---
 docs/ecoscrolls/how-to-make-a-scroll.md | 106 +++++++++++++++---------
 1 file changed, 66 insertions(+), 40 deletions(-)

diff --git a/docs/ecoscrolls/how-to-make-a-scroll.md b/docs/ecoscrolls/how-to-make-a-scroll.md
index 68776dea5b..c0c4762e80 100644
--- a/docs/ecoscrolls/how-to-make-a-scroll.md
+++ b/docs/ecoscrolls/how-to-make-a-scroll.md
@@ -16,53 +16,32 @@ ID's must be lowercase letters, numbers, and underscores only.
 ## Example Scroll Config
 
 ```yaml
-name: "&6Example Scroll" # The name of the scroll
-lore: # The lore added to items when inscribed with the scroll
-  - ""
-  - "&7This item has been inscribed with"
-  - "&6Example Scroll"
-
-targets: # The items that the scroll can be applied to, see targets.yml
-  - sword
-conflicts: [ ] # The conflicts that the scroll has with other scrolls
-
-# The scroll(s) that must be applied to the item before this scroll can be applied
-requirements:
-  - scroll: my_requirement_scroll # The scroll to require
-    level: 2 # The level required (optional)
-# If inscribing this scroll should remove the required scrolls
-remove-requirements: false
+# The ID of the scroll is the name of the .yml file,
+# for example coins_on_kill.yml has the ID of coins_on_kill
+# You can place scrolls anywhere in this folder,
+# including in subfolders if you want to organize your scroll configs
+# _example.yml is not loaded.
 
-max-level: 1 # The max level of the scroll
-max-uses: 1 # The amount of times the scroll can be used
-
-# Item placeholders for dynamic lore in plugins like EcoItems
-# The placeholder is %ecoscrolls_scroll_<scroll>_<placeholder>%, e.g.
-# %ecoscrolls_scoll_example_bonus%
-placeholders:
-  bonus: "%level% * 2"
+# The name of the scroll
+name: "&6Example Scroll"
 
-# Read https://plugins.auxilor.io/effects/configuring-an-effect
-# The effects for the scroll to give
-effects:
-  - id: send_message
-    args:
-      message: "&6You have used the Example Scroll!"
-    triggers:
-      - alt_click
+# The max level of the scroll
+max-level: 1
 
-# Read https://plugins.auxilor.io/effects/configuring-a-condition
-# The conditions for the scroll to work
-conditions: [ ]
+# The amount of times the scroll can be used
+max-uses: 1
 
 # Options for the physical scroll item
 item:
   item: paper glint
+
   # Name and lore can use %uses%, %max_uses%, and %uses_left% placeholders
   name: "&6&lExample Scroll"
   lore:
-    - "&7This is an example scroll."
-    - "&7It does nothing."
+      - "&7This is an example scroll."
+      - "&7It does nothing."
+
+  # Options for crafting, read here: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes
   craftable: false
   recipe: [ ]
 
@@ -73,10 +52,12 @@ inscription:
   conditions: [ ]
 
   # The effects that will be run when the item is inscribed
+  # If your scroll works by modifying the item (e.g. adding enchantments, changing durability),
+  # then put those effects here.
   effects: [ ]
 
   # Read https://plugins.auxilor.io/all-plugins/prices
-  # The price to inscribe the ite
+  # The price to inscribe the item
   price:
     value: 100
     type: coins
@@ -85,8 +66,53 @@ inscription:
   # The formula to multiply the price depending on the level.
   # The %level% placeholder is the *current* level of the scroll
   price-level-multiplier: "1 + %level% * 0.5"
-  drag-and-drop: true # If the scroll can be applied to items via drag-and-drop
-  inscription-table: true # If the scroll can be applied to items via the inscription table
+
+  # If the scroll can be applied to items via drag-and-drop
+  drag-and-drop: true
+
+  # If the scroll can be applied to items via the inscription table
+  inscription-table: true
+
+# The items that the scroll can be applied to, see targets.yml
+targets:
+  - sword
+
+# The conflicts that the scroll has with other scrolls
+conflicts: [ ]
+
+# The scroll(s) that must be applied to the item before this scroll can be applied
+requirements:
+  - scroll: my_requirement_scroll # The scroll to require
+    level: 2 # The level required (optional)
+
+# If inscribing this scroll should remove the required scrolls
+remove-requirements: false
+
+# The lore added to items when inscribed with the scroll
+lore:
+  - ""
+  - "&7This item has been inscribed with"
+  - "&6Example Scroll"
+
+# Item placeholders for dynamic lore in plugins like EcoItems
+# The placeholder is %ecoscrolls_scroll_<scroll>:<placeholder>%, e.g.
+# %ecoscrolls_scroll_example:bonus%
+placeholders:
+  bonus: "%level% * 2"
+
+# Read https://plugins.auxilor.io/effects/configuring-an-effect
+# The effects for the scroll to give
+effects:
+  - id: send_message
+    args:
+      message: "&6You have used the Example Scroll!"
+    triggers:
+      - alt_click
+
+# Read https://plugins.auxilor.io/effects/configuring-a-condition
+# The conditions for the scroll to work
+conditions: [ ]
+
 ```
 
 ## Understanding all the sections