Skip to content

byteful/LevelTools

Repository files navigation

Java CI with Gradle Discord

Support/Help Server: https://discord.gg/G8BDgqsuyw

Logo

A plugin that adds a leveling system to any item.

Features

  • Supports versions 1.8 - 1.21.
  • Supports Folia.
  • No dependencies.
  • Super efficient, no lag.
  • Simple developer API.
  • Profile-based configuration system.
  • Any item can level up with custom triggers.
  • Commands & enchants on level up.
  • Supports blacklisting/whitelisting for blocks, entities, and items.
  • ActionBar notifications.
  • Item lore modification.

v2.0.0 - Profile System

LevelTools v2.0 introduces a modular profile-based configuration system. Instead of hardcoded tool types, you can now configure any item to level up.

Profile Types

Profile Type Purpose File
Trigger Profiles Define how XP is gained trigger_profiles.yml
Reward Profiles Define rewards per level reward_profiles.yml
Display Profiles Define name, lore, action bar display_profiles.yml
Item Profiles Tie everything together item_profiles.yml

Trigger Types

  • BLOCK_BREAK - XP when breaking blocks
  • ENTITY_KILL - XP when killing entities
  • FISHING - XP when catching items
  • RIGHT_CLICK / LEFT_CLICK - XP on click
  • CONSUME - XP when consuming items
  • FARMING - XP when tilling soil and breaking plants

Default Supported Items

Out of the box, LevelTools supports:

  • Pickaxes, Axes, Shovels (block mining)
  • Swords, Bows, Crossbows (combat)
  • Fishing Rods (fishing)
  • Hoes (farming)

Add any item by creating custom profiles. See the Wiki for details.

Migration from v1.x

Your old config will be automatically backed up to old_config.yml and migrated to the new profile system.

Commands

Command Description Permission
/leveltools help Shows command help None
/leveltools reload Reloads configuration leveltools.admin
/leveltools reset <player> Reset hand item for player leveltools.admin
/leveltools reset <player> --all Reset all items for player leveltools.admin
/leveltools xp <amount> Set hand item XP leveltools.admin
/leveltools level <level> Set hand item level leveltools.admin
/leveltools levelup Increase hand item level by 1 leveltools.admin
/leveltools debug Show debug information leveltools.admin

Developer API

View detailed API usage here.

PlaceholderAPI

Placeholder Description
%leveltools_level% Item level (main hand)
%leveltools_xp% Current XP (main hand)
%leveltools_max_xp% XP needed for next level
%leveltools_progress% Progress percentage

Wiki

Full documentation available at: https://github.com/byteful/LevelTools/wiki

About

A Spigot/Bukkit plugin that adds a leveling system to tools, swords, and bows. https://discord.gg/G8BDgqsuyw

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages