HySkills - Custom RPG Skills/Stats/Leveling

HySkills

HySkills is a skill management system for Hytale servers, designed to make it easy for anyone to create their own custom RPG skills.

With careful setup you can create in-depth unlock systems and progression restrictions. This is achieved through triggers, unlocks, requirements and locked items.

Here is a website to help you build skills easier made by ShadXn: https://shadxn.github.io/hytale/hyskills/

Big thanks to ShadXn for sharing his skills.json file for others to use: skills.json

Important Notes

Please back up your skills_data folder (located inside your world folder) before updating.

If you are on a old version prior to 1.0.8 you might need to remake the skills.

This mod is intended for you to make your own skills or share .json files.

Default stats within settings are new for 1.1.0, there may still be some bugs around it. It will set the base stats for everyone on the server.

Support for SQL Database (MySQL, PostgreSQL, H2)

Support for LuckPerms & MHUD. (Optional, will fallback if missing)

Commands

/skills – For all users to track/view their own skills and stats.

/skillsadmin – For admins to manage setting and create/edit skills.

/skillstoggle – Turn on/off chat notifications (Toaster notifications stay currently)

/skillstogglebar – Turn off xp bar at the bottom of the screen.

/skillsadmin migrate H2/MYSQL/JSON/POSTGRELQ

/skills Overview

Player overview page containing current skill levels for skills created and current stat increases that have been assigned to you.

Leaderboard page that ranks players on your server by total level.

A separate page for each skill created to users progress, unlocks and locked equipment.

/skillsadmin Overview

Info page which contains relevant details on the current version of the mod.

Skills page for viewing/editing/deleting skills.

Add skill page for adding a new skill.

Players page for editing any players HySkills data from within the menu.

Settings menu for toggling skill bar or chat notification off by default. (This only works for new users joining for the first time then it saves their preference if they have changed it)

Set the default base stats of all players via settings page.

Creating a Skill

Set display name, base xp, multiplier and then max level. (Higher base and multiplier will make levels longer.)

Requirements

If you want a specific requirement like user must be holding an item you can add that here.

Select your requirement type and then click on search to open up the item/entity panel and select one/multiple you want to add to list.

Both allow list and deny list supports wildcards. Can simply type "hatchet" and anything with hatchet in its item id will count.

Triggers

NONE: Nothing will trigger anything with this skill.

BLOCK_BREAK: Triggers on breaking any block. (Allow/deny lists available)

ENTITY_KILL: Triggers on killing mob.

PLAYER_CHAT: Triggers on sending message in chat.

SPRINT: Triggers on sprinting.

CRAFT_ITEM: Triggers on crafting in inventory only currently.

PLACE_BLOCK: Triggers on placing blocks.

GLIDE: Implemented but doesnt work yet due to no gliders.

SWIM: Triggers on swimming (not standing in water).

CLIMB: Triggers on climbing.

JUMP: Triggers on jumping.

ROLL: Triggers on rolling. (Jump from high up hold ctrl)

SLIDE: Triggers on sliding. (Hold sprint and then click ctrl)

CRITICAL_HIT: Triggers on critical hits. (May need more crit chance stat to see this happen more)

SPEND_MANA: Triggers on spending mana.

PLAYER_DEATH: Triggers on player death.

PLAYER_KILL: Triggers on player killing another player. (ENTITY_KILL is for mobs)

PARRY: Triggers on blocking damage.

PROJECTILE_HIT: Triggers on whatever your projectile hits. (works with bows and arrows, maybe issues with others)

INTERACT: Triggers on anything where you click F key to interact. (Can use allow and deny list to stop it on workbenches)

Unlocks

ITEM: Add an item that is given as an unlock.

STAT_HEALTH: Increases max health.

STAT_STAMINA: Increases max stamina.

STAT_MANA: Increases max mana.

STAT_OXYGEN: Increases max oxygen.

STAT_STAMINA_REGEN: Increases speed at which stamina regenerates. (Even 1 or 2 makes a noticeable difference)

STAT_BLOCKBREAK_SPEED: Increases speed at which blocks are destroyed.

STAT_CRIT_CHANCE: Increases critical hit chance.

STAT_CRIT_DAMAGE: Increases critical hit damage.

STAT_VAMPIRISM: Gain health when dealing damage.

STAT_CRAFTING_PROFICIENCY: Increases chance of double crafting output (higher value = better chance).

STAT_MOVEMENT_SPEED: Increases movement speed.

MAGNET: Items (e.g. drops from trees) are pulled toward the player.

STAT_DURABILITY_MODIFIER: Increases or decreases durability loss of the held item (positive = less loss, negative = more loss).

STAT_BONUS_DROP_CHANCE: Increases chance of bonus/extra drops. (1 ≈ guaranteed extra drop at the moment)

STAT_DAMAGE_MELEE: Increases damage with melee attacks and melee weapons.

STAT_DAMAGE_RANGED: Increases damage with thrown and ranged weapons.

STAT_DAMAGE_MAGIC: Increases damage with magic attacks/spells.

STAT_DAMAGE_FIRE: Increases fire damage.

STAT_DAMAGE_LIGHT: Increases light attack damage.

STAT_DAMAGE_CHARGED: Increases charged attack damage.

STAT_DAMAGE_SIGNATURE: Increases signature attack damage.

STAT_REDUCE_DAMAGE: Reduces damage taken (general damage reduction).

STAT_RESISTANCE_PROJECTILE: Reduces damage taken from projectiles.

STAT_RESISTANCE_MELEE: Reduces damage taken from melee attacks.

STAT_RESISTANCE_MAGIC: Reduces damage taken from magic.

STAT_RESISTANCE_FIRE: Reduces damage taken from fire.

STAT_RESISTANCE_FALL: Reduces fall damage.

STAT_RESISTANCE_DROWNING: Reduces drowning damage.

STAT_RESISTANCE_SUFFOCATION: Reduces suffocation damage.

STAT_RESISTANCE_VOID: Reduces void damage.

STAT_RESISTANCE_EXPLOSION: Reduces explosion damage.

STAT_SIGNATURE_ENERGY: Increases or decreases signature energy gained/lost on hit by the specified amount.

Locked Items

You can set locked items to only be used at specific levels.

This will physically stop the player for instance mining a block with that pickaxe, it just wont work for them and they will get a warning in chat.

SQL Database (MySQL, PostgreSQL, H2)

Migrate current data

Start server, type "/skillsadmin migrate" followed by either H2, MYSQL, POSTGRESQL or JSON.

Wait for the "Migration complete" message. Then stop the server.

In skills_data folder within world folder edit config.json and change type from JSON to H2, MYSQL, POSTGRESQL or JSON. Edit any other information in config needed.

Start the server again, migration should be complete.

No migration needed, fresh install of mod

In skills_data folder within world folder edit config.json and change type from JSON to H2, MYSQL, POSTGRESQL or JSON. Edit any other information in config needed.

Start the server.

LuckPerms

https://www.curseforge.com/hytale/mods/luckperms

Permission nodes

hyskills.command.skills

hyskills.command.toggle

hyskills.command.togglebar

hyskills.admin