diff --git a/docs/all-plugins/the-item-lookup-system.md b/docs/all-plugins/the-item-lookup-system.md index 0d5ae71f36..60c128f7c2 100644 --- a/docs/all-plugins/the-item-lookup-system.md +++ b/docs/all-plugins/the-item-lookup-system.md @@ -65,16 +65,17 @@ So, lets say you have an EcoMobs mob, and you want it to drop a rare custom weap ## Using items from my other plugins You can use items from my other plugins anywhere using The Item Lookup system. -| Plugin | Item Lookup Key | -|------------------|---------------------------------------------------------------------------------------------------------------------| -| EcoItems | `ecoitems:` | -| Talismans | `talismans:` | -| EcoMobs | `ecomobs:_spawn_egg` | -| EcoPets | `ecopets:_spawn_egg` | -| StatTrackers | `stattrackers:` | +| Plugin | Item Lookup Key | +| ------------ | ------------------------------------------------------------------------------------------------------------------- | +| EcoArmor | `ecoarmor:set__` (Optional: `_advanced`)
`ecoarmor:shard_`
`ecoarmor:upgrade_crystal_` | | EcoCrates | `ecocrates:_key` | +| EcoItems | `ecoitems:` | +| EcoMobs | `ecomobs:_spawn_egg` | +| EcoPets | `ecopets:_spawn_egg` | +| EcoScrolls | `ecoscrolls:scroll_` | | Reforges | `reforges:stone_` | -| EcoArmor | `ecoarmor:set__` (Optional: `_advanced`)
`ecoarmor:shard_`
`ecoarmor:upgrade_crystal_` | +| StatTrackers | `stattrackers:` | +| Talismans | `talismans:` | ## Using items in MythicMobs If you want to use a lookup item in MythicMobs, just do it like this: `eco{type=}`, e.g. `eco{type=ecoitems:}` diff --git a/docs/ecoitems/commands-and-permissions.md b/docs/ecoitems/commands-and-permissions.md index 2fee672157..d280326780 100644 --- a/docs/ecoitems/commands-and-permissions.md +++ b/docs/ecoitems/commands-and-permissions.md @@ -6,7 +6,7 @@ sidebar_position: 3 ## `/ecoitems give` (Give players items) Permission: `ecoitems.commands.give` -General Usage: `/ecoitemsgive [amount]` +General Usage: `/ecoitems give [amount]` For example, if you wanted to give a player a reaper scythe, you would do: `/ecoitems give reaper_scythe` diff --git a/docs/ecoscrolls/how-to-make-a-scroll.md b/docs/ecoscrolls/how-to-make-a-scroll.md index c0c4762e80..c540a42bdb 100644 --- a/docs/ecoscrolls/how-to-make-a-scroll.md +++ b/docs/ecoscrolls/how-to-make-a-scroll.md @@ -22,77 +22,24 @@ ID's must be lowercase letters, numbers, and underscores only. # including in subfolders if you want to organize your scroll configs # _example.yml is not loaded. -# The name of the scroll -name: "&6Example Scroll" - -# The max level of the scroll -max-level: 1 - -# 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." - - # Options for crafting, read here: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes - craftable: false - recipe: [ ] - -# Options for inscribing items with the scroll -inscription: - # The conditions required to inscribe the item - # not-met-effects will run if someone tries to inscribe the item without meeting the conditions - 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 item - price: - value: 100 - type: coins - display: "&e%value% coins" - - # 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" - - # 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 +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" -# The items that the scroll can be applied to, see targets.yml -targets: +targets: # The items that the scroll can be applied to, see targets.yml - sword - -# The conflicts that the scroll has with other scrolls -conflicts: [ ] +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 + - scroll: my_requirement_scroll # The ID of scroll to require level: 2 # The level required (optional) +remove-requirements: false # If inscribing this scroll should remove the required scrolls -# 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" +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_:%, e.g. @@ -113,6 +60,41 @@ effects: # The conditions for the scroll to work conditions: [ ] +# 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." + craftable: false + recipe: [ ] + +# Options for inscribing items with the scroll +inscription: + inscription-table: true # If the scroll can be applied to items via the inscription table + drag-and-drop: true # If the scroll can be applied to items via drag-and-drop + + # Read https://plugins.auxilor.io/all-plugins/prices + # The price to inscribe the item + price: + value: 100 + type: coins + display: "&e%value% coins" + + # 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" + + # The conditions required to inscribe the item + # not-met-effects will run if someone tries to inscribe the item without meeting the conditions + 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: [ ] ``` ## Understanding all the sections @@ -140,10 +122,6 @@ requirements: **placeholders:** Dynamic custom placeholders to show in the lore of other items (`%ecoscrolls_scroll__%`). -**effects:** Effects for the scroll to give. See [Effects & Conditions](https://plugins.auxilor.io/ecoscrolls/how-to-make-a-custom-scrollt#effects--conditions) - -**conditions:** Conditions for the scroll to work. See [Effects & Conditions](https://plugins.auxilor.io/ecoscrolls/how-to-make-a-custom-scrollt#effects--conditions) - ### Effects & Conditions The effects section is the core functionality of the EcoScroll. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the inscribed item is held or used. diff --git a/docs/effects/all-triggers.md b/docs/effects/all-triggers.md index ff3063569f..8b689acd59 100644 --- a/docs/effects/all-triggers.md +++ b/docs/effects/all-triggers.md @@ -66,6 +66,7 @@ and are used in plugins like EcoSkills, EcoPets, EcoJobs (etc) for levelling. | `heal` | Triggered when regaining health | The health regained | | `hold_item` | Triggered when changing your held item | 1 | | `hook_in_ground` | Triggered when a fishing rod hook hits the ground | 1 | +| `inscribe` | Triggered when inscribing a scroll **Requires EcoScrolls** | 1 | | `item_break` | Triggered when breaking any item in your inventory (durability) | 1 | | `jobs_level_up` | Triggered when levelling up a job **Requires Jobs Reborn** | The new level | | `join` | Triggered when joining the server | 1 | @@ -120,7 +121,6 @@ and are used in plugins like EcoSkills, EcoPets, EcoJobs (etc) for levelling. | `toggle_sneak` | Triggered when changing the sneak state | 1 | | `toggle_sprint` | Triggered when changing the sprint state | 1 | | `trident_attack` | Triggered on injuring an entity with a thrown trident **Requires Paper** | The damage dealt | +| `try_inscribe` | Triggered when attempting to inscribe a scroll **Requires EcoScrolls** | 1 | | `villager_trade` | Triggered when trading with a villager **Requires Paper** | The experience the villager gains | | `win_raid` | Triggered when a player wins a raid | The level of bad omen | -| `inscribe` | Triggered when inscribing a scroll **Requires EcoScrolls** | 1 | -| `try_inscribe` | Triggered when attempting to inscribe a scroll **Requires EcoScrolls** | 1 |