Skip to content

Commit

Permalink
Updated EcoQuests and fixed Effects Sections
Browse files Browse the repository at this point in the history
  • Loading branch information
Exanthiax committed Feb 28, 2024
1 parent 90a29bf commit daa9a46
Show file tree
Hide file tree
Showing 9 changed files with 177 additions and 122 deletions.
4 changes: 2 additions & 2 deletions docs/boosters/how-to-make-a-custom-booster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/ecoarmor/how-to-make-a-custom-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/ecoitems/how-to-make-a-custom-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
117 changes: 117 additions & 0 deletions docs/ecoquests/how-to-make-a-quest.md
Original file line number Diff line number Diff line change
@@ -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.
52 changes: 52 additions & 0 deletions docs/ecoquests/how-to-make-a-task.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions docs/ecoquests/placeholderapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_<quest>_task_1_required_xp%` to see XP required for the 1st task.

| Placeholder | Description |
|---------------------------------------------------------------------------|-----------------------------------------------------------------------|
| `%ecoquests_quest_<quest>_task_<task_number[0-9]>_required_xp%` | The XP required to complete the [numbered] active task |
Expand Down
75 changes: 0 additions & 75 deletions docs/ecoquests/quests.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/ecoquests/tasks.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/talismans/how-to-make-a-custom-talisman.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit daa9a46

Please sign in to comment.