diff --git a/.gitignore b/.gitignore deleted file mode 100644 index b869feb85e..0000000000 --- a/.gitignore +++ /dev/null @@ -1,23 +0,0 @@ -# Dependencies -/node_modules - -# Production -/build - -# Generated files -.docusaurus -.cache-loader - -# Misc -.DS_Store -.env.local -.env.development.local -.env.test.local -.env.production.local - -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -.idea -/.idea* \ No newline at end of file diff --git a/docs/ecomenus/_category_.json b/docs/ecomenus/_category_.json new file mode 100644 index 0000000000..3b096b1551 --- /dev/null +++ b/docs/ecomenus/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "EcoMenus", + "position": 20 +} diff --git a/docs/ecomenus/api.md b/docs/ecomenus/api.md new file mode 100644 index 0000000000..d49f7f1dfa --- /dev/null +++ b/docs/ecomenus/api.md @@ -0,0 +1,24 @@ +--- +title: "API" +sidebar_position: 4 +--- + +## Source Code + +The source code can be found [here](https://github.com/Auxilor/EcoMobs): + +## API + +Add this to your build.gradle.kts: + +```kts +repositories { + maven("https://repo.auxilor.io/repository/maven-public/") +} + +dependencies { + compileOnly("com.willfp:EcoMobs:") +} +``` + +The latest version available on the repo can be found [here](https://github.com/Auxilor/EcoMobs/tags) diff --git a/docs/ecomenus/commands-and-permissions.md b/docs/ecomenus/commands-and-permissions.md new file mode 100644 index 0000000000..38e9e627c9 --- /dev/null +++ b/docs/ecomenus/commands-and-permissions.md @@ -0,0 +1,13 @@ +--- +title: "Commands and Permissions" +sidebar_position: 1 +--- +## `/ecomenus forceopen` (Gives a spawn egg) +Permission: `ecomenus.command.forceopen` +General Usage: `/ecomenus forceopen ` +## `/ecomenus open` (Gives a spawn egg) +Permission: `ecomenus.command.open +General Usage: `/ecomenus open ` + +## `/ecomenus reload` (Reloads the plugin) +Permission: `ecomenus.command.reload` \ No newline at end of file diff --git a/docs/ecomenus/ecomenus-effects/_category_.json b/docs/ecomenus/ecomenus-effects/_category_.json new file mode 100644 index 0000000000..48bb3fcac9 --- /dev/null +++ b/docs/ecomenus/ecomenus-effects/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Effects System", + "position": 5 +} diff --git a/docs/ecomenus/ecomenus-effects/effects/_category_.json b/docs/ecomenus/ecomenus-effects/effects/_category_.json new file mode 100644 index 0000000000..9f7c51bce4 --- /dev/null +++ b/docs/ecomenus/ecomenus-effects/effects/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Effects", + "position": 1 +} diff --git a/docs/ecomenus/ecomenus-effects/effects/open_menu.md b/docs/ecomenus/ecomenus-effects/effects/open_menu.md new file mode 100644 index 0000000000..1dae7fd540 --- /dev/null +++ b/docs/ecomenus/ecomenus-effects/effects/open_menu.md @@ -0,0 +1,14 @@ +# `open_menu` +#### Triggered Effect + +Opens an EcoMenu + +**Requires EcoMenus** + +# Example Config +```yaml +- id: open_menu + args: + menu: # The ID of the enchant + ...other config (eg triggers, filters, mutators, etc) +``` diff --git a/docs/ecomenus/how-to-make-a-custom-menu.md b/docs/ecomenus/how-to-make-a-custom-menu.md new file mode 100644 index 0000000000..2f78607bf3 --- /dev/null +++ b/docs/ecomenus/how-to-make-a-custom-menu.md @@ -0,0 +1,171 @@ +--- +title: How to make a custom menu +sidebar_position: 2 +--- +--- + +## Default Configs + +The default configs can be found [here](https://github.com/Auxilor/EcoMenus/tree/master/eco-core/core-plugin/src/main/resources/menus). + +## Config Layout + +Each menu has its own config file, placed in the `/menus/` 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 menu is the file name. This is what you use in permissions and effects. +ID's must be lowercase letters, numbers, and underscores only. + +## Example Menu Config + +```yaml +# The title of the GUI +title: "Example GUI" + +# (Optional) The command to open the GUI, if not set, there will be no command. +command: examplemenu + +# Read https://plugins.auxilor.io/effects/configuring-a-condition +# The conditions required to open the GUI +conditions: [ ] + +# The messages to send when the conditions are not met +cannot-open-messages: + - "&cYou cannot open this menu!" + +# Read https://plugins.auxilor.io/effects/configuring-an-effect +# Effects to run when the GUI is opened +open-effects: [ ] + +# Effects to run when the GUI is closed +close-effects: [ ] + +# The size of the GUI, between 1 and 6 +rows: 6 + +# Options for the page arrows +# If on the first page, the backwards arrow will not be shown, +# and if on the last page, the forwards arrow will not be shown. +forwards-arrow: + item: arrow name:"&fNext Page" + enabled: true + location: + row: 6 + column: 8 + +backwards-arrow: + item: arrow name:"&fPrevious Page" + enabled: true + location: + row: 6 + column: 2 + +pages: + - page: 1 + mask: + # The way the mask works is by having a list of materials + # And then a pattern to use those materials. + + # The pattern is the rows in the GUI + # Each line must be 9 long, and the amount of rows should be the amount of rows in the GUI + # A zero represents nothing + # A 1 represents the first material + # A 2 represents the second material + # And so on, you can add up to 9. + + items: + - gray_stained_glass_pane + - black_stained_glass_pane + pattern: + - "211101112" + - "211111112" + - "210000012" + - "210010012" + - "211111112" + - "211101112" + - page: 2 + mask: + items: + - gray_stained_glass_pane + - red_stained_glass_pane + pattern: + - "211101112" + - "211111112" + - "210000012" + - "210010012" + - "211111112" + - "211101112" + +slots: + - item: barrier name:"&cClose" + lore: [ ] + location: + row: 6 + column: 5 + page: 1 # If you don't specify a page, it will be on all pages + + # (Optional) You can specify the layer of the slot. + # The layer can be any of: lower, middle, upper, or top (defaults to middle) + # This is useful if you want to have a slot on top of another slot, and + # have the upper slot show if some conditions are met. + layer: middle + + # Read https://plugins.auxilor.io/effects/configuring-a-condition + # The conditions required to click the item + conditions: [ ] + + # If the item should be shown if the conditions are not met + show-if-not-met: false + + # Read https://plugins.auxilor.io/effects/configuring-an-effect + # The effects ran when the item is clicked + left-click: + - id: send_message + args: + message: "&cYou clicked the close button!" + - id: close_inventory + + - item: player_head head:%player% name:"&f%player%" + location: + row: 1 + column: 5 + page: 1 + + shift-right-click: + - id: open_menu + args: + menu: other_example_menu + + - id: run_command + args: + command: "eco give %player% 100" +``` + +## Understanding all the sections + +**title:** The title of the GUI. + +**command:** The command used to open the GUI. Set to `command: []` for no command. + +**conditions:** Conditions to be met to open the GUI. See [Effects & Conditions](https://plugins.auxilor.io/ecomenus/how-to-make-a-custom-menu#effects-&-conditons) for more info. + +**cannot-open-messages:** Messages to send when conditions are not met. + +**open/close effects:** Effects to be run when the menu is opened or closed. See [Effects & Conditions](https://plugins.auxilor.io/ecomenus/how-to-make-a-custom-menu#effects-&-conditons) for more info. + +**rows:** The amount of rows in the GUI. + +**forwards/backwards-arrow:** The item and location of the navigation arrows. You can disable this by setting **enabled: false**. +##### Pages + +To configure a pattern and mask, read here for more info: [Pages](https://plugins.auxilor.io/all-plugins/pages) +##### Slots + +The items to be displayed in your menu. See [How to make a slot item](https://plugins.auxilor.io/ecomenus/how-to-make-a-slot-item) for more info on creating slots. + +### Effects & Conditions + +The effects section is the core functionality of the action. You can configure effects, conditions, filters, mutators and triggers in this section to run globally or individually. + +Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly. + +For more advanced users or setups, you can configure chains in this section to string together different effects under one trigger. Check out [Configuring an Effect Chain](https://plugins.auxilor.io/effects/configuring-a-chain) for more info. \ No newline at end of file diff --git a/docs/ecomenus/how-to-make-a-slot-item.md b/docs/ecomenus/how-to-make-a-slot-item.md new file mode 100644 index 0000000000..6bf506c27b --- /dev/null +++ b/docs/ecomenus/how-to-make-a-slot-item.md @@ -0,0 +1,73 @@ +--- +title: How to make a custom menu +sidebar_position: 2 +--- +--- + +## Example Slot Item Config + +```yaml +slots: + - item: barrier name:"&cClose" + lore: [ ] + location: + row: 6 + column: 5 + page: 1 # If you don't specify a page, it will be on all pages + + # (Optional) You can specify the layer of the slot. + # The layer can be any of: lower, middle, upper, or top (defaults to middle) + # This is useful if you want to have a slot on top of another slot, and + # have the upper slot show if some conditions are met. + layer: middle + + # Read https://plugins.auxilor.io/effects/configuring-a-condition + # The conditions required to click the item + conditions: [ ] + + # If the item should be shown if the conditions are not met + show-if-not-met: false + + # Read https://plugins.auxilor.io/effects/configuring-an-effect + # The effects ran when the item is clicked + left-click: + - id: send_message + args: + message: "&cYou clicked the close button!" + - id: close_inventory +``` + +## Understanding all the sections + +**item:** The item that is displayed in your menu, read here for more info: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system). + +**lore:** The item lore shown in-game. Set to `lore: []` to remove all lore lines. + +**conditions:** Conditions to be met to click the slot. See [Effects & Conditions](https://plugins.auxilor.io/ecomenus/how-to-make-a-slot-item#effects-&-conditons) for more info. + +**show-if-not-met:** If the item/layer should be shown if conditions are not met (true/false) +#### Location: + +**row/column/page:** The location of this item in the menu. + +**layer:** The priority of the item. The higher the layer, the higher the priority (`lower`, `middle`, `upper`, or `top`). + +#### Clicks +The **effects** run when the item is clicked. See [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect). +`left-click`, `right-click`, `shift-left-click` & `shift-right-click`. + +```yaml + left-click: + - id: send_message + args: + message: "&cYou clicked the close button!" + - id: close_inventory +``` + +### Effects & Conditions + +The effects section is the core functionality of the action. You can configure effects, conditions, filters, mutators and triggers in this section to run globally or individually. + +Check out [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect) to understand how to configure this section correctly. + +For more advanced users or setups, you can configure chains in this section to string together different effects under one trigger. Check out [Configuring an Effect Chain](https://plugins.auxilor.io/effects/configuring-a-chain) for more info. \ No newline at end of file diff --git a/docs/ecomenus/index.md b/docs/ecomenus/index.md new file mode 100644 index 0000000000..dc5ac9bea8 --- /dev/null +++ b/docs/ecomenus/index.md @@ -0,0 +1,18 @@ +--- +title: "EcoMobs" +--- + +## What is EcoMobs? +EcoMobs is a plugin that allows you to make your own custom mobs. +Built to be completely customizable and integrate seamlessly with vanilla gameplay, +you can modify every aspect of the mobs, create spawn totems and eggs to spawn them in, +have them spawn naturally in the world, set effects and properties, rewards, commands, and much, much more. + +It's incredibly easy to configure your own mobs. No more spending hours writing and +debugging complex systems or paying people to make them for you, no subscription model +or overpriced extras - once you buy it, it's yours forever. + +## 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) \ No newline at end of file diff --git a/docs/effects/all-effects/open_menu.md b/docs/effects/all-effects/open_menu.md new file mode 100644 index 0000000000..1dae7fd540 --- /dev/null +++ b/docs/effects/all-effects/open_menu.md @@ -0,0 +1,14 @@ +# `open_menu` +#### Triggered Effect + +Opens an EcoMenu + +**Requires EcoMenus** + +# Example Config +```yaml +- id: open_menu + args: + menu: # The ID of the enchant + ...other config (eg triggers, filters, mutators, etc) +```