From 7e022d0b53db0e99b8d6cdcbc34eb245057370b1 Mon Sep 17 00:00:00 2001 From: Exanthiax <107284021+Exanthiax@users.noreply.github.com> Date: Wed, 28 Feb 2024 20:51:42 +0000 Subject: [PATCH] Updated StatTrackers & Recipes Updated how to configure a stat tracker Updated recipes in examples on updated pages --- docs/all-plugins/the-item-lookup-system.md | 2 + docs/ecoarmor/how-to-make-a-custom-set.md | 16 ++++ docs/ecoitems/how-to-make-a-custom-item.md | 2 + docs/stattrackers/how-to-make-a-tracker.md | 82 ++++++++++--------- .../how-to-make-a-custom-talisman.md | 8 +- 5 files changed, 69 insertions(+), 41 deletions(-) diff --git a/docs/all-plugins/the-item-lookup-system.md b/docs/all-plugins/the-item-lookup-system.md index 267392a323..f9763e0e04 100644 --- a/docs/all-plugins/the-item-lookup-system.md +++ b/docs/all-plugins/the-item-lookup-system.md @@ -13,9 +13,11 @@ recipe: - "" - "ecoitems:toughened_string 8 ? string 64" - "" + - "" - "netherite_chestplate || diamond_chestplate" - "" + - "ecoitems:arachnid_oculus ? nether_star 2" - "" - "ecoitems:arachnid_oculus ? nether_star 2" diff --git a/docs/ecoarmor/how-to-make-a-custom-set.md b/docs/ecoarmor/how-to-make-a-custom-set.md index cc85a85bd7..7f582729c9 100644 --- a/docs/ecoarmor/how-to-make-a-custom-set.md +++ b/docs/ecoarmor/how-to-make-a-custom-set.md @@ -78,9 +78,11 @@ shard: - prismarine_shard - ecoarmor:set_reaper_helmet - prismarine_shard + - ecoarmor:set_reaper_chestplate - nether_star - ecoarmor:set_reaper_leggings + - prismarine_shard - ecoarmor:set_reaper_boots - prismarine_shard @@ -102,9 +104,11 @@ helmet: - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air + - nether_star - netherite_helmet - nether_star + - air - nether_star - air @@ -142,9 +146,11 @@ chestplate: - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air + - nether_star - netherite_chestplate - nether_star + - air - nether_star - air @@ -171,9 +177,11 @@ elytra: - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air + - nether_star - elytra - nether_star + - air - nether_star - air @@ -200,9 +208,11 @@ leggings: - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air + - nether_star - netherite_leggings - nether_star + - air - nether_star - air @@ -229,9 +239,11 @@ boots: - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air + - nether_star - netherite_boots - nether_star + - air - nether_star - air @@ -327,9 +339,11 @@ shard: - prismarine_shard - ecoarmor:set_reaper_helmet - prismarine_shard + - ecoarmor:set_reaper_chestplate - nether_star - ecoarmor:set_reaper_leggings + - prismarine_shard - ecoarmor:set_reaper_boots - prismarine_shard @@ -371,9 +385,11 @@ helmet: - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air + - nether_star - netherite_helmet - nether_star + - air - nether_star - air diff --git a/docs/ecoitems/how-to-make-a-custom-item.md b/docs/ecoitems/how-to-make-a-custom-item.md index f7633c553a..5d5364b51f 100644 --- a/docs/ecoitems/how-to-make-a-custom-item.md +++ b/docs/ecoitems/how-to-make-a-custom-item.md @@ -31,9 +31,11 @@ item: - "" - ecoitems:mithril 2 - "" + - "" - ecoitems:mithril 2 - "" + - "" - stick - "" diff --git a/docs/stattrackers/how-to-make-a-tracker.md b/docs/stattrackers/how-to-make-a-tracker.md index 7a17f013b8..8be2554c27 100644 --- a/docs/stattrackers/how-to-make-a-tracker.md +++ b/docs/stattrackers/how-to-make-a-tracker.md @@ -4,67 +4,73 @@ sidebar_position: 2 --- ## Default config -The default configs can be found here: +The default configs can be found [here](https://github.com/Auxilor/StatTrackers/tree/master/eco-core/core-plugin/src/main/resources/stats). +You can find additional user-created configs on [lrcdb](https://lrcdb.auxilor.io/). -[GitHub](https://github.com/Auxilor/StatTrackers/blob/master/eco-core/core-plugin/src/main/resources/stats/) +## How to add stat trackers +Each stat tracker is its own config file, placed in the `/stats/` folder, and you can add or remove them as you please. There's an example config called `_example.yml` to help you out! -## How to add stats -Stat Trackers are each config files placed in the `/stats/` 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 Stat Tracker is the file name. This is what you use in commands and in the [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system). +ID's must be lowercase letters, numbers, and underscores only. -## Example Stat Config +## Example Tracker Config ```yaml -# The ID of the stat is the name of the .yml file, -# for example damage_dealt.yml has the ID of damage_dealt -# You can place stat anywhere in this folder, -# including in subfolders if you want to organize your stat configs -# _example.yml is not loaded. - # The lore added to items with this tracker -display: "&bDamage Dealt: %value%" +display: "&bExample Tracker: %value%" -# Which items the tracker can be applied to, groups are in targets.yml +# The items that the tracker can be applied to, see targets.yml applicable-to: - - sword - - bow - trident - - axe # A counter 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 amount to add to the stat. +# 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 counters: - - trigger: melee_attack - - trigger: bow_attack - - trigger: trident_attack + - trigger: trident_attack # See list of triggers: https://plugins.auxilor.io/effects/all-triggers + multiplier: 1 # You can also use "value" here (see above comment) + conditions: # (Optional) Example of using conditions in counters + - id: in_water # Options for the physical tracker item tracker: - # The item, read here for options: https://plugins.auxilor.io/all-plugins/the-item-lookup-system - item: compass - - # The display name of the tracker - name: "&eTracker - Damage Dealt" - - # The lore of the tracker - lore: + item: compass # The item in-game: https://plugins.auxilor.io/all-plugins/the-item-lookup-system + name: "&eTracker - Damage Dealt" # The display name of the tracker + lore: # The item lore - "&8Drop this onto an item with /stattrackers" - - "&8to display the amount of damage dealt" - - # If the tracker should be craftable - craftable: true - - # The tracker recipe, read here: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes - recipe: + - "&8to display the amount of damage dealt with Tridents" + - "&8whilst in water" + craftable: true # If the tracker can be crafted + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes - iron_sword - iron_sword - iron_sword - + - iron_sword - compass - iron_sword - + - iron_sword - iron_sword - iron_sword ``` + +### Understanding all the sections + +**display**: The lore added once the tracker is applied + +**applicable-to:** The items that the tracker can be applied to, see [targets.yml](https://github.com/Auxilor/StatTrackers/blob/master/eco-core/core-plugin/src/main/resources/targets.yml) + +**counters:** The trigger, multiplier/value, conditions and filters to be tracked + +### Tracker Item: + +**item:** The base item, read here for more: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system). + +**name:** The item name in-game. + +**lore:** The item lore shown in-game. Set to `lore: []` to remove all lore lines. + +**craftable:** If the item should be craftable (true/false). + +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes) \ No newline at end of file diff --git a/docs/talismans/how-to-make-a-custom-talisman.md b/docs/talismans/how-to-make-a-custom-talisman.md index 250f44e18c..cc0e8728fe 100644 --- a/docs/talismans/how-to-make-a-custom-talisman.md +++ b/docs/talismans/how-to-make-a-custom-talisman.md @@ -16,19 +16,21 @@ ID's must be lowercase letters, numbers, and underscores only. ### Example Talisman Config ```yaml -name: "&aArchery Talisman I" +name: "&aArchery Talisman I" # The display name of the talisman description: # The item lore - "&8Deal 10% more damage with bows" higherLevelOf: [] # If the Talisman is higher level of another Talisman - Useful for only having the highest level Talisman active -item: "player_head texture:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZDBmOGRmYTVlZmM3NTYzMGNlMGRmNDBhNDliOGY1OWJjMjIyMTRkZTk3ZTNmYjQ0YjNjNTZlOGE5YzhhNTZiNiJ9fX0=" # The item in-game: https://plugins.auxilor.io/all-plugins/the-item-lookup-system +item: player_head texture:"eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZDBmOGRmYTVlZmM3NTYzMGNlMGRmNDBhNDliOGY1OWJjMjIyMTRkZTk3ZTNmYjQ0YjNjNTZlOGE5YzhhNTZiNiJ9fX0=" # The item in-game: https://plugins.auxilor.io/all-plugins/the-item-lookup-system craftable: true # If the item can be crafted recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes - bow - crossbow - bow + - crossbow - ecoitems:talisman_core_1 ? ender_eye - crossbow + - bow - crossbow - bow @@ -36,7 +38,7 @@ recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins # The effects of the item (i.e. the functionality) # See here: https://plugins.auxilor.io/effects/configuring-an-effect effects: - - id: "damage_multiplier" + - id: damage_multiplier args: multiplier: 1.1 triggers: