From 68a5356f9b39f1116376bb2078ab61d37f432aeb Mon Sep 17 00:00:00 2001 From: BenceX100 <52270269+BenceX100@users.noreply.github.com> Date: Mon, 22 Jul 2024 21:22:43 +0200 Subject: [PATCH] Improvements --- Writerside/hi.tree | 3 +++ .../topics/AxBoosters-Supported-Plugins.md | 3 ++- .../topics/AxBoosters-Updating-to-V3.md | 2 +- .../AxGraves-How-to-Edit-the-Configuration.md | 7 +++++++ .../topics/AxRewards-Adding-new-rewards.md | 19 +++++++++++++++++++ .../topics/AxRewards-Creating-new-menus.md | 12 ++++++++++++ Writerside/topics/AxRewards-Placeholders.md | 2 +- Writerside/topics/Item-Builder.md | 13 ++++++++++++- 8 files changed, 57 insertions(+), 4 deletions(-) create mode 100644 Writerside/topics/AxGraves-How-to-Edit-the-Configuration.md create mode 100644 Writerside/topics/AxRewards-Adding-new-rewards.md create mode 100644 Writerside/topics/AxRewards-Creating-new-menus.md diff --git a/Writerside/hi.tree b/Writerside/hi.tree index ba94fe8..1682781 100644 --- a/Writerside/hi.tree +++ b/Writerside/hi.tree @@ -69,6 +69,7 @@ + @@ -129,6 +130,8 @@ + + diff --git a/Writerside/topics/AxBoosters-Supported-Plugins.md b/Writerside/topics/AxBoosters-Supported-Plugins.md index 3704b60..787036b 100644 --- a/Writerside/topics/AxBoosters-Supported-Plugins.md +++ b/Writerside/topics/AxBoosters-Supported-Plugins.md @@ -15,6 +15,7 @@ `vanilla:potion_` - all the vanilla potions work (from /effects) +- [https://minecraft.wiki/w/Potion#ID](https://minecraft.wiki/w/Potion#ID) - instead of multipliers, they are amplifiers - for example, a potion with +200% multiplier will be a lvl 3 potion (because +0-99% is lvl 1) - examples: Night Vision, Jump Boost, Speed, Haste & many more @@ -23,7 +24,7 @@ `vanilla:attribute_` - all the attributes work (from /attribute) -- https://minecraft.wiki/w/Attribute (note that a lot of attributes are only available on 1.21) +- [https://minecraft.wiki/w/Attribute](https://minecraft.wiki/w/Attribute) (note that a lot of attributes are only available on 1.21) - examples: Mining Speed, Walking Speed, Player Scale & many more ### Third party diff --git a/Writerside/topics/AxBoosters-Updating-to-V3.md b/Writerside/topics/AxBoosters-Updating-to-V3.md index 0ace773..215c160 100644 --- a/Writerside/topics/AxBoosters-Updating-to-V3.md +++ b/Writerside/topics/AxBoosters-Updating-to-V3.md @@ -4,7 +4,7 @@ - Try the updating process first on a test/local server. - Take a backup of the axboosters folder. - Check the console for errors, if you see any concerning AxBoosters errors, contact us. -- If you run a seasonal server, I would just recommend waiting with this update and starting clean, reconfiguring everything. Why? The new files are much cleaner and have some extra placeholders that you will not be able to see if you are updating from an old version. Of course, if this is not a problems for you, you can update. +- If you run a seasonal server, I would just recommend waiting with this update and starting clean, reconfiguring everything. Why? The new files are much cleaner and have some extra placeholders that you will not be able to see if you are updating from an old version. Of course, if this is not a problem for you, you can update. ### Updating process - Stop the server diff --git a/Writerside/topics/AxGraves-How-to-Edit-the-Configuration.md b/Writerside/topics/AxGraves-How-to-Edit-the-Configuration.md new file mode 100644 index 0000000..e757677 --- /dev/null +++ b/Writerside/topics/AxGraves-How-to-Edit-the-Configuration.md @@ -0,0 +1,7 @@ +# How to Edit the Configuration? + +**You can edit settings (like despawn time and messages) mentioned in [Configuration](AxGraves-Configuration.md) in a couple of simple steps:** +- Navigate to the **plugins/AxGraves** folder, here you can find the config.yml and the messages.yml +- Open the one that you would like to modify and you can make your changes. +- One you have changed everything that you wanted, make sure to save the file and run /axgraves reload +- It is useful to understand YAML syntax, but don't worry, we provide useful information in the console if something goes wrong. \ No newline at end of file diff --git a/Writerside/topics/AxRewards-Adding-new-rewards.md b/Writerside/topics/AxRewards-Adding-new-rewards.md new file mode 100644 index 0000000..b223815 --- /dev/null +++ b/Writerside/topics/AxRewards-Adding-new-rewards.md @@ -0,0 +1,19 @@ +# Adding new rewards + +### Adding rewards is simple: +- Go to the menu where you want to add/edit rewards. (the menus can be found at plugins/AxRewards/menus) +- Copy one of the premade rewards from the default menu (or if you deleted it, you can still find it [on our github](https://github.com/Artillex-Studios/AxRewards/blob/master/src/main/resources/menus/default.yml)) +- Make sure to change the name of the reward and the `slot` section (slots start from 0 and they go from top left to right) +- Change the things that you would like +- Reload the plugin with /axrewards reload +- And that's it! + +### More information +- All the items use our [itembuilder](Item-Builder.md), you can use anything from it. +- It is possible to require a permission for claiming rewards, you can do it by setting the `permission` section. +- The `cooldown` section is required to make the reward claimable multiple times. This is defined in seconds. You can set it to -1 to make a reward never refresh. +- You can define rewards in the `claim-commands` section, it is a list, so you can add as many rewards as you would like. Also use %\player% for the player's name! +- There are 2 or 3 different items that you can set: + - `claimable` - This item is shown when the reward is claimable + - `unclaimable` - This item is shown if the reward is already claimed + - (optional) `no-permission` - This will only show if the reward has a permission and the player is missing it \ No newline at end of file diff --git a/Writerside/topics/AxRewards-Creating-new-menus.md b/Writerside/topics/AxRewards-Creating-new-menus.md new file mode 100644 index 0000000..c253b2d --- /dev/null +++ b/Writerside/topics/AxRewards-Creating-new-menus.md @@ -0,0 +1,12 @@ +# Creating new menus + +You can find all the menus in the plugins/AxRewards/menus folder. + +To create a new one, all you need to to: +- Copy one of the existing menus (if you don't have it, you can take one from [our github](https://github.com/Artillex-Studios/AxRewards/blob/master/src/main/resources/menus/default.yml)) +- Give it a different name +- Make sure to change the `open-commands` section +- Change the rewards (if you want) +- Reload the plugin with /axrewards reload + +And this is all, the new menu will be avaliable with the /axrewards open <menu> command (or with the command you defined) \ No newline at end of file diff --git a/Writerside/topics/AxRewards-Placeholders.md b/Writerside/topics/AxRewards-Placeholders.md index 9a02a21..e6bc6ed 100644 --- a/Writerside/topics/AxRewards-Placeholders.md +++ b/Writerside/topics/AxRewards-Placeholders.md @@ -3,4 +3,4 @@ |-|-| | Placeholder | Description | | %\axrewards_collectable% | The number of uncollected rewards for the player | -| %\axrewards_collectable_<menu>% | The number of uncollected rewards for the player | \ No newline at end of file +| %axrewards_collectable_<menu>% | The number of uncollected rewards for the player | \ No newline at end of file diff --git a/Writerside/topics/Item-Builder.md b/Writerside/topics/Item-Builder.md index 51265e7..5f5a955 100644 --- a/Writerside/topics/Item-Builder.md +++ b/Writerside/topics/Item-Builder.md @@ -4,10 +4,21 @@ On this page you can find every item related configuration that is possible to c Note that you don't need to use all of these values at once, only material is required! +### Example: + +```yaml + material: STICK + custom-model-data: 100 + glow: true + lore: + - "&fthis is a lore," + - "&eit can be multiple lines!" +``` + ### Material: ```yaml - material: DIAMOND + material: DIAMOND ``` * List of materials: [CLICK](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)