The NeoEssentials kit system allows server administrators to create predefined item packages that players can claim at configurable intervals.

The kit system provides:

• Customizable item kits
• Cooldown periods between claims
• Permission-based access
• First-join kits
• Economy integration (optional)
• One-time or repeatable kits

Configure the kit system in config/neoessentials/kits.toml:

[kits]
# Enable the kit system
enabled = true

# Show available kits when a player joins
showOnJoin = true

# First join kit (given automatically to new players, empty for none)
firstJoinKit = "starter"

# Economy integration
[kits.economy]
# Enable economy costs for kits
enableCosts = false

# Storage settings
[kits.storage]
# Storage type: "json", "sqlite", or "mysql"
type = "json"

# Storage location (for JSON)
location = "data/neoessentials/kits"

To create a kit:

1. Fill your inventory with the items you want in the kit
2. Run the command: /createkit <name>
3. Configure additional properties (optional):
   • Set cooldown: /kitcooldown <name> <time>
   • Set cost: /kitcost <name> <amount>
   • Set description: /kitdesc <name> <description>
   • Set icon: /kiticon <name> <material>

Example:

/createkit tools
/kitcooldown tools 24h
/kitdesc tools Basic tools for new players
/kiticon tools iron_pickaxe

Kit cooldowns determine how often a player can claim a kit:

/kitcooldown <name> <time>

Time formats:

• 30s - 30 seconds
• 5m - 5 minutes
• 2h - 2 hours
• 1d - 1 day
• 7d - 7 days
• once - One-time use kit

When enabled, players will be charged for claiming kits:

/kitcost <name> <amount>

Players must have sufficient funds to claim the kit.

Kit templates allow for consistent kit creation across servers:

/kittemplates save <name>
/kittemplates load <name>

Templates are stored in data/neoessentials/kittemplates/ as JSON files.

The kit GUI provides a visual interface for claiming kits:

/kitgui

This opens a menu showing all available kits with icons, descriptions, and cooldowns.

Kits can be organized into categories:

/kitcategory <name> <category>

Common categories include:

• starter - Basic starter kits
• tools - Tool kits
• armor - Armor kits
• weapons - Weapon kits
• special - Special or event kits

Kit contents are stored as serialized NBT data. A kit can include:

• Regular items
• Custom named items
• Enchanted items
• Items with custom NBT data
• Armor
• Tools
• Weapons
• Food
• Potions
• Books and written books

The first join kit is automatically given to new players:

# In kits.toml
firstJoinKit = "starter"

Rank kits can be automatically given when a player gets a rank:

/kitrank <name> <rank>

This requires integration with a permission system.

One-time kits can only be claimed once:

/kitcooldown <name> once

Kits can execute commands when claimed:

/kitcommand <name> add <command>
/kitcommand <name> remove <index>
/kitcommand <name> list

Commands can use placeholders like %player%.

Kits can require other kits to be claimed first:

/kitprereq <name> <prerequisite>

Players must claim the prerequisite kit before they can claim this kit.

Kits can apply potion effects when claimed:

/kiteffect <name> add <effect> <duration> <amplifier>
/kiteffect <name> remove <index>
/kiteffect <name> list

For more information about the kit system:

• Check the Commands Reference for detailed command usage
• See the Permissions Guide for permission setup
• Visit our Discord server for support