T-Kits Documentation
The ultimate Minecraft kit plugin for creating, managing, and sharing player kits with beautiful GUIs, combat features, and powerful admin tools.
Features
T-Kits provides a comprehensive set of features for managing player kits in Minecraft, with focus on ease of use, customization, and PvP enhancements.
Unlimited Kits
Create and manage as many personal kits as you need (configurable per player), each storing your items, armor, and offhand with a beautiful animated GUI.
Global Kits & Sharing
Share your kits globally for other players to use, or import kits with unique share codes. Perfect for team coordination or server-wide kit distribution.
Combat Tag System
Prevents kit use during combat, blocks key commands, and restricts actions to ensure fair PvP. Essential for competitive servers to prevent combat logging.
Regear & Arrange
Instantly restore your inventory to match your last kit with /regear or organize items with /arrange. Saves time during combat or after respawning.
Kitroom System
Access the server-wide item repository with categories, cooldowns, and permissions. Perfect for organizing server-wide kit templates and item collections.
YAML & MySQL Storage
Choose between file-based or database storage with hot-reloading and seamless migration tools. Adaptable to any server size or network setup.
Additional Features
Installation
Follow these steps to install and set up the T-Kits plugin on your Minecraft server.
Requirements
- Minecraft Server (Spigot/Paper) version 1.21 or higher
- Java 17 or above
- Server with at least 512MB RAM available
Step-by-Step Installation Guide
-
1
Download the latest T-Kits plugin JAR file
Get the latest version from GitHub releases.
-
2
Place the JAR file in your server's plugins folder
Navigate to your server directory and find the
pluginsfolder.your-server-directory/plugins/ -
3
Restart your server or use a plugin manager
Restart your server to load the plugin or use a plugin manager to load it without restarting.
Restart command: stop (in console) -
4
The plugin will generate default configuration files
On first run, T-Kits will create its configuration files in the plugins/T-Kits directory.
-
5
Customize settings in the config.yml file as needed
Edit the configuration file to customize the plugin's behavior.
-
6
Reload the plugin with the command
Apply changes by reloading the plugin.
/tkitsadmin reload
Quick Setup Tips
Assign proper permissions to players and groups using a permissions plugin like LuckPerms.
Create preset global kits that all players can access for common loadouts.
Configure cooldowns to balance kit usage on your server and prevent abuse.
Set up the combat tag system if you run a PvP server to prevent combat logging.
Usage
Learn how to use T-Kits plugin effectively with these commands and examples.
Basic Commands
| Command | Description | Permission |
|---|---|---|
/kit |
Opens the main T-Kits GUI menu | tkits.use |
/k1 - /k7
|
Load kits 1-7 directly | tkits.load.1-7 |
/regear or
/rg
|
Reload your last kit's contents instantly | tkits.regear |
/arrange or
/ag
|
Arrange inventory to match last kit layout | tkits.arrange |
/kit import <code>
|
Import a kit using a share code | tkits.kit.share |
/kitroom |
Open the Kitroom GUI | tkits.kitroom.use |
Admin Commands
| Command | Description |
|---|---|
/tkitsadmin or
/tka
|
Root admin command |
/tka kitroom save |
Save Kitroom to kitroom.yml |
/tka kitroom reload
|
Reload Kitroom from file |
/tka kitroom
resetdefaults
|
Reset Kitroom categories/items |
/tka reload |
Reload all config files |
/tka migrate <YAML|MYSQL>
[--all|<Player/UUID>]
|
Migrate storage between types |
/tka kit clear <player>
<kit_number>
|
Clear a player's kit |
/tka kit preview <player>
<kit_number>
|
Preview a player's kit |
/tka give regearitem
<player>
|
Give a Regear Box |
/tka cooldown reset
<player>
<type>
|
Reset cooldowns (kit_load|regear|arrange|all) |
Creating a Kit
To create a new kit:
-
Run the command
/kitto open the main GUI - Click on an empty kit slot (1-7 depending on your permissions)
- In the kit editor, arrange items in your inventory as desired or import from your current inventory
- Click the "Save" button to store your kit
- Optionally, set a custom name or description for your kit
Your armor slots and off-hand items are also saved with the kit. Be sure to equip any armor you want to include in the kit before saving.
Using Kits
To use a kit:
-
Type
/kitto open the GUI - Click on the kit you want to use
- Confirm your selection if prompted
-
For quick access, you can use
/k1through/k7to load specific kit slots directly
Using a kit will replace your current inventory items with the kit items. Make sure to clear your inventory or store important items beforehand.
Kit Sharing & Global Kits
Sharing Kits
To share a kit with another player:
- In the kit editor, look for the "Share" button
- Select the option to generate a share code
- Copy the share code and send it to other players
-
The other player can import it using
/kit import <code>
Using Global Kits
To make a kit global or use global kits:
- Open the kit editor for your kit
- Look for the "Make Global" option and click it
- Set any permissions or restrictions for the global kit
- Other players can now access this kit from the Global Kits tab in the main GUI
Global kits are perfect for setting up standard equipment for different server activities or events. Create themed global kits for minigames, PvP arenas, or special events!
Advanced Usage Tips
Regear & Arrange
After dying in PvP, quickly use
/regear or /rg to
instantly get your last used kit back. Use
/arrange or /ag to
organize items to match your last kit
layout.
Kitroom Usage
Access the server-wide item repository with
/kitroom to quickly grab common
items organized by category. Great for
getting specific items without creating a
full kit.
Combat Tag System
When you hit another player or get hit, the combat tag activates. During this time, certain commands are blocked to prevent combat logging. The tag expires after the configured duration.
Ender Chest Integration
Each kit can have associated Ender Chest contents. This means when you load a kit, your Ender Chest contents can also be updated with kit-specific items.
Configuration
Customize T-Kits to fit your server's unique needs with these configuration options.
Main Configuration File (config.yml)
The main configuration file lets you customize various aspects of the plugin's behavior. Here are the key settings:
# T-Kits Main Configuration
# Storage options: YAML, MYSQL
storage:
type: YAML
mysql:
host: localhost
port: 3306
database: tkits
username: root
password: password
table-prefix: tkits_
# Global cooldown in seconds (0 to disable)
global-cooldown: 60
# Kit options
kits:
# Maximum number of kits per player (0 for unlimited)
max-per-player: 7
# Default kit settings
defaults:
# Can players override existing kits?
allow-override: true
# Default cooldown for new kits (in seconds)
cooldown: 300
# Combat tag settings
combat-tag:
# Enable internal combat tag system?
enabled: true
# Duration in seconds
duration: 15
# Block these commands during combat
blocked-commands:
- "spawn"
- "home"
- "tpa"
# GUI settings
gui:
# Main menu title
main-title: "T-Kits Menu"
# Editor menu title
editor-title: "Kit Editor"
# Items per page
items-per-page: 45
# Show kit previews
show-previews: true
# Messages
messages:
prefix: "&7[&5T-Kits&7] "
no-permission: "&cYou don't have permission to do that."
kit-created: "&aKit %name% has been created successfully!"
kit-deleted: "&aKit %name% has been deleted."
kit-edited: "&aKit %name% has been updated."
cooldown-active: "&cYou need to wait %time% before using this kit again."
kit-applied: "&aYou have received the %name% kit."
After making changes to the configuration file, use
/tkitsadmin reload
to apply the changes without restarting your server.
GUI Configuration (gui.yml)
The GUI configuration file allows you to customize the appearance and layout of all plugin menus:
# T-Kits GUI Configuration
# Main menu settings
main-menu:
title: "&8T-Kits: &5Your Kits"
size: 54 # Inventory size (must be multiple of 9)
# Item definitions
items:
kit-slot:
material: CHEST
name: "&5Kit Slot &7#%slot%"
lore:
- "&7Click to open this kit"
- "&7Right-click to edit this kit"
empty-slot:
material: GRAY_STAINED_GLASS_PANE
name: "&7Empty Slot"
lore:
- "&7Click to create a new kit here"
global-kits-button:
material: ENDER_CHEST
name: "&5Global Kits"
lore:
- "&7Click to browse global kits"
kitroom-button:
material: BOOKSHELF
name: "&5Kitroom"
lore:
- "&7Click to open the kitroom"
# Kit editor settings
kit-editor:
title: "&8Editing: &5%kit_name%"
size: 54
Kitroom Configuration (kitroom.yml)
This is an example kitroom configuration. You have to make your own kitroom. To make one you can simply drag and drop Vanilla Items into your kitroom editor. A default kitroom WILL be added in future updates.
A default kitroom WILL be added in future updates.
This kitroom configuration defines categories and items for the server-wide item repository:
# T-Kits Kitroom Configuration
categories:
weapons:
name: "&cWeapons"
icon: DIAMOND_SWORD
permission: "tkits.kitroom.weapons"
items:
- item: DIAMOND_SWORD
enchantments:
- "sharpness:5"
- "unbreaking:3"
name: "&bDiamond Sword"
- item: BOW
enchantments:
- "power:4"
- "infinity:1"
name: "&aPower Bow"
armor:
name: "&bArmor"
icon: DIAMOND_CHESTPLATE
permission: "tkits.kitroom.armor"
items:
- item: DIAMOND_HELMET
enchantments:
- "protection:4"
- "unbreaking:3"
name: "&bDiamond Helmet"
Permissions Configuration
T-Kits uses a detailed permission system to control access to features. Here are the main permissions:
| Permission | Description |
|---|---|
tkits.use |
Allows players to open the main GUI and use kits |
tkits.load.1 -
tkits.load.7
|
Allows players to load specific kit numbers |
tkits.regear |
Allows players to use the /regear command |
tkits.arrange |
Allows players to use the /arrange command |
tkits.kit.share |
Allows players to share and import kits |
tkits.kitroom.use |
Allows players to access the Kitroom |
tkits.kitroom.admin
|
Allows players to modify the Kitroom |
tkits.admin |
Provides access to all admin commands |
tkits.cooldown.bypass
|
Allows players to bypass kit cooldowns |
tkits.combattag.bypass
|
Allows players to bypass combat tag restrictions |
Use a permissions plugin like LuckPerms to
assign these permissions to players or groups.
The wildcard permission
tkits.* grants all T-Kits
permissions.
Storage Configuration
T-Kits supports dual storage options for kit data. (Automatic migration WILL be added in next update) Choose the option that best fits your server's needs:
YAML Storage
Simple file-based storage. Good for small servers with fewer players. Easy to backup and edit manually if needed.
MySQL Storage
External database storage. Best for large servers or networks. Supports sharing data between multiple servers and offers better performance.
Use the migration command to move data between
storage types:
/tkitsadmin migrate <YAML|MYSQL>
[--all|<Player/UUID>]
GUI Customization
T-Kits allows you to customize the appearance of GUI menus. You can modify the following aspects:
Menu Titles
Change the titles of the main menu, kit editor, and other GUIs in the config.yml file.
gui: main-title: "Custom Kits Menu" editor-title: "Kit Creator"
Button Icons
Customize the items used for buttons and navigation in the gui-items.yml file.
buttons: previous-page: material: ARROW name: "&aPrevious Page" next-page: material: ARROW name: "&aNext Page"
Troubleshooting
Solutions for common issues and problems you might encounter with the T-Kits plugin.
Plugin doesn't load after installation
This is typically caused by one of the following issues:
- Incorrect server version - T-Kits requires Spigot/Paper 1.21 or higher
- Java version mismatch - Ensure you're using Java 17 or above
- Corrupted plugin file - Try re-downloading the plugin
- Missing dependencies - Check the console for error messages
Solution:
- Check your server console for specific error messages
- Verify your server is running Minecraft 1.21+ with Java 17 or higher
- Try downloading the plugin again and replace the existing file
- Make sure you have all required dependencies (if any are mentioned in error logs)
Permission issues - Commands not working
If commands aren't working or players can't access certain features, it's likely a permission issue:
- Players don't have the necessary permissions
- Permissions plugin conflict
- Incorrect permission node syntax
Solution:
-
Verify that players have the
correct permissions (e.g.,
tkits.use,tkits.load.1, etc.) - If using a permissions plugin, ensure it's working correctly with other plugins
-
Try giving players the wildcard
permission
(
tkits.*) temporarily to test - Check the console for any permission-related error messages
# Example LuckPerms command to give a user all T-Kits permissions /lp user <username> permission set tkits.* true
Global kits not appearing for other players
If global kits aren't visible to other players:
- Permission issues preventing access to global kits
- Kit wasn't properly set as global
- Storage synchronization issues
- Players need the right permission to see global kits
Solution:
- Make sure you properly marked the kit as global in the kit editor
-
Check that players have the
tkits.kit.global.usepermission -
Try reloading the plugin with
/tkitsadmin reload - If using MySQL, verify the connection is working properly
- Try creating the global kit again from scratch
Combat tag issues or bypassing
If the combat tag system isn't working as expected:
- Combat tag system disabled in configuration
- Players have the bypass permission
- Conflict with another combat tag plugin
- Commands not properly blocked in configuration
Solution:
-
Check that
combat-tag.enabledis set totruein config.yml -
Verify no players have the
tkits.combattag.bypasspermission unless intended - If using another combat tag plugin, disable T-Kits' internal system
-
Add problematic commands to the
blocked-commandslist in config.yml - Set a reasonable duration for the combat tag (15-30 seconds recommended)
# Combat tag configuration example combat-tag: enabled: true duration: 15 # seconds blocked-commands: - "spawn" - "home" - "tpa" - "fly" - "god" - "vanish"
Kit sharing codes not working
If kit sharing via codes isn't working properly:
- Incorrect or expired share code
- Missing permission to import kits
- Share code from an incompatible version
- Items in the kit not supported on your server version
Solution:
- Double-check the share code for typos (codes are case-sensitive)
-
Ensure the player has the
tkits.kit.sharepermission - Try generating a new share code if the previous one is old
- Check for any error messages in the console when importing
- If the kit contains custom items, ensure both servers support them
Database connection errors
When using MySQL storage, you might encounter database connection issues:
- Incorrect database credentials
- Database server not accessible
- Missing database or tables
- Insufficient permissions for the database user
Solution:
- Double-check the database credentials in the config.yml file
- Ensure the MySQL server is running and accessible from your Minecraft server
- Verify that the database exists and the user has appropriate permissions
- Try connecting to the database using a MySQL client to test the connection
- If issues persist, temporarily switch to YAML storage while troubleshooting
General Troubleshooting Tips
Check Server Logs
Always start by checking your server logs (logs/latest.log) for any error messages related to T-Kits. These often provide detailed information about what's going wrong.
Reload Before Restart
Try using
/tkitsadmin reload first
before restarting your entire server.
Many configuration changes can be
applied with just a reload.
Check Plugin Conflicts
Test if T-Kits works correctly when other plugins are disabled. Some inventory management or economy plugins might conflict with T-Kits.
Backup Before Changes
Always back up your T-Kits configuration and data files before making significant changes or updating the plugin.
Still Need Help?
If your issue isn't covered here or you need personalized assistance, contact the developer directly.
Contact & Support
Need help or have questions about T-Kits? Reach out through one of these channels.
Feedback & Suggestions
Your feedback helps make T-Kits better! If you have ideas for new features or improvements, please share them through one of our support channels.
Feature Requests
Have an idea for a new feature? Let us know through GitHub issues or Discord.
Bug Reports
Found a bug? Please report it with as much detail as possible including steps to reproduce.