Skip to content

Commit

Permalink
Fixed short links
Browse files Browse the repository at this point in the history
  • Loading branch information
Exanthiax committed Mar 14, 2024
1 parent 4993948 commit dc61171
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 33 deletions.
4 changes: 2 additions & 2 deletions docs/boosters/how-to-make-a-custom-booster.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ You can find additional user-created configs on [lrcdb](https://lrcdb.auxilor.io

## Config Layout

Each action has its own config file, placed in the `/boosters/` folder, and you can add or remove them as you please. There's an example config called `_example.yml` to help you out!
Each booster has its own config file, placed in the `/boosters/` 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 Booster 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).
The ID of the booster 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 Booster Config
Expand Down
4 changes: 2 additions & 2 deletions docs/ecoquests/how-to-make-a-quest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Each quest is its own config file, placed in the `/quests/` folder, and you can
The ID of the Quest is the file name. This is what you use in commands and placeholders.
ID's must be lowercase letters, numbers, and underscores only.

Quests are made up of specific [[how-to-make-a-task|tasks]], and when all tasks are completed the quest will complete, giving the player rewards!
Quests are made up of specific [tasks](https://plugins.auxilor.io/ecoquests/how-to-make-a-task), and when all tasks are completed the quest will complete, giving the player rewards!

## Example Quest Config

Expand Down Expand Up @@ -96,7 +96,7 @@ tasks:

**start-effects:** Effects to be run when the quest is started (Supports triggered effects). See [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect)

**start-conditions:** Conditions that must be met for the quest to start. See [[configuring-a-condition|Configuring a Condition]].
**start-conditions:** Conditions that must be met for the quest to start. See [Configuring a Condition](https://plugins.auxilor.io/effects/configuring-a-condition).

**auto-start:** If the quest should start automatically when the conditions are met.

Expand Down
2 changes: 1 addition & 1 deletion docs/ecoquests/how-to-make-a-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Each task is its own config file, placed in the `/tasks/` folder, and you can ad
The ID of the Task is the file name. This is what you use in quests and placeholders.
ID's must be lowercase letters, numbers, and underscores only.

Tasks are the goals that players must complete in order to complete [[how-to-make-a-quest|quests]].
Tasks are the goals that players must complete in order to complete [quests](https://plugins.auxilor.io/ecoquests/how-to-make-a-quest).

## Example Task Config

Expand Down
6 changes: 3 additions & 3 deletions docs/ecoshop/how-to-make-a-category.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3

## Categories

Categories are how shops are organised. Items are sold / bought in categories, they're the actual 'shop' part. In the [[how-to-make-a-shop|How to make a Shop]] section, you will have seen how shops can either be a portal to a bunch of categories, or alternatively just directly link to a category.
Categories are how shops are organised. Items are sold / bought in categories, they're the actual 'shop' part. In the [How to make a Shop](https://plugins.auxilor.io/ecoshop/how-to-make-a-shop) section, you will have seen how shops can either be a portal to a bunch of categories, or alternatively just directly link to a category.

## Default config
The default configs can be found [here](https://github.com/Auxilor/EcoShop/blob/main/eco-core/core-plugin/src/main/resources/categories).
Expand Down Expand Up @@ -101,10 +101,10 @@ items:

To configure a pattern and mask, read here for more info:

**custom-slots:** Any non-shop items for the GUI (eg. info items), read here for more info: [[custom-gui-slots|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/custom-gui-slots).

### Items

This section is where you put any items that you are buying and/or selling in this category.

Read here for more info on creating your shop items: [[how-to-make-an-item|How to make an Item]].
Read here for more info on creating your shop items: [How to make an Item](how-to-make-an-item).
4 changes: 2 additions & 2 deletions docs/ecoshop/how-to-make-a-shop.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "How to make a shop"
sidebar_position: 2
---
## Shops
Creating shops is easy if you follow the the basic rules: A shop requires [[how-to-make-a-category|categories]], and categories require [[how-to-make-an-item|items]].
Creating shops is easy if you follow the the basic rules: A shop requires [categories](https://plugins.auxilor.io/ecoshop/how-to-make-a-category), and categories require [items](https://plugins.auxilor.io/ecoshop/how-to-make-an-item).

## Default config
The default configs can be found [here](https://github.com/Auxilor/EcoShop/blob/main/eco-core/core-plugin/src/main/resources/shops).
Expand Down Expand Up @@ -114,7 +114,7 @@ pages: # All the pages in the preview GUI. You can add as many pages as you want
### Configuring Categories
There are two methods to add [[how-to-make-a-category|categories]], first is a direct and second is a list.
There are two methods to add [categories](https://plugins.auxilor.io/ecoshop/how-to-make-a-category), first is a direct and second is a list.
#### Direct Category
Expand Down
35 changes: 18 additions & 17 deletions docs/ecoshop/how-to-make-an-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ sidebar_position: 4
## Items
Items are everything that can be bought or sold in the shop. They can be real items or commands, single-purchase, limited purchase, buy only, sell only, both, they can be bought with 2 different currency types - the point is, there's a lot of options to wrap your head around.

These items go into your category config, read here for more into: [[how-to-make-a-category|How to make a Category]]
These items go into your category config, read here for more into: [categories](https://plugins.auxilor.io/ecoshop/how-to-make-a-category).

## How to add items

### Simple buy-sell item
Expand All @@ -33,25 +34,25 @@ gui:
#### Understanding all the sections
`id`: This is the internal ID of the item. Players don't see this, but it's important
**id:** This is the internal ID of the item. Players don't see this, but it's important
to use a unique ID for every item in all of your shops. This is used in commands, placeholders and referencing the item
`item`: This is the actual item we're selling, read here for more info: [[the-item-lookup-system|Item Lookup System]].
**item:** This is the actual item we're selling, read here for more info: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system).
##### Buy (Optional)
**type/value/display:** This is standard configuration of prices, read here for more info: [[prices|Price]]. Prices are configured per-item.
**type/value/display:** This is standard configuration of prices, read here for more info: [Prices](https://plugins.auxilor.io/all-plugins/prices). Prices are configured per-item.
**amount:** (Optional) The amount of items to be bought at once. Defaults to 1.
##### Sell
**type/value/display:** This is standard configuration of prices, read here for more info: [[prices|Price]]. Prices are configured per-item.
**type/value/display:** This is standard configuration of prices, read here for more info: [Prices](https://plugins.auxilor.io/all-plugins/prices). Prices are configured per-item.
##### GUI
**row/column/page:** The location of this item in the shop
### Command Items
Sometimes you want to run a command when a player buys an item, such as giving permissions/ranks/items from other plugins not currently supported in [[the-item-lookup-system|Item Lookup System]].
Sometimes you want to run a command when a player buys an item, such as giving permissions/ranks/items from other plugins not currently supported in the [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system).
Of course, you can't sell a command, so they're buy-only.
Expand Down Expand Up @@ -82,18 +83,18 @@ gui:
#### Understanding all the sections
`id`: This is the internal ID of the item. Players don't see this, but it's important
**id:** This is the internal ID of the item. Players don't see this, but it's important
to use a unique ID for every item in all of your shops. This is used in commands, placeholders and referencing the item
`command`: This is the command to be run when a player buys this item. You can use `%player%` and `%amount%` as placeholders.
**command:** This is the command to be run when a player buys this item. You can use `%player%` and `%amount%` as placeholders.
##### Buy

**type/value/display:** This is standard configuration of prices, read here for more info: [[prices|Price]]. Prices are configured per-item.
**type/value/display:** This is standard configuration of prices, read here for more info: [Prices](https://plugins.auxilor.io/all-plugins/prices). Prices are configured per-item.

**limit:** (Optional) The max amount of times a player can buy this item.
##### GUI

**display.item:** This is the item shown in the GUI, read here for more info: [[the-item-lookup-system|Item Lookup System]].
**display.item:** This is the item shown in the GUI, read here for more info: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system).

**display.lore:** This is the lore shown on the item.

Expand Down Expand Up @@ -128,24 +129,24 @@ gui:

#### Understanding all the sections

`id`: This is the internal ID of the item. Players don't see this, but it's important
**id:** This is the internal ID of the item. Players don't see this, but it's important
to use a unique ID for every item in all of your shops. This is used in commands, placeholders and referencing the item

`effects`: These are the effects that are ran when the player buys the item. Read here for more info: [[configuring-an-effect|Configuring an Effect]]. **Only Triggered Effects**.
**effects:** These are the effects that are ran when the player buys the item. Read here for more info: [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect). **Only Triggered Effects**.
##### Buy

**type/value/display:** This is standard configuration of prices, read here for more info: [[prices|Price]]. Prices are configured per-item.
**type/value/display:** This is standard configuration of prices, read here for more info: [Prices](https://plugins.auxilor.io/all-plugins/prices). Prices are configured per-item.

**limit:** (Optional) The max amount of times a player can buy this item.
##### GUI

**display.item:** This is the item shown in the GUI, read here for more info: [[the-item-lookup-system|Item Lookup System]].
**display.item:** This is the item shown in the GUI, read here for more info: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system).

**row/column/page:** The location of this item in the shop

## Alt-Buy

EcoShop supports buying items with multiple currencies using the `alt-buy` options. All the options that work with `buy` also apply to `alt-buy`. These are configured the same way, using the [[prices|price]] system.
EcoShop supports buying items with multiple currencies using the `alt-buy` options. All the options that work with `buy` also apply to `alt-buy`. These are configured the same way, using the [price](https://plugins.auxilor.io/all-plugins/prices) system.

```yaml
alt-buy:
Expand All @@ -169,7 +170,7 @@ buy:

#### `conditions`

Any conditions that must be met to buy the item. Read here for more info: [[configuring-a-condition|Configuring a Condition]].
Any conditions that must be met to buy the item. Read here for more info: [Configuring a Condition](https://plugins.auxilor.io/effects/configuring-a-condition).

```yaml
buy:
Expand Down Expand Up @@ -237,7 +238,7 @@ buy:
```
#### `conditions`

Any conditions that must be met to sell the item. Read here for more info: [[configuring-a-condition|Configuring a Condition]].
Any conditions that must be met to sell the item. Read here for more info: [Configuring a Condition](https://plugins.auxilor.io/effects/configuring-a-condition).

```yaml
sell:
Expand Down
4 changes: 2 additions & 2 deletions docs/ecoskills/how-to-configure-magic.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ join-on-full: true
**join-on-full:** If the player's magic should be full when they join the server (true/false).
## Using Magic in Effects
You can use your magic in other plugins by utilizing the [[prices|price]] system.
You can use your magic in other plugins by utilising the [price](https://plugins.auxilor.io/all-plugins/prices) system.
### Optional Effect Arguments
You can use optional effect arguments to use magic in your effects:
Expand All @@ -60,7 +60,7 @@ args:
The price required to use or activate this effect.

This supports all known prices: supports money, items, points, second currencies, etc.
Read more about the system here: https://plugins.auxilor.io/all-plugins/prices
Read more about the system here: [Prices](https://plugins.auxilor.io/all-plugins/prices)

Looks like this in config:

Expand Down
12 changes: 9 additions & 3 deletions docs/ecoskills/how-to-make-a-skill.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ xp-requirements:
**xp-formula:** A formula to calculate XP requirements for each level.
**max-level:** The maximum level for the skill (Optional).
**rewards:** The rewards given on level up - must be [[how-to-make-a-stat]] or [[effects]]. See below for more info.
**rewards:** The rewards given on level up - must be [stats](https://plugins.auxilor.io/ecoskills/how-to-make-a-stat) or [effects](https://plugins.auxilor.io/ecoskills/how-to-make-an-effect). See below for more info.
**level-up-effects:** Effects to run when the skill is levelled up (Supports triggered effects). See [Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect).
Expand All @@ -221,20 +221,26 @@ xp-requirements:
**xp-gain-methods:** The trigger, multiplier/value, conditions and filters that will award skill XP.
**conditions:** Global conditions that must be met to gain skill XP. See [[configuring-a-condition|Configuring a Condition]].
**conditions:** Global conditions that must be met to gain skill XP. See [Configuring a Condition](https://plugins.auxilor.io/effects/configuring-a-condition).
### GUI
**enabled:** If the skill should show in /skills.
**icon:** The item to show in /skills, read here for more: [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system).
**lore:** The lore to show in /skills when hovering the icon.
**position:** The location of the icon in /skills, using row and column numbers.
### Rewards
**reward:** The ID of the [[how-to-make-a-stat]] or [[effects]].
**reward:** The ID of the [stat](https://plugins.auxilor.io/ecoskills/how-to-make-a-stat) or [effect](https://plugins.auxilor.io/ecoskills/how-to-make-an-effect).
**levels:** The amount of levels to give the stat or effect.
**start-level:** (Optional) The skill level to start giving the stat or effect (inclusive).
**end-level:** (Optional) The skill level to stop giving the stat or effect (inclusive).
### Effects & Conditions
Expand Down
2 changes: 1 addition & 1 deletion docs/effects/configuring-an-effect.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ args:
The price required to use or activate this effect.

This supports all known prices: supports money, items, points, second currencies, etc.
Read more about the system here: https://plugins.auxilor.io/all-plugins/prices
Read more about the system here: [Prices](https://plugins.auxilor.io/all-plugins/prices)

Looks like this in config:

Expand Down

0 comments on commit dc61171

Please sign in to comment.