EcoSkills

https://plugins.auxilor.io/ecoskills/
Admin
EcoSkills is a Minecraft plugin that provides a customizable skill system with stats, effects, and...
Tokens:5,654
Snippets:28
Trust Score:5.8
Update:11 months ago
Show doc for...
Tokens:
Raw
### Example Magic Type Configuration (YAML)

Source: https://plugins.auxilor.io/ecoskills/how-to-configure-magic

An example configuration file for a magic type in EcoSkills. It defines the display name, regeneration rate, player limit, and initial state upon joining.

```yaml
name: "&#40ffe6🌊 Mana"  

# The rate at which the magic type regenerates per second  
regen-rate: "0.02 * %ecoskills_mana_limit%"  

# The maximum amount of this type a player can have  
limit: "100 + %ecoskills_wisdom%"  

# If players should join with full magic (true) or empty magic (false)  
join-on-full: true  

```

--------------------------------

### Example Skill Configuration (YAML) - Auxilor Ecoskills

Source: https://plugins.auxilor.io/ecoskills/how-to-make-a-skill

This is an example YAML configuration file for a custom skill in Auxilor Ecoskills. It defines the skill's name, description, GUI settings, XP requirements, rewards, level-up effects, and custom placeholders. The configuration allows for detailed customization of skill behavior and presentation.

```yaml
name: Mining # The display name of the skill
description: Break blocks to earn XP # The description of the skill

# Options for the GUI
gui:
  enabled: true # (Optional) If this skill should be shown in the GUI
  icon: player_head texture:"eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZmIxYzI2OGVmZWM4ZDdkODhhMWNiODhjMmJmYTA5N2ZhNTcwMzc5NDIyOTlmN2QyMDIxNTlmYzkzY2QzMDM2ZCJ9fX0="
  lore:
    - "&fImproves Stats:"
    - "&8» &r%ecoskills_defense_name%"
    - "&8» &r%ecoskills_ferocity_name%"
    - "&f"
    - "&fEffects:"
    - "&8» &r&6%ecoskills_versatile_tools_name% %ecoskills_versatile_tools_numeral%"
    - "   %ecoskills_versatile_tools_description%"
    - "&8» &r&6%ecoskills_spelunking_name% %ecoskills_spelunking_numeral%"
    - "   %ecoskills_spelunking_description%"
    - "&8» &r&6%ecoskills_dynamic_mining_name% %ecoskills_dynamic_mining_numeral%"
    - "   %ecoskills_dynamic_mining_description%"
  position:
    row: 3
    column: 3

hide-before-level-1: true # If this skill should be hidden before level 1

# There are two ways to specify level XP requirements:
#  1. A formula to calculate for infinite levels
#  2. A list of XP requirements for each level

# Formula
# xp-formula: (2 ^ %level%) * 25
# max-level: 100 # (Optional) The max level, if not specified, there is no max level

# List
xp-requirements:
  - 50
  - 125
  - 200
  - 300
  - 500
  - 750
  - 1000
  - 1500
  - 2000
  - 3500
  - 5000
  - 7500
  - 10000

# The rewards given on level up
# You specify a reward (either a stat or an effect),
# the number of levels to give it, and optionally
# a start and end level, which are inclusive.

# An example reward config:
# - reward: strength
#   levels: 1
#   start-level: 10
#   end-level: 20
#   every: 2

rewards:
  - reward: defense
    levels: 2

  - reward: ferocity
    levels: 1
    start-level: 15

  - reward: versatile_tools
    levels: 1

  - reward: spelunking
    levels: 1
    start-level: 10

  - reward: dynamic_mining
    levels: 1
    every: 2

# 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
# The value takes a %level% placeholder and is a mathematical expression
placeholders:
  money: "%level% * 0.4"
  blocks: "ceil(10 - %level% / 10)"

# The chat messages to send on level up,
# and the lore that will be shown with %rewards% in the GUI

# The number dictates the minimum level for this text to show for

```

--------------------------------

### Example Stat Configuration (YAML)

Source: https://plugins.auxilor.io/ecoskills/how-to-make-a-stat

This YAML configuration defines a custom stat named 'Saturation' for the EcoSkills plugin. It includes display name, placeholder for the description, the description itself, optional GUI settings, and effects tied to the stat's level. The example demonstrates how to implement a hunger reduction effect that scales with the player's stat level.

```yaml
name: "&#f5aa42🍖 Saturation" # The name of the stat, shown to players
placeholder: "%level% / 3" # The placeholder to be shown in the description, you can use expressions - eg %level% * 2
description: "&8Lose &a%placeholder%%&8 less hunger" # The description to be shown in lore and messages

# Options for the stat in the GUI
gui:
  enabled: false # (Optional) If the stat should show up in the GUI
  icon: player_head texture:"eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZDMzZGRiOTJjYjZiM2E3OTI4MGI4YmRjZWQ4OTc2YWVhYjEzYTRiZmZlYWVmMmQ0NmQ4MjhiZDkxZGVlMGYzZSJ9fX0="
  position:
    row: 5
    column: 5

# The effects of the stat (i.e. the functionality)
# See here: https://plugins.auxilor.io/effects/configuring-an-effect
# Use %level% as a placeholder for the stat level
effects:
  - id: hunger_multiplier
    args:
      multiplier: "1 - (%level% / 300)"

# The conditions required for the effects to activate,
you can use %level% as a placeholder here too
conditions: [ ]

```

--------------------------------

### Using Magic Cost in Effect Arguments (YAML)

Source: https://plugins.auxilor.io/ecoskills/how-to-configure-magic

Demonstrates how to specify a magic cost, such as Mana, required for an effect in EcoSkills configuration.

```yaml
args:  
  mana_cost: 10  

```

--------------------------------

### Using General Price as Magic Cost (YAML)

Source: https://plugins.auxilor.io/ecoskills/how-to-configure-magic

Shows how to define a general price for an effect that uses a specific magic type (e.g., Mana) as its currency, including display formatting.

```yaml
args:  
  price:  
    value: 100 * %v%  
    type: mana  
    display: "&#40ffe6%value% 🌊 Mana"  

```

--------------------------------

### Example Effect Configuration in YAML

Source: https://plugins.auxilor.io/ecoskills/how-to-make-an-effect

This YAML configuration defines a custom 'Midas Touch' effect for Ecoskills. It specifies the effect's name, how its level progresses, its in-game description, and the functional logic for when a player mines a block, granting them in-game currency.

```yaml
name: "Midas Touch" # The name of the effect, shown to players  
placeholder: "%level% / 50" # The placeholder to be shown in the description, you can use expressions - eg %level% * 2  
description: "&a%placeholder%%&8 chance to get $50 every time you mine a block" # The description to be shown in lore and messages  

# The effects of the effect (i.e. the functionality)  
# See here: https://plugins.auxilor.io/effects/configuring-an-effect  
# Use %level% as a placeholder for the effect level  
effects:
  - id: give_money  
    args:  
      chance: "%level% / 50"  
      amount: 50  
    triggers:  
      - mine_block  

# The conditions required for the effect to activate,  
# you can use %level% as a placeholder here too  
conditions: [ ]  

```

--------------------------------

### Example Reward Messages for Ecoskills

Source: https://plugins.auxilor.io/ecoskills/how-to-make-a-skill

Defines chat messages displayed to players upon reaching specific skill levels. These messages can include dynamic placeholders for skill names, numbers, and descriptions.

```yaml
reward-messages:
  1:
    - " &8» &r&f+2 %ecoskills_defense_name%"
    - " &8» &r&6%ecoskills_versatile_tools_name% %ecoskills_versatile_tools_numeral%"
    - "    %ecoskills_versatile_tools_description%"
    - " &8» &r&6%ecoskills_dynamic_mining_name% %ecoskills_dynamic_mining_numeral%"
    - "    %ecoskills_dynamic_mining_description%"
  10:
    - " &8» &r&f+2 %ecoskills_defense_name%"
    - " &8» &r&6%ecoskills_versatile_tools_name% %ecoskills_versatile_tools_numeral%"
    - "    %ecoskills_versatile_tools_description%"
    - " &8» &r&6%ecoskills_spelunking_name% %ecoskills_spelunking_numeral%"
    - "    %ecoskills_spelunking_description%"
    - " &8» &r&6%ecoskills_dynamic_mining_name% %ecoskills_dynamic_mining_numeral%"
    - "    %ecoskills_dynamic_mining_description%"
  15:
    - " &8» &r&f+2 %ecoskills_defense_name%"
    - " &8» &r&f+1 %ecoskills_ferocity_name%"
    - " &8» &r&6%ecoskills_versatile_tools_name% %ecoskills_versatile_tools_numeral%"
    - "    %ecoskills_versatile_tools_description%"
    - " &8» &r&6%ecoskills_spelunking_name% %ecoskills_spelunking_numeral%"
    - "    %ecoskills_spelunking_description%"
    - " &8» &r&6%ecoskills_dynamic_mining_name% %ecoskills_dynamic_mining_numeral%"
    - "    %ecoskills_dynamic_mining_description%"
```

--------------------------------

### Level-Up Effects with Conditions in Ecoskills

Source: https://plugins.auxilor.io/ecoskills/how-to-make-a-skill

Defines effects that trigger when a player levels up a skill. This example shows how to grant items or run commands, with an optional 'require' condition to limit the effect's application based on the player's level.

```yaml
level-up-effects:
  - id: run_command
    args:
      command: "give %player% diamond 1"
      require: "%level% < 10"
```

--------------------------------

### XP Gain Method Configuration for Ecoskills

Source: https://plugins.auxilor.io/ecoskills/how-to-make-a-skill

Configures how players gain experience points (XP) for a skill. This includes defining the trigger action, a multiplier or fixed value, optional arguments like chance, and filters such as specific blocks to interact with.

```yaml
xp-gain-methods:
  - trigger: mine_block
    multiplier: 0.5 # You can also use "value" here (see above comment)
    args: # (Optional)
      chance: 50
    filters: # (Optional)
      blocks:
        - netherrack
  
  - trigger: mine_block
    multiplier: 1
    filters:
      blocks:
        - stone
        - diorite
        - granite
        - andesite
        - cobblestone
```

--------------------------------

### XP Requirements per Level in Ecoskills

Source: https://plugins.auxilor.io/ecoskills/how-to-make-a-skill

Specifies the amount of experience points required to reach each subsequent level of a skill. This is a direct list of XP values for each level.

```yaml
xp-requirements:
  - 50
  - 125
  - 200
```
Tokens:
Raw