diff options
| author | Krakenied <krakenied1@gmail.com> | 2025-05-13 18:10:45 +0200 |
|---|---|---|
| committer | Krakenied <46192742+Krakenied@users.noreply.github.com> | 2025-05-13 20:34:15 +0200 |
| commit | e0b437c79cf3234634953cde05a67e45b1a74bef (patch) | |
| tree | 73d97a158b2bb2af9633217a84f65c072d933bba /docs | |
| parent | be76eef66f4b36bae486e53426b5b006e169a30c (diff) | |
Update plugin docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/basic-options.md | 7 | ||||
| -rw-r--r-- | docs/configuration/creating-a-quest.md | 27 | ||||
| -rw-r--r-- | docs/configuration/storage-providers.md | 11 | ||||
| -rw-r--r-- | docs/task-types/dealdamage-(task-type).md | 11 |
4 files changed, 45 insertions, 11 deletions
diff --git a/docs/configuration/basic-options.md b/docs/configuration/basic-options.md index a043fbde..88d29f32 100644 --- a/docs/configuration/basic-options.md +++ b/docs/configuration/basic-options.md @@ -688,10 +688,13 @@ options: password: "" address: "localhost:3306" connection-pool-settings: - maximum-pool-size: 8 minimum-idle: 8 - maximum-lifetime: 1800000 + maximum-pool-size: 8 connection-timeout: 5000 + idle-timeout: 600000 + keepalive-time: 0 + maximum-lifetime: 1800000 + data-source-properties: {} table-prefix: "quests_" ``` diff --git a/docs/configuration/creating-a-quest.md b/docs/configuration/creating-a-quest.md index be938a95..d2a91397 100644 --- a/docs/configuration/creating-a-quest.md +++ b/docs/configuration/creating-a-quest.md @@ -367,6 +367,33 @@ options: counts-towards-limit: false ``` +### Counts towards completed + + +*`options.counts-towards-completed`* + +**Optional.** Whether or not this quest counts towards the players quests +completed. The option is currently used only for the plugin placeholders. + +``` yaml +options: + # ... + counts-towards-completed: false +``` + +### Hidden + + +*`options.hidden`* + +**Optional.** Whether or not this quest should be hidden from the plugin menus. + +``` yaml +options: + # ... + hidden: true +``` + ### Repeatable diff --git a/docs/configuration/storage-providers.md b/docs/configuration/storage-providers.md index 8aad7a55..78522913 100644 --- a/docs/configuration/storage-providers.md +++ b/docs/configuration/storage-providers.md @@ -100,10 +100,13 @@ README](https://github.com/brettwooldridge/HikariCP). ``` yaml connection-pool-settings: - maximum-pool-size: 8 - minimum-idle: 8 - maximum-lifetime: 1800000 - connection-timeout: 5000 + minimum-idle: 8 + maximum-pool-size: 8 + connection-timeout: 5000 + idle-timeout: 600000 + keepalive-time: 0 + maximum-lifetime: 1800000 + data-source-properties: {} table-prefix: "quests_" ``` diff --git a/docs/task-types/dealdamage-(task-type).md b/docs/task-types/dealdamage-(task-type).md index 59288c7c..30d19b47 100644 --- a/docs/task-types/dealdamage-(task-type).md +++ b/docs/task-types/dealdamage-(task-type).md @@ -13,11 +13,12 @@ Deal a certain amount of damage. ## Options -| Key | Description | Type | Required | Default | Notes | -|------------------------|-------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------------------------------------------------| -| `amount` | The amount of damage needed. | Integer | Yes | \- | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. | -| `allow-only-creatures` | Whether the entity must be a creature. | Boolean | No | True | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|------------------------|-------------------------------------------------|--------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The amount of damage needed. | Integer | Yes | \- | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. | +| `allow-only-creatures` | Whether the entity must be a creature. | Boolean | No | True | \- | +| `mob` / `mobs` | The specific mob(s) to kill. | Entity type, or list of entity types | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples |