diff --git a/docs/boosters/how-to-make-a-custom-booster.md b/docs/boosters/how-to-make-a-custom-booster.md index 5a8fd5ba57..dfc820691e 100644 --- a/docs/boosters/how-to-make-a-custom-booster.md +++ b/docs/boosters/how-to-make-a-custom-booster.md @@ -78,7 +78,7 @@ gui: **messages:** Broadcast messages to be sent when the Booster is activated or expires. -#### GUI: +#### GUI **item:** The item shown in the `/boosters` GUI, read here for more: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system). @@ -90,7 +90,7 @@ gui: ### Effects & Conditions -The effects section is the core functionality of the Booster. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the enchantment is active. +The effects section is the core functionality of the Booster. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the booster is active. Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly. diff --git a/docs/ecoarmor/how-to-make-a-custom-set.md b/docs/ecoarmor/how-to-make-a-custom-set.md index 7f582729c9..3c8cdd8a8c 100644 --- a/docs/ecoarmor/how-to-make-a-custom-set.md +++ b/docs/ecoarmor/how-to-make-a-custom-set.md @@ -317,7 +317,7 @@ advancedLore: # Lore to be added to the armor piece when it has been advanced. ### Effects / AdvancedEffects -The effects section is the core functionality of the Armor Set. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the enchantment is active. +The effects section is the core functionality of the Armor Set. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the full set is worn. Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly. @@ -433,7 +433,7 @@ helmet: ### Effects / AdvancedEffects -The effects section is the core functionality of the Armor Set. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the enchantment is active. +The effects section is the core functionality of the Armor Set. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the armor piece is worn. Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly. diff --git a/docs/ecoitems/how-to-make-a-custom-item.md b/docs/ecoitems/how-to-make-a-custom-item.md index 5d5364b51f..2104fdee96 100644 --- a/docs/ecoitems/how-to-make-a-custom-item.md +++ b/docs/ecoitems/how-to-make-a-custom-item.md @@ -101,7 +101,7 @@ conditions: ### Effects & Conditions -The effects section is the core functionality of the EcoItem. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the enchantment is active. +The effects section is the core functionality of the EcoItem. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the item is held or used. Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly. diff --git a/docs/ecoquests/how-to-make-a-quest.md b/docs/ecoquests/how-to-make-a-quest.md new file mode 100644 index 0000000000..40ef1b6881 --- /dev/null +++ b/docs/ecoquests/how-to-make-a-quest.md @@ -0,0 +1,117 @@ +--- +title: How to make a Quest +sidebar_position: 2 +--- + +## Default config +The default configs can be found [here](https://github.com/Auxilor/EcoQuests/tree/master/eco-core/core-plugin/src/main/resources/quests). +You can find additional user-created configs on [lrcdb](https://lrcdb.auxilor.io/). + +## How to add quests +Each quest is its own config file, placed in the `/quests/` folder, and you can add or remove them as you please. There's an example config called `_example.yml` to help you out! + +The ID of the Quest is the file name. This is what you use in commands and placeholders. +ID's must be lowercase letters, numbers, and underscores only. + +Quests are made up of specific [[how-to-make-a-task|tasks]], and when all tasks are completed the quest will complete, giving the player rewards! + +## Example Quest Config + +```yaml +name: "Traveller" # The name of the task +description: "&7Stretch your legs! Walk around Lumoria and find new places to explore." + +# How many minutes between this quest being reset (set to -1 to disable) +# 1 Day: 1440 +# 1 Week: 10080 +# 1 Month: 43200 +reset-time: -1 + +# A list of tasks and their XP requirements to complete this quest. +# If the task is one action, set XP to 1. +# XP requirements can use placeholder math, for example %ecoskills_combat% * 100 +tasks: + - task: move + xp: 1000 + +# (For resettable tasks) The amount of tasks to select from the list above. +# Set to -1 to use all tasks. +task-amount: -1 + +# The messages for the %rewards% placeholder in icons, messages, etc. +reward-messages: + - " &8» &r&f+2 %ecoskills_defense_name%" + +# A list of effects to run when the quest is completed. +# Read https://plugins.auxilor.io/effects/configuring-an-effect +rewards: [] + +# If the player should be told when they have started the quest. +announce-start: false + +# A list of effects to run when the quest is started. +# Read https://plugins.auxilor.io/effects/configuring-an-effect +start-effects: [] + +# A list of conditions required to start the quest. +# The quest will be automatically started when these conditions are met. +# Read https://plugins.auxilor.io/conditions/configuring-a-condition +# If gui.always is true, then not-met-lines will show up on the GUI icon! +start-conditions: [] + +# If the quest should auto start when all conditions are met +# If this is set to false, the quest can only be started with /ecoquests start +auto-start: true + +# Options for the /quests GUI +gui: + enabled: true # If the quest should be shown in the GUI + always: false # If the quest should always be in the GUI, even if it's not started + # The item to show in the GUI, read https://plugins.auxilor.io/all-plugins/the-item-lookup-system + item: paper +``` + +## Understanding all the sections + +**name**: The item name in-game. + +**description**: The item lore shown in-game. Set to `description: []` to remove all lore lines. + +**reset-time:** The time (in ticks) between being reset + +**tasks:** The list of tasks and their XP requirements. +```yaml +tasks: + - task: move # The ID of the task (from /ecoquests/tasks/id.yml) + xp: 1000 # The amount of XP required to complete the task +``` + +**task-amount:** The amount of tasks to be completed. These are selected from the list at random. Set to `-1` to use all tasks. + +**reward-messages:** The message for the `%rewards%` placeholder in icons, messages, etc. + +**rewards:** Effects to be run when the quest is completed (Supports triggered effects). See [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) + +**announce-start:** If the player should be told the quest has started (true/false) + +**start-effects:** Effects to be run when the quest is started (Supports triggered effects). See [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) + +**start-conditions:** Conditions that must be met for the quest to start. See [[configuring-a-condition|Configuring a Condition]]. + +**auto-start:** If the quest should start automatically when the conditions are met. + +### GUI + +**enabled:** If the quest should appear in /quests + +**always:** If the quest should always appear in /quests, even when not started + +**item:** The item to show in /quests, read here for more: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system). + +### Effects + +The quest rewards uses the effects system. You can configure effects, conditions, filters, and mutators in this section to run when the quest is started or as rewards. + +Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly. + +For more advanced users or setups, you can configure chains in this section to string together different effects under one trigger. Check out [Configuring an Effect Chain](https://plugins.auxilor.io/effects/configuring-a-chain) for more info. \ No newline at end of file diff --git a/docs/ecoquests/how-to-make-a-task.md b/docs/ecoquests/how-to-make-a-task.md new file mode 100644 index 0000000000..2779af563b --- /dev/null +++ b/docs/ecoquests/how-to-make-a-task.md @@ -0,0 +1,52 @@ +--- +title: How to make a Task +sidebar_position: 3 +--- + +## Default config +The default configs can be found [here](https://github.com/Auxilor/EcoQuests/tree/master/eco-core/core-plugin/src/main/resources/tasks). +You can find additional user-created configs on [lrcdb](https://lrcdb.auxilor.io/). + +## How to add tasks +Each task is its own config file, placed in the `/tasks/` folder, and you can add or remove them as you please. There's an example config called `_example.yml` to help you out! + +The ID of the Task is the file name. This is what you use in quests and placeholders. +ID's must be lowercase letters, numbers, and underscores only. + +Tasks are the goals that players must complete in order to complete [[how-to-make-a-quest|quests]]. + +## Example Task Config + +```yaml +description: "&fBreak stone blocks (&a%xp%&8/&a%required-xp%&f)" # The description of the task. + +# An XP gain method takes a trigger, a multiplier, conditions, and filters. +# The 'multiplier' takes the value produced by the trigger and multiplies it +# Alternatively, you can use 'value' to count a specific number and not a multiplier +xp-gain-methods: + - trigger: mine_block # See list of triggers: https://plugins.auxilor.io/effects/all-triggers + multiplier: 1 # You can also use "value" here (see above comment) + filters: # (Optional) Example of using filters in tasks + blocks: + - stone + +# An optional list of effects to run when a player completes the task +# Read here: https://plugins.auxilor.io/effects/configuring-an-effect +on-complete: + - id: send_message + args: + message: "Task Completed!" +``` + +## Understanding all the sections + +**description:** The description of the quest. Shown in the quest lore in /quests + +**xp-gain-methods:** The trigger, multiplier/value, conditions and filters that will award task xp + +**on-complete:** Effects to be run when the task is completed (Supports triggered effects). See [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) + +### Internal Placeholders + +`%xp%` The amount of XP the player has in this task +`%required-xp` The amount of XP required to complete this task diff --git a/docs/ecoquests/placeholderapi.md b/docs/ecoquests/placeholderapi.md index dc78ce604f..26de77830a 100644 --- a/docs/ecoquests/placeholderapi.md +++ b/docs/ecoquests/placeholderapi.md @@ -28,6 +28,8 @@ sidebar_position: 4 ### Task-Amount Placeholders These placeholders are dependent on the amount of tasks in the quest, they return the info on the active tasks. +Example: `task-amount: 1` You would use `%ecoquests_quest__task_1_required_xp%` to see XP required for the 1st task. + | Placeholder | Description | |---------------------------------------------------------------------------|-----------------------------------------------------------------------| | `%ecoquests_quest__task__required_xp%` | The XP required to complete the [numbered] active task | diff --git a/docs/ecoquests/quests.md b/docs/ecoquests/quests.md deleted file mode 100644 index 5ba6e7f4f8..0000000000 --- a/docs/ecoquests/quests.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Quests" -sidebar_position: 2 ---- - -Quests consist of tasks, and when all tasks are completed the quest completes, giving the player rewards. - -## Default configs - -The default configs can be found here: - -[GitHub](https://github.com/Auxilor/EcoQuests/blob/master/eco-core/core-plugin/src/main/resources/quests/) - -## `_example.yml` - -```yaml -# The ID of the quest is the name of the .yml file, -# for example traveller.yml has the ID of traveller -# You can place quests anywhere in this folder, -# including in subfolders if you want to organize your quest configs -# _example.yml is not loaded. - -name: "Traveller" - -description: "&7Stretch your legs! Walk around Lumoria and find new places to explore." - -# Options for the /quests GUI -gui: - enabled: true # If the quest should be shown in the GUI - always: false # If the quest should always be in the GUI, even if it's not started - # The item to show in the GUI, read https://plugins.auxilor.io/all-plugins/the-item-lookup-system - item: paper - -# How many minutes between this quest being reset (set to -1 to disable) -# 1 Day: 1440 -# 1 Week: 10080 -# 1 Month: 43200 -reset-time: -1 - -# A list of tasks and their XP requirements to complete this quest. -# If the task is one action, set XP to 1. -# XP requirements can use placeholder math, for example %ecoskills_combat% * 100 -tasks: - - task: move - xp: 1000 - -# (For resettable tasks) The amount of tasks to select from the list above. -# Set to -1 to use all tasks. -task-amount: -1 - -# The messages for the %rewards% placeholder in icons, messages, etc. -reward-messages: - - " &8» &r&f+2 %ecoskills_defense_name%" - -# A list of effects to run when the quest is completed. -# Read https://plugins.auxilor.io/effects/configuring-an-effect -rewards: [] - -# If the player should be told when they have started the quest. -announce-start: false - -# A list of effects to run when the quest is started. -# Read https://plugins.auxilor.io/effects/configuring-an-effect -start-effects: [] - -# A list of conditions required to start the quest. -# The quest will be automatically started when these conditions are met. -# Read https://plugins.auxilor.io/conditions/configuring-a-condition -# If gui.always is true, then not-met-lines will show up on the GUI icon! -start-conditions: [] - -# If the quest should auto start when all conditions are met -# If this is set to false, the quest can only be started with /ecoquests start -auto-start: true -``` diff --git a/docs/ecoquests/tasks.md b/docs/ecoquests/tasks.md deleted file mode 100644 index a02eea7f63..0000000000 --- a/docs/ecoquests/tasks.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "Tasks" -sidebar_position: 3 ---- - -Tasks are goals the player must achieve in order to complete quests. - -## Default configs - -The default configs can be found here: - -[GitHub](https://github.com/Auxilor/EcoQuests/blob/master/eco-core/core-plugin/src/main/resources/tasks/) - -## `_example.yml` - -```yaml -# The ID of the task is the name of the .yml file, -# for example break_100_stone.yml has the ID of break_100_stone -# You can place tasks anywhere in this folder, -# including in subfolders if you want to organize your task configs -# _example.yml is not loaded. - -# If multiple quests have the same task, gaining task XP for one quest -# will not gain task XP for other quests with the same task. - -# The description of the task. -# %xp% - The amount of XP the player has in this task -# %required-xp% - The amount of XP required to complete this task -description: "&fBreak stone blocks (&a%xp%&8/&a%required-xp%&f)" - -# An XP gain method takes a trigger, a multiplier, conditions, and filters. -# The multiplier takes the value produced by the trigger and multiplies it -# by some value to calculate the experience that should be given. -xp-gain-methods: - - trigger: mine_block - multiplier: 1 - filters: - blocks: - - stone - -``` diff --git a/docs/talismans/how-to-make-a-custom-talisman.md b/docs/talismans/how-to-make-a-custom-talisman.md index dcb822958a..496f7a41af 100644 --- a/docs/talismans/how-to-make-a-custom-talisman.md +++ b/docs/talismans/how-to-make-a-custom-talisman.md @@ -64,7 +64,7 @@ conditions: [] ### Effects & Conditions -The effects section is the core functionality of the EcoItem. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the enchantment is active. +The effects section is the core functionality of the Talisman. You can configure effects, conditions, filters, mutators and triggers in this section to run whilst the talisman is active. Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly.