summaryrefslogtreecommitdiffstats
path: root/docs/configuration
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration')
-rw-r--r--docs/configuration/basic-options.md66
-rw-r--r--docs/configuration/creating-a-quest.md45
-rw-r--r--docs/configuration/defining-items.md13
-rw-r--r--docs/configuration/gui-configuration.md8
4 files changed, 132 insertions, 0 deletions
diff --git a/docs/configuration/basic-options.md b/docs/configuration/basic-options.md
index 6b461d4f..713674e6 100644
--- a/docs/configuration/basic-options.md
+++ b/docs/configuration/basic-options.md
@@ -74,6 +74,57 @@ options:
titles-enabled: true
```
+## Bossbar
+
+*`options.bossbar`*
+
+This configures a temporary bossbar which will appear when a player
+makes progress on a task, or completes a task. The bar itself
+represents the percentage done for a task.
+
+The text displayed will be the [progress placeholder](/configuration/creating-a-quest#progress-placeholders)
+for the task. In the future, there will also be a method to
+automatically generate this text.
+
+```yaml
+options:
+ # ...
+ bossbar:
+ # Enable bossbar for task progress
+ progress: false
+ # Enable bossbar for task completions
+ complete: false
+ # Time in seconds to display bossbar
+ time: 5
+ # See https://hub.spigotmc.org/javadocs/spigot/org/bukkit/boss/BarColor.html
+ color:
+ '0.0': BLUE # for 0.0 and higher progress values (progress is always between 0.0 and 1.0)
+ # See https://hub.spigotmc.org/javadocs/spigot/org/bukkit/boss/BarStyle.html
+ style:
+ '0.0': SOLID # for 0.0 and higher progress values (progress is always between 0.0 and 1.0)
+```
+
+## Actionbar
+
+*`options.actionbar`*
+
+This configures a temporary action bar which will appear when a player
+makes progress on a task, or completes a task.
+
+The text displayed will be the [progress placeholder](/configuration/creating-a-quest#progress-placeholders)
+for the task. In the future, there will also be a method to
+automatically generate this text.
+
+```yaml
+options:
+ # ...
+ actionbar:
+ # Enable actionbar for task progress
+ progress: false
+ # Enable actionbar for task completions
+ complete: false
+```
+
## Quest started limit
*`options.quest-started-limit`*
@@ -228,6 +279,18 @@ list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html)
list](https://helpch.at/docs/1.8.8/index.html?org/bukkit/Sound.html)
(1.8).
+An alternative syntax is available for
+[namespaced sound names](https://www.digminecraft.com/lists/sound_list_pc.php):
+
+``` yaml
+options:
+ # ...
+ sounds:
+ quest-start: "(minecraft:entity.player.levelup):2:3"
+ # ...
+```
+
+
To not have a sound play, you can leave the string blank (i.e. `""`),
for example:
@@ -247,6 +310,9 @@ player, not the actual volume played back on the client.
**Example (1.9+):** `ENTITY_PLAYER_LEVELUP:2:3` -\> sound
`ENTITY_PLAYER_LEVELUP` at pitch `2` with a volume of `3`.
+**Example (namespaced sound):** `(minecraft:entity.player.levelup):2:3` -\> sound
+`minecraft:entity.player.levelup` at pitch `2` with a volume of `3`.
+
## GUI hide locked
diff --git a/docs/configuration/creating-a-quest.md b/docs/configuration/creating-a-quest.md
index 4e7353a6..6b47e3e6 100644
--- a/docs/configuration/creating-a-quest.md
+++ b/docs/configuration/creating-a-quest.md
@@ -141,6 +141,20 @@ startcommands:
- "broadcast {player} has started a quest"
```
+## Cancel commands
+
+
+*`cancelcommands`*
+
+**Optional.** This is a list of commands which will be executed when the
+player cancels the quest. You can use `{player}` and the player's name
+will be substituted in place.
+
+``` yaml
+cancelcommands:
+ - "broadcast {player} has cancelled a quest"
+```
+
## Start string
@@ -190,6 +204,37 @@ These placeholders will be called using PlaceholderAPI. See [quest
progress in scoreboard](../guides/quest-progress-in-scoreboard) for a
guide which utilises this feature.
+## Progress placeholders
+
+*`progress-placeholders`*
+
+**Optional.** This is a list of placeholders which represent the progress
+of each task. These are used by the [bossbar](/configuration/basic-options#bossbar)
+and [actionbar](/configuration/basic-options#actionbar) configuration options.
+
+You can define a placeholder for each task, or for all of them as a catch-all.
+
+```yaml
+progress-placeholders:
+ <task-name>: "Progress for <task-name>"
+ '*': "Progress for tasks not defined above"
+```
+
+For example, in an actual quest:
+
+```yaml
+tasks:
+ mining:
+ type: "blockbreak"
+ amount: 100
+ building:
+ type: "blockplace"
+ amount: 100
+# ...
+progress-placeholders:
+ mining: "&f{mining:progress}/100 &7blocks broken"
+ building: "&f{building:progress}/100 &7blocks placed"
+```
## Options
diff --git a/docs/configuration/defining-items.md b/docs/configuration/defining-items.md
index a32bb689..86218378 100644
--- a/docs/configuration/defining-items.md
+++ b/docs/configuration/defining-items.md
@@ -305,6 +305,19 @@ item:
id: "executableitems_id" #executableitems id
```
+#### ItemsAdder
+
+**ItemsAdder quest items** are ItemStacks which belong to the
+ItemsAdder plugin.
+
+ items/testitem.yml
+
+``` yaml
+type: "itemsadder"
+item:
+ id: "itemsadder" #itemsdadder id
+```
+
### Referencing a quest item
In most cases where an ItemStack is accepted in Quests, you can simply
diff --git a/docs/configuration/gui-configuration.md b/docs/configuration/gui-configuration.md
index 5b5b5ed0..da3efc13 100644
--- a/docs/configuration/gui-configuration.md
+++ b/docs/configuration/gui-configuration.md
@@ -25,6 +25,8 @@ The back button displayed within sub menus.
gui:
# ...
back-button:
+ enabled: true
+ slot: 45
name: "&cReturn"
lore:
- "&7Return to the categories menu."
@@ -42,6 +44,8 @@ The previous page button displayed on paiginated menus.
gui:
# ...
page-prev:
+ enabled: true
+ slot: 48
name: "&7Previous Page"
lore:
- "&7Switch the page to page &c{prevpage}."
@@ -62,6 +66,8 @@ The next page button displayed on paiginated menus.
gui:
# ...
page-next:
+ enabled: true
+ slot: 50
name: "&7Next Page"
lore:
- "&7Switch the page to page &c{nextpage}."
@@ -82,6 +88,8 @@ item will automatically update on the page number.
gui:
# ...
page-desc:
+ enabled: true
+ slot: 49
name: "&7Page &c{page}"
lore:
- "&7You are currently viewing page &c{page}."