Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add require arg #46

Merged
merged 9 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/all-plugins/custom-gui-slots.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 7

## What are custom GUI slots?

When configuring a GUI in a plugin, you might stumble accross this:
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
Expand Down
2 changes: 1 addition & 1 deletion docs/ecoarmor/gameplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ default --> iron --> diamond --> netherite --> manyullyn
ancient --> mythic
```

The main progression goes from default -> manuyullyn, with optional branches. Cobalt and osmium are more tanky, in other words you move slower but deal more damage and take less damage, and exotic makes you more vulnerable however you move faster.
The main progression goes from default -> manyullyn, with optional branches. Cobalt and osmium are more tanky, in other words you move slower but deal more damage and take less damage, and exotic makes you more vulnerable however you move faster.

Ancient and Mythic aren't craftable by default and exist more as a special tier, perfect for crates or drops from bosses.

Expand Down
4 changes: 0 additions & 4 deletions docs/ecobits/commands-and-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ Permission: `ecobits.command.pay`

Permission: `ecobits.command.balance`

## `/<currency> balance` (Get your balance)

Permission: `ecobits.command.balance`

## `/<currency> get` (Get the balance of another player)

Permission: `ecobits.command.get`
Expand Down
3 changes: 1 addition & 2 deletions docs/ecobits/how-to-make-a-shop.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ The default configs can be found here:
## How to add currencies

EcoBits lets you make as many currencies as you want, and you make each one by adding a new
entry to the `currencies` list. Simply add and remove currencies as you please to add and
remore currencies.
entry to the `currencies` list. Simply add and remove currencies as you please.

## Example Currency Config

Expand Down
2 changes: 1 addition & 1 deletion docs/ecobits/placeholderapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ sidebar_position: 3
| `%ecobits_<id>_formatted%` | The formatted amount of the currency a player has |
| `%ecobits_<id>_max%` | The maximum amount of the currency defined in config.yml |
| `%ecobits_<id>_name%` | The name of the currency as specified in config.yml |
| `%ecobits_top_<id>_<position[0-9]>_<name/amount>%` | Allows you to display rankings in the amount of currency players have |
| `%ecobits_top_<id>_<position[0-9]>_<name/amount>%` | Leaderboard placeholder for currency amounts |
2 changes: 1 addition & 1 deletion docs/ecoenchants/advanced-configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Advanced Configuration"
sidebar_position: 7
sidebar_position: 4
---

## Cost Exponent
Expand Down
2 changes: 1 addition & 1 deletion docs/ecoenchants/all-enchantments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "All enchantments"
sidebar_position: 3
sidebar_position: 5
---

A list of all enchantments can be found [here](https://lrcdb.auxilor.io/)
Expand Down
2 changes: 1 addition & 1 deletion docs/ecoenchants/api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "API"
sidebar_position: 9
sidebar_position: 6
---

## Source Code
Expand Down
4 changes: 0 additions & 4 deletions docs/ecoenchants/config-basics.md

This file was deleted.

73 changes: 0 additions & 73 deletions docs/ecoenchants/enchantment-configuration.md

This file was deleted.

40 changes: 38 additions & 2 deletions docs/ecoenchants/how-to-make-a-custom-enchant.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "How to make an enchant"
sidebar_position: 8
sidebar_position: 3
---

## Config Layout

Each enchantment has it's own config file. They are stored in `/enchants/<id>.yml` so for example Telekinesis would be stored in `/enchants/telekinesis.yml`
Each enchantment has its own config file, they are stored in `/enchants/<id>.yml` so for example Telekinesis would be stored in `/enchants/telekinesis.yml`

If you want to add or remove enchantments, just create or delete config files. These config files can be placed anywhere in the `/enchants/` folder, including in subfolders.

Expand All @@ -16,6 +16,8 @@ If you want to add or remove enchantments, just create or delete config files. T
display-name: "Example" # The name of the enchantment in-game
description: "Gives a &a%placeholder%%&8 bonus to damage" # The description of the enchantment
placeholder: "%level% * 20" # The placeholder to show in the enchantment description
placeholders: # [Optional] You can also create multiple placeholders to show in the enchantment description
example: "%level% * 800"
type: normal # The enchantment type, from types.yml

targets: # The items that the enchantment can be applied to, see targets.yml
Expand Down Expand Up @@ -43,3 +45,37 @@ effects:
# you can use %level% as a placeholder here too
conditions: [ ]
```

## Understanding all the sections
**id:** The ID of the enchantment. 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.

**display-name:** The name of the enchantment, displayed in the item lore.

**description:** The enchantment description/lore.

**placeholder:** Custom placeholders to show in the enchantment description.

**type:** The enchantment type, from [types.yml](https://github.com/Auxilor/EcoEnchants/blob/master/eco-core/core-plugin/src/main/resources/types.yml).

**targets:** The items this enchantment can be applied to, from [targets.yml](https://github.com/Auxilor/EcoEnchants/blob/master/eco-core/core-plugin/src/main/resources/targets.yml).

**conflicts:** Any conflicting enchantments. If one is present, the other cannot be.

**rarity:** The rarity of obtaining the enchantment, from [rarity.yml](https://github.com/Auxilor/EcoEnchants/blob/master/eco-core/core-plugin/src/main/resources/rarity.yml).

**max-level:** The maximum obtainable enchantment level.

**tradeable:** If the enchantment can be obtained from villagers.

**discoverable:** If the enchantment can be found in chests and loot tables.

**enchantable:** If the enchantment can be obtained from enchanting tables.

### Effects + Conditions

Effects are the actual functionality of the job, and conditions are requirements that a player must meet for the job to activate for them - so you can make it so a job only works for a certain type of player, ie only players that have above a certain amount of playtime, or those that only have below a certain balance.

See this page for how to configure effects:

[Configuring an Effect](https://plugins.auxilor.io/effects/configuring-an-effect)
4 changes: 2 additions & 2 deletions docs/ecoenchants/the-gameplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Some enchantment types (special by default) are set up with a bias to make it ex

Targets are the items that can be enchanted by any given enchantment. These are things like melee weapons, tools, armor pieces, elytra, fishing rods, etc. You can create your own targets (for example if you want diamond and netherite items to have exclusive enchantments) and edit and delete as many targets as you want.

Check out target.yml here:
Check out targets.yml here:

[GitHub](https://github.com/Auxilor/EcoEnchants/blob/master/eco-core/core-plugin/src/main/resources/target.yml)
[GitHub](https://github.com/Auxilor/EcoEnchants/blob/master/eco-core/core-plugin/src/main/resources/targets.yml)

1 change: 1 addition & 0 deletions docs/ecojobs/placeholderapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ sidebar_position: 3
| `%ecojobs_total_job_level%` | Shows the level of all jobs combined |
| `%ecojobs_limit%` | Shows the max amount of jobs a player can join at once |
| `%ecojobs_in_jobs%` | Shows the amount of jobs a player is currently in |
| `%ecojobs_top_<id>_<position[0-9]>_<name/amount>%` | Leaderboard placeholder for job level |
2 changes: 1 addition & 1 deletion docs/ecopets/commands-and-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Permission: `ecopets.command.activate`

Usage: `/pets activate <pet>`

## `/pets deactivate` (Dectivate a pet)
## `/pets deactivate` (Deactivate a pet)
Permission: `ecopets.command.deactivate`

Usage: `/pets deactivate`
Expand Down
2 changes: 1 addition & 1 deletion docs/ecopets/how-to-make-a-custom-pet.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ xp-gain-methods:

# Custom placeholders to be used in descriptions,
# Don't add % to the IDs, this is done automatically
# The value takes a %level% placeholder and is a mathetmatical expression
# The value takes a %level% placeholder and is a mathematical expression
level-placeholders:
- id: "damage_multiplier"
value: "%level%"
Expand Down
2 changes: 1 addition & 1 deletion docs/ecoshop/how-to-make-a-category.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 3

Categories are how shops are organized. Items are sold / bought in categories, they're
the actual 'shop' part. In the example config, you will have seen how shops can either
be a portal to a bunch of categories, or alteratively just directlylink to a category.
be a portal to a bunch of categories, or alternatively just directly link to a category.

## Default config

Expand Down
2 changes: 1 addition & 1 deletion docs/ecoshop/how-to-make-an-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Of course, you can't sell a command, so they're buy-only.
```yaml
id: iron_rank

command: #I Changed the commands: to command: because it doesnt work with an "s"
command: # I Changed the commands: to command: because it doesn't work with an "s"
- lp user %player% parent set iron

buy:
Expand Down
4 changes: 2 additions & 2 deletions docs/ecoskills/effects.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Effects are special abilities given to a player. They are levelled up by levelli
| Serrated Strikes | Increases chance to cause your opponent to bleed, damaging them repeatedly |
| Seamless Movement | Increases chance to ignore fall damage |
| Potionmaster | Brewed potions last longer |
| Shamanism | Increases the speed at which you regain helath |
| Shamanism | Increases the speed at which you regain health |
| Craftsmanship | Take less durability damage on axes |
| Second Chance | Chance to instantly fix items on low durability |
| Efficient Brewing | Decreases the time taken to brew potions |
Expand All @@ -30,7 +30,7 @@ Effects are special abilities given to a player. They are levelled up by levelli
| Strong Impact | Small chance to deal 3x damage |
| Endangering | Chance to remove your opponents invulnerability frame |
| Spelunking | Chance to get extra drops from ores |
| Dynamic MIning | Chance to get a short burst of Haste III while mining |
| Dynamic Mining | Chance to get a short burst of Haste III while mining |
| Reimbursement | Chance to get given back xp levels after enchanting an item |
| Overcompensation | Chance to get given back lapis after enchanting |
| Magnetic Rod | Increases fishing speed |
Expand Down
2 changes: 1 addition & 1 deletion docs/ecoskills/magic.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Magic"
sidebar_position: 5
---

Magics are an optional feature in EcoSkills that provide the ability to create naturally regnerating
Magics are an optional feature in EcoSkills that provide the ability to create naturally regenerating
amounts of things like Mana, which can then be used in other plugins, for example in EcoItems items,
or EcoEnchants enchantments.

Expand Down
1 change: 1 addition & 0 deletions docs/ecoskills/placeholderapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ sidebar_position: 6
| `%ecoskills_<skill>_percentage_progress%` | Shows the percentage progress until the next skill level |
| `%ecoskills_<skill>_current_xp%` | Shows the current skill XP |
| `%ecoskills_<skill>_required_xp%` | Shows the skill XP required for the next level |
| `%ecoskills_top_<id>_<position[0-9]>_<name/amount>%` | Leaderboard placeholder for skill level |
2 changes: 1 addition & 1 deletion docs/effects/all-conditions/at_least_of.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `at_least_of`

Requires a leat a certain mount of a certain list of conditions to be met
Requires at least a certain mount of a certain list of conditions to be met

# Example Config
```yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/effects/all-effects/hunger_multiplier.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Multiplies hunger loss

# Example Config
```yaml
- id: hunger_multplier
- id: hunger_multiplier
args:
multiplier: 0.5 # The multiplier for hunger loss, smaller means slower loss
```
2 changes: 1 addition & 1 deletion docs/effects/all-effects/particle_animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Plays a particle animation
|-----------------|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `trace` | Draw a line from the location to the player | `spacing` The spacing between particles |
| `ground_spiral` | Create a spiral of particles on the ground | `scalar` The x/y scalar <br/> `distance-scalar` The distance scalar <br/> `duration` The duration of the animation, in ticks |
| `circle` | Draw a circle of particles | `radius` The circle's radius <br/> `duration` The time taken to draw the circle, in ticks <br/> `height` The height above the location to draw the cricle <br/> `pitch` The circle's pitch (in degrees) <br/> `roll` The roll of the circle (in degrees) |
| `circle` | Draw a circle of particles | `radius` The circle's radius <br/> `duration` The time taken to draw the circle, in ticks <br/> `height` The height above the location to draw the circle <br/> `pitch` The circle's pitch (in degrees) <br/> `roll` The roll of the circle (in degrees) |
| `helix` | Draw a helix of particles | `height` The height to draw the helix <br/> `duration` The time taken to draw the helix, in ticks <br/> `speed` The speed at which to draw the helix <br/> `radius` The radius of the helix |
| `double_helix` | Draw a double helix of particles | `height` The height to draw the helix <br/> `duration` The time taken to draw the helix, in ticks <br/> `speed` The speed at which to draw the helix <br/> `radius` The radius of the helix |
| `twirl` | Twirl particles (double expanding spiral) | `small-radius` The small radius <br/> `large-radius` The large radius <br/> `duration` The animation duration, in ticks <br/> `start-height` The start height <br/> `end-height` The end height <br/> `speed` The speed at which to draw the animation |
Expand Down
Loading
Loading