diff --git a/docs/all-plugins/_category_.json b/docs/all-plugins/_category_.json index 0fe538cb1c..4817daec03 100644 --- a/docs/all-plugins/_category_.json +++ b/docs/all-plugins/_category_.json @@ -1,4 +1,4 @@ { "label": "Stuff in all plugins", - "position": 2 + "position": 3 } \ No newline at end of file diff --git a/docs/all-plugins/custom-gui-slots.md b/docs/all-plugins/custom-gui-slots.md deleted file mode 100644 index fd7e36e30f..0000000000 --- a/docs/all-plugins/custom-gui-slots.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Custom GUI Slots -sidebar_position: 9 ---- - -## What are custom GUI slots? - -When configuring a GUI in a plugin, you might stumble across this: - -```yaml -# Custom GUI slots; see here for a how-to: https://plugins.auxilor.io/all-plugins/custom-gui-slots -custom-slots: [] -``` - -This means you can add custom items (with commands) to your GUIs for that extra layer of customizability. - -## How to make a custom GUI slot - -Quite simply, a GUI slot looks like this: - -```yaml -custom-slots: - - row: 6 - column: 9 - item: ecoitems:skill_gui_item - lore: [] - left-click: - - console:op %player% # Commands can start with console: to be ran by console, and use %player% as a placeholder. - - spawn # If you don't specify, then the command will be ran by the player. - right-click: [] - shift-left-click: [] - shift-right-click: [] -``` - -If you have no right click / shift left click / etc.. commands to add, you can omit the sections, like this: - -```yaml -custom-slots: - - row: 1 - column: 5 - item: player_head texture:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvODU3MDVjZjg2NGRmMmMxODJlMzJjNDg2YjcxNDdjYmY3ODJhMGFhM2RmOGE2ZDYxNDUzOTM5MGJmODRmYjE1ZCJ9fX0= - right-click: - - console:eco give %player% 1000 -``` - -And you can add as many custom slots as you want, like this: - -```yaml -custom-slots: - - - - - - - - ...etc - ``` diff --git a/docs/all-plugins/math.md b/docs/all-plugins/math.md index 021d7e5930..b59b1bdcd0 100644 --- a/docs/all-plugins/math.md +++ b/docs/all-plugins/math.md @@ -25,6 +25,6 @@ These are the most commonly used mathematical expressions within eco plugins. To | `max` | Returns the highest value (`min(10,2 * 10)` returns `20`) | ## Examples -In EcoSkills, you might want to provide players with a mining speed multiplier, capping it at 3.0x: `multiplier: 'max(3, (%level% * 0.1))'`. This ensures that the player gains a 0.10x mining speed boost per level, up to a maximum of 3.0x. +In EcoSkills, you might want to provide players with a mining speed multiplier, capping it at 3.0x: `multiplier: 'min(3, (%level% * 0.1))'`. This ensures that the player gains a 0.10x mining speed boost per level, up to a maximum of 3.0x. In EcoQuests, you might want players to collect a random amount of Coal Ore to complete the task: `xp: 'random(32,128)'` would randomise the task requirements between 32 ores and 128 ores. \ No newline at end of file diff --git a/docs/all-plugins/pages.md b/docs/all-plugins/pages.md index 558d859771..e9661f92f7 100644 --- a/docs/all-plugins/pages.md +++ b/docs/all-plugins/pages.md @@ -6,7 +6,7 @@ sidebar_position: 8 ## Custom Pages Custom pages are used in most of the plugins, and understanding how to correctly configure a GUI page is important to creating your menus. -## How to make a page +### How to make a page Pages consist of three key components, a mask, a pattern, and sometimes a page number. A pattern is the layout of the background or filler items. Think of the pattern section as the GUI, with 9 columns and up to 6 rows. @@ -19,7 +19,7 @@ In total you could display 35 different items as "filler" items in your GUI. A mask is the items to be shown in the pattern layout, these work from the top down. You can use the [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system) here to add custom items, apply names or any other of the options. The first item in the list will represent `1` in the pattern, the second item in the list is `2`, etc.. -## Example Page Config +### Example Page Config ```yaml - page: 1 @@ -35,4 +35,55 @@ The first item in the list will represent `1` in the pattern, the second item in This example has a surrounding layer of `gray_stained_glass_pane` and a center strip of `black_stained_glass_pane`. -![Page](https://i.imgur.com/tQLXe3F.png) \ No newline at end of file +![Page](https://imgur.com/lyLo6pD) + +## Custom GUI Slots +### What are custom GUI slots? + +When configuring a GUI in a plugin, you might stumble across this: + +```yaml +# Custom GUI slots; see here for a how-to: https://plugins.auxilor.io/all-plugins/pages#custom-gui-slots +custom-slots: [] +``` + +This means you can add custom items (with commands) to your GUIs for that extra layer of customizability. + +### How to make a custom GUI slot + +Quite simply, a GUI slot looks like this: + +```yaml +custom-slots: + - row: 6 + column: 9 + item: ecoitems:skill_gui_item + lore: [] + left-click: + - console:op %player% # Commands can start with console: to be ran by console, and use %player% as a placeholder. + - spawn # If you don't specify, then the command will be ran by the player. + right-click: [] + shift-left-click: [] + shift-right-click: [] +``` + +If you have no right click / shift left click / etc.. commands to add, you can omit the sections, like this: + +```yaml +custom-slots: + - row: 1 + column: 5 + item: player_head texture:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvODU3MDVjZjg2NGRmMmMxODJlMzJjNDg2YjcxNDdjYmY3ODJhMGFhM2RmOGE2ZDYxNDUzOTM5MGJmODRmYjE1ZCJ9fX0= + right-click: + - console:eco give %player% 1000 +``` + +And you can add as many custom slots as you want, like this: + +```yaml +custom-slots: + - + - + - + - ...etc + ``` diff --git a/docs/all-plugins/prices.md b/docs/all-plugins/prices.md index 38fa462d2a..687a54b239 100644 --- a/docs/all-plugins/prices.md +++ b/docs/all-plugins/prices.md @@ -1,5 +1,5 @@ --- -title: Prices +title: The Price System sidebar_position: 7 --- diff --git a/docs/all-plugins/the-entity-lookup-system.md b/docs/all-plugins/the-entity-lookup-system.md index 19160cde66..b41b4438d8 100644 --- a/docs/all-plugins/the-entity-lookup-system.md +++ b/docs/all-plugins/the-entity-lookup-system.md @@ -11,9 +11,16 @@ In each string is the key for an entity. A key looks one of two ways: - A vanilla minecraft entity: (eg `husk`) - An entity from another plugin: (eg `ecomobs:tarantula`) -You may also have noticed the ? in some of the keys. This means 'try to use the first entity, but if it doesn't exist, use the second entity' You can chain these together, but they're actually only useful for me to provide integrations in default configs without breaking things for people who don't use all my plugins together. +### Using entities from other plugins -You can also use || . This means 'spawn the first entity, or the second entity'. These can also be chained together: in tests, this means any of the entities can pass, and in specifying the types of entities, this means that a random entity out of the options will be spawned on each call. +| Plugin | Item Lookup Key | +|------------|------------------| +| EcoMobs | `ecomobs:` | +| MythicMobs | `mythicmobs:` | + +#### Extra syntax +- `?` between two entities means 'try to spawn the first entity, but if it doesn't exist, spawn the second entity'. You can chain these together. +- `||` groups two entities, allowing either one of them to be spawned, at random. You can chain these together to create further randomness on spawns. ## Modifiers Entities can have modifiers applied to them in the key. For example, lets say you're configuring a mob in EcoMobs. You want it to be a massive slime, a baby zombie, or a charged creeper, but you're not sure how to do that, because it looks like you have to just specify an entity type. Actually, in all of my plugins, wherever it asks for an entity, it's actually doing a lookup. You can specify any of the following modifiers to it: diff --git a/docs/all-plugins/the-item-lookup-system/_category_.json b/docs/all-plugins/the-item-lookup-system/_category_.json new file mode 100644 index 0000000000..d33e588637 --- /dev/null +++ b/docs/all-plugins/the-item-lookup-system/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "The Item Lookup System", + "position": 1 +} \ No newline at end of file diff --git a/docs/all-plugins/the-item-lookup-system.md b/docs/all-plugins/the-item-lookup-system/index.md similarity index 75% rename from docs/all-plugins/the-item-lookup-system.md rename to docs/all-plugins/the-item-lookup-system/index.md index 707d878133..8f8ced472a 100644 --- a/docs/all-plugins/the-item-lookup-system.md +++ b/docs/all-plugins/the-item-lookup-system/index.md @@ -7,27 +7,7 @@ sidebar_position: 3 The item lookup system is how items are loaded from configs. It's designed to be extremely flexible and intuitive, allowing you to use custom items, stacks, enchantments, etc. wherever you want, without having to worry about what plugin they're from. -## Crafting Recipes - -Crafting recipes in eco plugins often look something like this: - -```yaml -recipe: - - "" - - "ecoitems:toughened_string 8 ? string 64" - - "" - - - "" - - "netherite_chestplate || diamond_chestplate" - - "" - - - "ecoitems:arachnid_oculus ? nether_star 2" - - "" - - "ecoitems:arachnid_oculus ? nether_star 2" -``` - -While it may look meaningless, this system is straightforward once you understand how it works. A crafting recipe is written as a list of 9 strings, the first three being the top row (left to right), -the second three being the middle row (left to right), and the last three being the last row (left to right). +Anywhere you need to use items, you can use this system. To look up an item, you need a key, and optional modifiers. ## Keys Explained @@ -38,6 +18,14 @@ In each string is the key for an item. A key looks one of a few ways - An exact item NBT tag: (e.g. `{id:"stone",Count:3,tag:{Name:"your name"}}`) - An item tag: (e.g. `#talismans:talisman` or `#items_axes`) +#### Extra syntax + +- `?` between two items means 'try to use the first item, but if it doesn't exist, use the second item'. You can chain these together. +- `||` groups two items, allowing either one of them to be used. You can chain these together. +- You can specify stack size, e.g. `string 64` would mean a full stack of string. + +When using exact item NBT, you can't use `?`. `||`, or other modifiers. + ### Vanilla Materials By default, a vanilla material (e.g. `diamond_pickaxe`) will not accept custom items with the same material. For example, if you have an EcoItems item with `diamond_pickaxe` as its base material, @@ -59,22 +47,49 @@ tags: - "diamond_sword" ``` -A list of custom item tags can be found later in this page. +### Using items from eco plugins -#### Extra syntax +| Plugin | Item Lookup Key | Item Tag | +| ------------ | ----------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| EcoArmor | `ecoarmor:set__` (Optional: `_advanced`)
`ecoarmor:shard_`
`ecoarmor:crystal_` | | +| EcoCrates | `ecocrates:_key` | | +| EcoItems | `ecoitems:` | `#ecoitems:item` | +| EcoMobs | `ecomobs:_spawn_egg` | | +| EcoPets | `ecopets:_spawn_egg` | | +| EcoScrolls | `ecoscrolls:scroll_` | `#ecoscrolls:scroll` | +| Reforges | `reforges:stone_` | `#reforges:stone`
`#reforges:reforged` | +| StatTrackers | `stattrackers:` | | +| Talismans | `talismans:` | `#talismans:talisman` | -- `?` between two items means 'try to use the first item, but if it doesn't exist, use the second item'. You can chain these together. -- `||` groups two items, allowing either one of them to be used. You can chain these together. -- You can specify stack size, e.g. `string 64` would mean a full stack of string. +### Using items from third-party plugins -When using exact item NBT, you can't use `?`. `||`, or other modifiers. +Sometimes custom item IDs are namespaced. In order to make this work, you have to specify them like `plugin:namespace__key`, where **two underscores** denote where the `:` would normally go. + +| Plugin | Item Lookup Key | +| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| ItemsAdder | `itemsadder:__`, example below. | +| Oraxen | `oraxen:`, e.g. `oraxen:alumite_pickaxe` | +| ItemBridge | `itembridge:saved__` for items you've saved within ItemBridge. You can use `itembridge:__` for plugin items supported in ItemBridge. | + +#### ItemsAdder + +```yaml +# ** ItemsAdder configuration ** +info: + namespace: my_items +items: + my_helmet: + display_name: "&9Custom Helmet" +``` + +ItemsAdder items are namespaced, so for example, the above would be `itemsadder:crystal_pack__alumite_pickaxe`, where `crystal_pack` is the namespace, and `alumite_pickaxe` is the item ID. ## Modifiers Items can have modifiers applied to them. For example, lets say you're configuring the GUI for EcoSkills. You want it to be a player head with a texture, but you're not sure how to do that, because it looks like you have to just specify a material. Actually, in all eco plugins, wherever it asks for a material, it's actually doing a lookup. You can specify any of the following modifiers to it: - **Enchantments:** You can specify an enchantment with `:` -- Stack Quantity: You can specify a stack quantity by using the amount, e.g. `iron_ingot 32` +- **Stack Quantity:** You can specify a stack quantity by using the amount, e.g. `iron_ingot 32` - **Skull Texture:** If the material is a player head, you can specify the texture with `texture:`. A list of skulls and textures can be found [here](https://minecraft-heads.com/). - **Player Head:** If the material is a player head, you can specify a player using `head:`. You can also use placeholders, e.g. `head:%player%` - **Reforge:** You can specify the reforge by adding `reforge:` to the key. @@ -96,35 +111,12 @@ These modifiers are only available on **Paper 1.21+**: So, lets say you have an EcoMobs mob, and you want it to drop a rare custom weapon with extra modifiers already applied. Without the Item Lookup system, this wouldn't be possible, but thanks to it, you can just do this: `ecoitems:enlightened_blade razor:4 unbreaking:3 criticals:2 fire_aspect:2 reforge:mighty unbreakable hide_attributes custom_model_data:2` -## Using items in eco plugins - -| Plugin | Item Lookup Key | -| ------------ | ----------------------------------------------------------------------------------------------------------- | -| EcoArmor | `ecoarmor:set__` (Optional: `_advanced`)
`ecoarmor:shard_`
`ecoarmor:crystal_` | -| EcoCrates | `ecocrates:_key` | -| EcoItems | `ecoitems:` | -| EcoMobs | `ecomobs:_spawn_egg` | -| EcoPets | `ecopets:_spawn_egg` | -| EcoScrolls | `ecoscrolls:scroll_` | -| Reforges | `reforges:stone_` | -| StatTrackers | `stattrackers:` | -| Talismans | `talismans:` | - -## Using item tags in eco plugins - -| Plugin | Item Tag | Description | -| ---------- | --------------------- | ------------------------------- | -| EcoItems | `#ecoitems:item` | Any EcoItems item | -| EcoScrolls | `#ecoscrolls:scroll` | Any EcoScrolls scroll | -| Reforges | `#reforges:stone` | Any reforge stone | -| Reforges | `#reforges:reforged` | Any item with a reforge present | -| Talismans | `#talismans:talisman` | Any talisman | - -## Using items in MythicMobs +## Using eco plugin items in other plugins +### MythicMobs If you want to use a lookup item in MythicMobs, just do it like this: `eco{type=}`, e.g. `eco{type=ecoitems:}` -## Using items in ShopGUIPlus +### ShopGUIPlus If you want to use a lookup item in ShopGUIPlus, just do it like this: @@ -137,25 +129,3 @@ sellPrice: 7500 slot: 27 ``` -## Using items from third-party plugins - -Sometimes custom item IDs are namespaced. In order to make this work, you have to specify them like `plugin:namespace__key`, where **two underscores** denote where the `:` would normally go. - -| Plugin | Item Lookup Key | -| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| ItemsAdder | `itemsadder:__`, example below. | -| Oraxen | `oraxen:`, e.g. `oraxen:alumite_pickaxe` | -| ItemBridge | `itembridge:saved__` for items you've saved within ItemBridge. You can use `itembridge:__` for plugin items supported in ItemBridge. | - -### ItemsAdder - -```yaml -# ItemsAdder configuration -info: - namespace: my_items -items: - my_helmet: - display_name: "&9Custom Helmet" -``` - -ItemsAdder items are namespaced, so for example, the above would be `itemsadder:crystal_pack__alumite_pickaxe`, where `crystal_pack` is the namespace, and `alumite_pickaxe` is the item ID. \ No newline at end of file diff --git a/docs/all-plugins/the-item-lookup-system/recipes.md b/docs/all-plugins/the-item-lookup-system/recipes.md new file mode 100644 index 0000000000..ec8d436dad --- /dev/null +++ b/docs/all-plugins/the-item-lookup-system/recipes.md @@ -0,0 +1,31 @@ +--- +title: Crafting Recipes +sidebar_position: 1 +--- +Anywhere that you configure items for players in eco plugins, you can use the Item Lookup System to add crafting recipes for them. + +EcoItems also allows you to add custom crafting recipes for any lookup item, not limited to EcoItems items. This means you can add more recipes for items from other plugins, such as EcoPets or EcoScrolls, or even vanilla items, like Enchanted Golden Apples. + +Crafting recipes in eco plugins are super easy to configure, and often look something like this: + +```yaml +recipe: + - "diamond" + - "emerald" + - "diamond" + - "" + - "stick" + - "" + - "" + - "stick" + - "" + +# All recipes are shaped. We do not currently support shapeless recipes. +``` + +While it may look meaningless, this system is straightforward once you understand how it works. A crafting recipe is written as a list of 9 strings, the first three being the top row (left to right), +the second three being the middle row (left to right), and the last three being the last row (left to right). + +The example recipe would look like this in-game: + +![Recipe](https://imgur.com/a/26Z3f1R) \ No newline at end of file diff --git a/docs/ecoarmor/how-to-make-a-custom-set.md b/docs/ecoarmor/how-to-make-a-custom-set.md index 8f4e1112a4..a8bfaafe69 100644 --- a/docs/ecoarmor/how-to-make-a-custom-set.md +++ b/docs/ecoarmor/how-to-make-a-custom-set.md @@ -74,7 +74,7 @@ shard: - "&8to make it Advanced." craftable: false # If the shard is craftable crafting-permission: "permission" # (Optional) The permission required to craft this recipe. - recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - prismarine_shard - ecoarmor:set_reaper_helmet - prismarine_shard @@ -100,7 +100,7 @@ helmet: - "&8&oUpgrade with an Upgrade Crystal" craftable: true # If the armor piece is craftable crafting-permission: "permission" # (Optional) The permission required to craft this recipe. - recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air @@ -335,7 +335,7 @@ shard: - "&8to make it Advanced." craftable: false # If the shard is craftable crafting-permission: "permission" # (Optional) The permission required to craft this recipe. - recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - prismarine_shard - ecoarmor:set_reaper_helmet - prismarine_shard @@ -361,7 +361,7 @@ shard: **crafting-permission:** (Optional) The permission required to craft the recipe. -**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes) +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes) ## Individual Armor Piece Config @@ -381,7 +381,7 @@ helmet: - "&8&oUpgrade with an Upgrade Crystal" craftable: true # If the armor piece is craftable crafting-permission: "permission" # (Optional) The permission required to craft this recipe. - recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - ecoitems:armor_core ? air - nether_star - ecoitems:armor_core ? air @@ -425,7 +425,7 @@ helmet: **crafting-permission:** (Optional) The permission required to craft the recipe. -**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes) +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes) **defaultTier:** The default tier of the armor piece. Tiers are found in `/ecoarmor/tiers`, read here for more: [How to make a custom tier](https://plugins.auxilor.io/ecoarmor/how-to-make-a-custom-tier). diff --git a/docs/ecoarmor/how-to-make-a-custom-tier.md b/docs/ecoarmor/how-to-make-a-custom-tier.md index 30e2c0a17b..9b77b08fa0 100644 --- a/docs/ecoarmor/how-to-make-a-custom-tier.md +++ b/docs/ecoarmor/how-to-make-a-custom-tier.md @@ -29,7 +29,7 @@ crystal: - '' - "&8&oRequires the armor to already have Diamond tier" craftable: true # If the armor piece is craftable - recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - air - netherite_ingot - air @@ -108,7 +108,7 @@ The "Netherite" Tier can only be applied to armor pieces that have the "Diamond" **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) +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes) **giveAmount:** The amount of items to give when crafted. diff --git a/docs/ecoitems/additional-configuration-options.md b/docs/ecoitems/additional-configuration-options.md index e63e48dafb..d22f52561a 100644 --- a/docs/ecoitems/additional-configuration-options.md +++ b/docs/ecoitems/additional-configuration-options.md @@ -14,7 +14,7 @@ Additional recipes can be used for EcoItems but also for items from other plugin ```yaml result: ecoitems:enchanted_emerald 9 # The item to give, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system -recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes +recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - "" - emerald_block 32 - "" @@ -32,7 +32,7 @@ permission: "ecoitems.craft.enchanted_emerald_block_craft" # (Optional) The perm **result:** The item(s) being crafted, read here for more: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system). -**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes) +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes) **permission:** (Optional) The permission required to craft the recipe. diff --git a/docs/ecoitems/how-to-make-a-custom-item.md b/docs/ecoitems/how-to-make-a-custom-item.md index 03fa80d699..f533e053a5 100644 --- a/docs/ecoitems/how-to-make-a-custom-item.md +++ b/docs/ecoitems/how-to-make-a-custom-item.md @@ -27,7 +27,7 @@ item: - "&8ยป &#f953c6Deal 50% more damage in the nether" craftable: true # If the item can be crafted crafting-permission: "ecoitems.craft.example" # (Optional) The permission required to craft this recipe. - recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - "" - ecoitems:mithril 2 - "" @@ -83,7 +83,7 @@ conditions: **crafting-permission:** (Optional) The permission required to craft the recipe. -**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes). You can create additional recipes, read here for more: [How to add additional recipes](https://plugins.auxilor.io/ecoitems/additional-configuration-options#how-to-add-additonal-recipes). +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes). You can create additional recipes, read here for more: [How to add additional recipes](https://plugins.auxilor.io/ecoitems/additional-configuration-options#how-to-add-additonal-recipes). **recipe-give-amount:** The amount of items to give when crafted. diff --git a/docs/ecopets/how-to-make-a-custom-pet.md b/docs/ecopets/how-to-make-a-custom-pet.md index 525c5c7283..1e3e6b85cc 100644 --- a/docs/ecopets/how-to-make-a-custom-pet.md +++ b/docs/ecopets/how-to-make-a-custom-pet.md @@ -172,7 +172,7 @@ xp-requirements: **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). +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes). **recipe-permission:** (Optional) The permission required to craft the recipe. diff --git a/docs/ecoscrolls/how-to-make-a-scroll.md b/docs/ecoscrolls/how-to-make-a-scroll.md index c540a42bdb..014a839248 100644 --- a/docs/ecoscrolls/how-to-make-a-scroll.md +++ b/docs/ecoscrolls/how-to-make-a-scroll.md @@ -142,7 +142,7 @@ For more advanced users or setups, you can configure chains in this section to s **crafting-permission:** (Optional) The permission required to craft the recipe. -**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes) +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes) ### Inscription diff --git a/docs/ecoshop/how-to-make-a-category.md b/docs/ecoshop/how-to-make-a-category.md index da597c8771..494e60c932 100644 --- a/docs/ecoshop/how-to-make-a-category.md +++ b/docs/ecoshop/how-to-make-a-category.md @@ -55,7 +55,7 @@ gui: - "211111112" - "222222222" - # Custom GUI slots; see here for a how-to: https://plugins.auxilor.io/all-plugins/custom-gui-slots + # Custom GUI slots; see here for a how-to: https://plugins.auxilor.io/all-plugins/pages#custom-gui-slots custom-slots: [ ] # The items for your players to buy or sell, read here for more info: https://plugins.auxilor.io/ecoshop/how-to-make-an-item @@ -141,7 +141,7 @@ items: To configure a pattern and mask, read here for more info: [Pages](https://plugins.auxilor.io/all-plugins/pages) -**custom-slots:** Any non-shop items for the GUI (eg. info items), read here for more info: [Custom GUI Slots](https://plugins.auxilor.io/all-plugins/custom-gui-slots). +**custom-slots:** Any non-shop items for the GUI (eg. info items), read here for more info: [Custom GUI Slots](https://plugins.auxilor.io/all-plugins/pages#custom-gui-slots). ### Items diff --git a/docs/ecoshop/how-to-make-a-shop.md b/docs/ecoshop/how-to-make-a-shop.md index 0bcf635d60..64290790c7 100644 --- a/docs/ecoshop/how-to-make-a-shop.md +++ b/docs/ecoshop/how-to-make-a-shop.md @@ -84,7 +84,7 @@ pages: # All the pages in the preview GUI. You can add as many pages as you want row: 4 column: 6 - # Custom GUI slots; see here for a how-to: https://plugins.auxilor.io/all-plugins/custom-gui-slots + # Custom GUI slots; see here for a how-to: https://plugins.auxilor.io/all-plugins/pages#custom-gui-slots custom-slots: [ ] ``` diff --git a/docs/all-plugins/what-is-eco.md b/docs/home.md similarity index 50% rename from docs/all-plugins/what-is-eco.md rename to docs/home.md index 45c13a5e09..98bd2afb78 100644 --- a/docs/all-plugins/what-is-eco.md +++ b/docs/home.md @@ -1,12 +1,22 @@ --- -title: What is eco? -sidebar_position: 1 +title: Information (Read First) +slug: / +sidebar_position: 0 --- +## What is eco? eco is the development library that powers all eco plugins. It handles a wide range of backend features, and allows eco plugins to be as powerful as they are. However, it means that you have to install it as a separate plugin on your server. -## How do I install it? +### How do I install it? It's just like any other plugin on your server. Drop it into the /plugins/ folder and restart the server. However, eco also needs ProtocolLib to function - if you don't already have it on your server, make sure to grab the latest version [here](https://ci.dmulloy2.net/job/ProtocolLib/lastSuccessfulBuild/) -Download the latest version of eco from [GitHub](https://github.com/Auxilor/eco/releases) or [Polymart](https://polymart.org/resource/1-16-1-17-eco.773) \ No newline at end of file +Download the latest version of eco from [GitHub](https://github.com/Auxilor/eco/releases) or [Polymart](https://polymart.org/resource/1-16-1-17-eco.773) + +## Where should I buy the plugins? +All plugins are available on [Spigot](https://www.spigotmc.org/resources/authors/auxilor.507394/) and [Polymart](https://polymart.org/user/auxilor.1107), and you can buy plugins at a 25% discount in a bundle, too - [click here to get them!](https://polymart.org/bundle/eco-pack.110) + +## Check out our partners! (Click to visit) + +[![GamerSupps](https://i.imgur.com/7mFhlQO.png)](http://gamersupps.gg/discount/Auxilor?afmc=Auxilor) +[![DedicatedMC](https://i.imgur.com/x9aeH38.png)](https://dedimc.promo/Auxilor) diff --git a/docs/home.mdx b/docs/home.mdx deleted file mode 100644 index d23f2d9036..0000000000 --- a/docs/home.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Information (Read First) -slug: / -sidebar_position: 1 ---- - -## Where should I buy the plugins? -All plugins are available on [Spigot](https://www.spigotmc.org/resources/authors/auxilor.507394/) and [Polymart](https://polymart.org/user/auxilor.1107), and you can buy plugins at a 25% discount in a bundle, too - [click here to get them!](https://polymart.org/bundle/eco-pack.110) - -## Where can I get support or ask questions? -[Join the discord here!](https://discord.gg/ZcwpSsE) - -## Check out our partners! (Click to visit) - -[![GamerSupps](https://i.imgur.com/7mFhlQO.png)](http://gamersupps.gg/discount/Auxilor?afmc=Auxilor) -[![DedicatedMC](https://i.imgur.com/x9aeH38.png)](https://dedimc.promo/Auxilor) diff --git a/docs/reforges/how-to-make-a-custom-reforge.md b/docs/reforges/how-to-make-a-custom-reforge.md index abf5521f9a..4a654bcac1 100644 --- a/docs/reforges/how-to-make-a-custom-reforge.md +++ b/docs/reforges/how-to-make-a-custom-reforge.md @@ -39,7 +39,7 @@ stone: item: player_head texture:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMmM0YTY1YzY4OWIyZDM2NDA5MTAwYTYwYzJhYjhkM2QwYTY3Y2U5NGVlYTNjMWY3YWM5NzRmZDg5MzU2OGI1ZCJ9fX0= craftable: true # If the reforge stone should be craftable - recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system#crafting-recipes + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - "" - ecoitems:blank_reforge_stone ? air - "" @@ -94,7 +94,7 @@ on-reforge-effects: [ ] **craftable:** If the stone 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) +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes) ### Effects & Conditions diff --git a/docs/stattrackers/how-to-make-a-tracker.md b/docs/stattrackers/how-to-make-a-tracker.md index 7e79b772c6..b4c23dbf4d 100644 --- a/docs/stattrackers/how-to-make-a-tracker.md +++ b/docs/stattrackers/how-to-make-a-tracker.md @@ -41,7 +41,7 @@ tracker: - "&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 + recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - iron_sword - iron_sword - iron_sword @@ -73,4 +73,4 @@ tracker: **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 +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/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 38b08fe76e..090da99517 100644 --- a/docs/talismans/how-to-make-a-custom-talisman.md +++ b/docs/talismans/how-to-make-a-custom-talisman.md @@ -22,7 +22,7 @@ description: # The item lore 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 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 +recipe: # The recipe, read here for more: https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes - bow - crossbow - bow @@ -60,7 +60,7 @@ conditions: [] **craftable:** If the talisman 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) +**recipe:** The recipe, read here for more info: [Crafting Recipes](https://plugins.auxilor.io/all-plugins/the-item-lookup-system/recipes) ### Effects & Conditions diff --git a/docs/all-plugins/what-plugins-do-you-support.md b/docs/what-plugins-are-supported.md similarity index 95% rename from docs/all-plugins/what-plugins-do-you-support.md rename to docs/what-plugins-are-supported.md index f327dd11c9..c11a2ac033 100644 --- a/docs/all-plugins/what-plugins-do-you-support.md +++ b/docs/what-plugins-are-supported.md @@ -1,6 +1,6 @@ --- -title: What plugins do you support? -sidebar_position: 2 +title: What plugins are supported? +sidebar_position: 1 --- Compatibility is a huge part of eco plugins, so naturally we support a large range of plugins. If a plugin you love isn't found here, feel free to ask on the discord to get support added for it! diff --git a/docusaurus.config.js b/docusaurus.config.js index f9a2bdf68c..3ebb9f1dc0 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -45,11 +45,16 @@ const config = { src: 'img/logo.svg', }, items: [ - { - href: 'https://github.com/Auxilor/auxilor.github.io/', - label: 'Help improve the docs!', - position: 'right', - }, + { + href: 'https://discord.gg/ZcwpSsE', + label: 'Support Discord', + position: 'right', + }, + { + href: 'https://github.com/Auxilor', + label: 'Contribute on GitHub', + position: 'right', + } ], }, prism: { diff --git a/package.json b/package.json index e30b66d32b..e3fd4be605 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "@mdx-js/react": "^1.6.22", "clsx": "^1.1.1", "docusaurus": "^1.14.7", - "prism-react-renderer": "^1.2.1", + "prism-react-renderer": "^1.3.1", "react": "^17.0.1", "react-dom": "^17.0.1" }, diff --git a/src/css/custom.css b/src/css/custom.css index 99f562ed7b..c2fc925242 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -15,6 +15,20 @@ --ifm-color-primary-lightest: #3c99ad; } +/* Style for the active sidebar link and dropdown headers in light mode */ +.theme-doc-sidebar-container .menu__link--active, +.theme-doc-sidebar-container .menu__list-item-collapsible--active, +.theme-doc-sidebar-container .menu__list-item-collapsible:has(.menu__link--active) { + background-color: #82a6da; /* Light blue background for light mode */ + color: #2d4764; /* Dark muted blue text for light mode */ +} + +/* Ensure text in dropdown headers (e.g., button or link) uses the same color in light mode */ +.theme-doc-sidebar-container .menu__list-item-collapsible--active a, +.theme-doc-sidebar-container .menu__list-item-collapsible:has(.menu__link--active) a { + color: #2d4764; /* Dark muted blue text for light mode */ +} + /* For readability concerns, you should choose a lighter palette in dark mode. */ [data-theme='dark'] { --ifm-color-primary: #259ac1; @@ -26,6 +40,20 @@ --ifm-color-primary-lightest: #4eb9dd; } +/* Style for the active sidebar link and dropdown headers in dark mode */ +[data-theme='dark'] .theme-doc-sidebar-container .menu__link--active, +[data-theme='dark'] .theme-doc-sidebar-container .menu__list-item-collapsible--active, +[data-theme='dark'] .theme-doc-sidebar-container .menu__list-item-collapsible:has(.menu__link--active) { + background-color: #2d4764; /* Dark muted blue background for dark mode */ + color: #82a6da; /* Light blue text for dark mode */ +} + +/* Ensure text in dropdown headers (e.g., button or link) uses the same color in dark mode */ +[data-theme='dark'] .theme-doc-sidebar-container .menu__list-item-collapsible--active a, +[data-theme='dark'] .theme-doc-sidebar-container .menu__list-item-collapsible:has(.menu__link--active) a { + color: #82a6da; /* Light blue text for dark mode */ +} + .docusaurus-highlight-code-line { background-color: rgba(0, 0, 0, 0.1); display: block; @@ -36,3 +64,25 @@ [data-theme='dark'] .docusaurus-highlight-code-line { background-color: rgba(0, 0, 0, 0.3); } + +/* Add solid left border to active sidebar items */ +.theme-doc-sidebar-container .menu__link--active:not(.menu__link--sublist), +.theme-doc-sidebar-container .menu__list-item-collapsible--active > .menu__link, +.theme-doc-sidebar-container .menu__list-item-collapsible:has(.menu__link--active) > .menu__link { + border-left: 3px solid #2d4764 !important; + border-top: none !important; + border-right: none !important; + border-bottom: none !important; +} + +[data-theme='dark'] .theme-doc-sidebar-container .menu__link--active:not(.menu__link--sublist), +[data-theme='dark'] .theme-doc-sidebar-container .menu__list-item-collapsible--active > .menu__link, +[data-theme='dark'] .theme-doc-sidebar-container .menu__list-item-collapsible:has(.menu__link--active) > .menu__link { + border-left: 3px solid #82a6da !important; +} + +/* Prevent double border on collapsible parent items */ +.menu__list-item-collapsible--active, +.menu__list-item-collapsible:has(.menu__link--active) { + border-left: none !important; +} \ No newline at end of file