Skip to content

Commit

Permalink
Merge branch 'master' into votifier_support
Browse files Browse the repository at this point in the history
  • Loading branch information
WillFP authored Jul 3, 2024
2 parents f3c7831 + d69c9fe commit 171be63
Show file tree
Hide file tree
Showing 25 changed files with 227 additions and 20 deletions.
11 changes: 9 additions & 2 deletions docs/all-plugins/the-item-lookup-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You can specify the amount of any item by having a space and then a number (the
When using exact item NBT, you can't use `?`. `||`, or other modifiers.

## Modifiers
Items can have modifiers applied to them in the key. 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 of my plugins, wherever it asks for a material, it's actually doing a lookup. You can specify any of the following modifiers to it:
Items can have modifiers applied to them in the key. 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 specify an enchantment by adding `<enchantment>:<level>` to the key, and you can chain these together
- **Skull Texture:** If the material is a player head, you can specify the texture with `texture:<base64>`. 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:<name>`. You can also use placeholders, e.g. `head:%player%`
Expand All @@ -49,10 +49,17 @@ Items can have modifiers applied to them in the key. For example, lets say you'r
- **Item Flags:** You can specify flags for the item to have, by dropping in any of [these values](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemFlag.html) (not case sensitive)
- **Unbreakable:** You can make an item unbreakable by having the word `unbreakable` in the flags
- **Custom Model Data:** You can specify custom model data with `custom-model-data:<id>`
- **Armor Trims:** You can specify armor trims with `trim:<material>:<pattern>`, e.g. `trim:emerald:snout`
- **Spawner Entity:** You can specify the spawner entity with `entity:<id>`
- **Leather Armor Color:** You can specify the leather armor color with `color:#hex`, e.g. `color:#303030`

These modifiers are only available on Paper 1.21+:
- **Armor Trims:** You can specify armor trims with `trim:<material>:<pattern>`, e.g. `trim:emerald:snout`
- **Fire Resistance:** You can make an item fire resistant with `fire_resistant`
- **Enchantment Glint:** You can give an enchantment glint with `glint`
- **Item Name:** You can set the item name (different to display name) with `item_name:<name>`
- **Durability:** You can set the item durability with `max_damage:<durability>`
- **Stack Size:** You can set the max stack size with `max_stack_size:<size>`

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 from my other plugins
Expand Down
1 change: 1 addition & 0 deletions docs/all-plugins/what-plugins-do-you-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,4 @@ If a plugin isn't on this list, it doesn't mean it wont work, it just means that
- CustomCrafting
- Model Engine
- NuVotifier
- AxEnvoy
10 changes: 6 additions & 4 deletions docs/ecoquests/how-to-make-a-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ description: "&fBreak stone blocks (&a%xp%&8/&a%required-xp%&f)" # The descripti
# The 'multiplier' takes the value produced by the trigger and multiplies it
# Alternatively, you can use 'value' to count a specific number and not a multiplier
xp-gain-methods:
- trigger: mine_block # See list of triggers: https://plugins.auxilor.io/effects/all-triggers
multiplier: 1 # You can also use "value" here (see above comment)
filters: # (Optional) Example of using filters in tasks
- trigger: mine_block
multiplier: 0.5 # You can also use "value" here (see above comment)
args: # (Optional)
chance: 50
filters: # (Optional)
blocks:
- stone
- netherrack

# An optional list of effects to run when a player completes the task
# Read here: https://plugins.auxilor.io/effects/configuring-an-effect
Expand Down
24 changes: 17 additions & 7 deletions docs/ecoskills/how-to-make-a-skill.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,22 @@ rewards:
levels: 1
every: 1

# Effects to run when an item levels up
# %level% is the level the item leveled up to.
# Effects to run when the skill levels up
# %level% is the level the skill leveled up to.
# If you want to restrict this to certain levels, you can use
# require: %level% = 20, or require: %level% < 50, etc.
# If you want a reward to run every x levels, you can use
# every: 1, or every: 12, etc
level-up-effects:
- id: give_money
args:
amount: 1000 * %level%
- id: give_item
args:
items:
- diamond
every: 5 # Gives the reward every 5 levels
require: %level% = 5 # Requires level 5 before receiving rewards

# Custom placeholders to be used in descriptions,
# Don't add % to the IDs, this is done automatically
Expand Down Expand Up @@ -166,17 +174,19 @@ reward-messages:
- " &8» &r&6%ecoskills_dynamic_mining_name% %ecoskills_dynamic_mining_numeral%"
- " %ecoskills_dynamic_mining_description%"

# An XP gain method takes a trigger, a multiplier, conditions, and filters.
# An XP gain method takes a trigger, a multiplier, conditions, args and filters.
# The 'multiplier' takes the value produced by the trigger and multiplies it
# Alternatively, you can use 'value' to count a specific number and not a multiplier
xp-gain-methods:
- trigger: break_block
- trigger: mine_block
multiplier: 0.5 # You can also use "value" here (see above comment)
filters:
args: # (Optional)
chance: 50
filters: # (Optional)
blocks:
- netherrack

- trigger: break_block
- trigger: mine_block
multiplier: 1
filters:
blocks:
Expand Down Expand Up @@ -228,7 +238,7 @@ level-up-effects:

**reward-messages:** Messages to send in chat on level up.

**xp-gain-methods:** The trigger, multiplier/value, conditions and filters that will award skill XP.
**xp-gain-methods:** The trigger, multiplier/value, conditions, args and filters that will award skill XP.

**conditions:** Global conditions that must be met to gain skill XP. See [Configuring a Condition](https://plugins.auxilor.io/effects/configuring-a-condition).

Expand Down
8 changes: 8 additions & 0 deletions docs/effects/all-conditions/is_alive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# `is_alive`

Requires the player to be alive

# Example Config
```yaml
- id: is_alive
```
8 changes: 8 additions & 0 deletions docs/effects/all-conditions/is_submerged.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# `is_submerged`

Requires a player to be fully submerged in liquid

# Example Config
```yaml
- id: is_submerged
```
1 change: 1 addition & 0 deletions docs/effects/all-conditions/near_entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Requires a player to be within a certain radius of an entity
- zombie
- ecomobs:illusioner
radius: 25 # The radius
amount: 5 # (Optional) The minimum amount of listed entities
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/block_reach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `block_reach`
#### Permanent Effect

Adds reach for interacting with blocks

**Requires 1.21+**

# Example Config
```yaml
- id: block_reach
args:
reach: 1 # The extra block reach
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/entity_reach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `entity_reach`
#### Permanent Effect

Adds reach for interacting with entities

**Requires 1.21+**

# Example Config
```yaml
- id: entity_reach
args:
reach: 1 # The extra entity reach
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/gravity_multiplier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `gravity_multiplier`
#### Permanent Effect

Multiplies gravity

**Requires 1.21+**

# Example Config
```yaml
- id: gravity_multiplier
args:
multiplier: 0.5 # The multiplier for gravity
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/increase_step_height.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `increase_step_height`
#### Permanent Effect

Increases the amount of blocks you can walk over without jumping

**Requires 1.21+**

# Example Config
```yaml
- id: increase_step_height
args:
height: 1 # The extra step height
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/jump_strength_multiplier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `jump_strength_multiplier`
#### Permanent Effect

Multiplies jump strength

**Requires 1.21+**

# Example Config
```yaml
- id: jump_strength_multiplier
args:
multiplier: 2.1 # The multiplier for jump strength
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/mining_efficiency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `mining_efficiency`
#### Permanent Effect

Adds mining efficiency (mining speed when using the correct tool)

**Requires 1.21+**

# Example Config
```yaml
- id: mining_efficiency
args:
amount: 5 # The extra mining efficiency
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/mining_speed_multiplier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `mining_speed_multiplier`
#### Permanent Effect

Multiplies mining speed

**Requires 1.21+**

# Example Config
```yaml
- id: mining_speed_multiplier
args:
multiplier: 1.1 # The multiplier for mining speed
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/movement_efficiency_multiplier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `movement_efficiency_multiplier`
#### Permanent Effect

Multiplies movement speed through difficult terrain

**Requires 1.21+**

# Example Config
```yaml
- id: movement_efficiency_multiplier
args:
multiplier: 1.5 # The multiplier for movement efficiency
```
12 changes: 12 additions & 0 deletions docs/effects/all-effects/rotate_victim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# `rotate_victim`
#### Triggered Effect

Spin the victim around

# Example Config
```yaml
- id: rotate_victim
args:
angle: 180 # The angle to rotate / spin (in degrees)
...other config (eg triggers, filters, mutators, etc)
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/safe_fall_distance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `safe_fall_distance`
#### Permanent Effect

Increases/decreases the distance you can fall without taking damage

**Requires 1.21+**

# Example Config
```yaml
- id: safe_fall_distance
args:
distance: 10.5 # The extra distance
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/sneaking_speed_multiplier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `sneaking_speed_multiplier`
#### Permanent Effect

Multiplies sneaking speed

**Requires 1.21+**

# Example Config
```yaml
- id: sneaking_speed_multiplier
args:
multiplier: 2 # The multiplier for sneaking speed
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/underwater_mining_speed_multiplier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `underwater_mining_speed_multiplier`
#### Permanent Effect

Multiplies underwater mining speed

**Requires 1.21+**

# Example Config
```yaml
- id: underwater_mining_speed_multiplier
args:
multiplier: 2 # The multiplier for underwater mining speed
```
12 changes: 12 additions & 0 deletions docs/effects/all-filters/envoy_type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# `envoy_type`

The list of envoy types that the effect should activate against

**Requires AxEnvoy**

# Example Config
```yaml
filters:
envoy_type:
- common # The ID of the crate type (axenvoy/crates/<id>.yml)
```
2 changes: 1 addition & 1 deletion docs/effects/all-filters/value_below.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `value_above`
# `value_below`

Require the trigger value to be less than a certain amount

Expand Down
5 changes: 3 additions & 2 deletions docs/effects/all-triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ and are used in plugins like EcoSkills, EcoPets, EcoJobs (etc) for levelling.
| `change_world` | Triggered when changing world | 1 |
| `click_block` | Triggered when right-clicking on a block | 1 |
| `click_entity` | Triggered when right-clicking on an entity | 1 |
| `collect_envoy` | Triggered when collecting an envoy crate **Requires AxEnvoy** | 1 |
| `complete_advancement` | Triggered when completing an advancement | 1 |
| `complete_quest` | Triggered when completing a quest **Requires EcoQuests** | 1 |
| `complete_task` | Triggered when completing a task **Requires EcoQuests** | 1 |
| `consume` | Triggered on item consumption | 1 |
| `craft` | Triggered when crafting an item | 1 |
| `craft` | Triggered when crafting an item | The amount of items crafted |
| `damage_item` | Triggered when damaging an item | The damage |
| `death` | Triggered on death from any sources | 1 |
| `disable` | Triggered when an item / enchant / etc disables | 1 |
Expand Down Expand Up @@ -118,6 +119,6 @@ and are used in plugins like EcoSkills, EcoPets, EcoJobs (etc) for levelling.
| `toggle_flight` | Triggered when changing the flight state | 1 |
| `toggle_sneak` | Triggered when changing the sneak state | 1 |
| `toggle_sprint` | Triggered when changing the sprint state | 1 |
| `trident_attack` | Triggered on injuring an entity with a thrown trident | The damage dealt |
| `trident_attack` | Triggered on injuring an entity with a thrown trident **Requires Paper** | The damage dealt |
| `villager_trade` | Triggered when trading with a villager **Requires Paper** | The experience the villager gains |
| `win_raid` | Triggered when a player wins a raid | The level of bad omen |
1 change: 1 addition & 0 deletions docs/effects/configuring-an-effect.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ The cooldown between effect activations, in seconds. (defaults to 0)
```yaml
args:
cooldown: 10
cooldown_group: magic_abilities # (Optional) The cooldown group, if not specified the cooldown will be for this effect only
send_cooldown_message: true # (Optional) If the cooldown message should be sent
cooldown_message: "Custom cooldown message with %seconds% left" # (Optional) a custom cooldown message
cooldown_effects: # (Optional) Effects to run if on cooldown
Expand Down
6 changes: 5 additions & 1 deletion docs/effects/points.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,18 @@ Points are similar to currencies, however they exist purely as a way to keep tra
You can have as many different points as you want, the plugins will keep track of them automatically. Points are shared between plugins, too - so if you make a point in EcoItems, then you can use it in EcoPets, EcoJobs, etc.

A point can hold any numeric value, including negatives and decimals, but of course how you decide to use them is completely up to you.

## Point Types

| Point Type | Placeholder | Description |
| ------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Points | `%libreforge_points_<point>%` | A general point that can be used to keep track of something per-player. (e.g. times jumped, zombies killed, etc.) |
| Global Points | `%libreforge_global_points_<point>%` | A general point that keeps track of something globally/server-wide for all players. (e.g. zombies killed by all players.) |
| Item Points | `%libreforge_item_points_<point>%` | A point that is tied to a specific item and tracks data on the item. Useful for making tools with custom durability's or per-item stats (e.g zombies killed using this sword.) |

## Commands
## `/libreforge points set/give/get/take`

Usage: `/libreforgepoints give <player> <point> <value>`
Usage: `/libreforge points give <player> <point> <value>`

To change global points, pass `global` as the player name.
3 changes: 0 additions & 3 deletions docs/home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ slug: /
sidebar_position: 1
---

## Want to try out the plugins?
My server, `play.ecomc.net`, runs all the eco plugins so you can see how they integrate with your server and each other. Have a look around!

## 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)

Expand Down

0 comments on commit 171be63

Please sign in to comment.