Quick Start
This guide will help you install and configure UltiTools in 5 minutes.
Prerequisites
- Paper 1.21+ server (Download Paper)
- Java 21
Optional Dependencies
- Vault — Economy and permissions API (required by UltiEconomy, UltiKits, etc.)
- PlaceholderAPI — Placeholder variables (required by UltiSideBar, etc.)
- LuckPerms — Permission management (recommended)
Installation
1. Download UltiTools
Download the latest UltiTools JAR from GitHub Releases.
2. Install the Plugin
- Stop your server
- Place
UltiTools-x.x.x.jarin the server'splugins/folder - Start the server
UltiTools will automatically generate its configuration files and directory structure on first start.
3. Install Modules
UltiTools core is just a framework — you need to install modules for actual features.
Method 1: Using UPM (Recommended)
Run in the server console or in-game (requires OP):
/upm install UltiEssentialsRestart the server after installation.
Method 2: Manual Installation
Download module JAR files from UltiCloud, place them in plugins/UltiTools/plugins/, and restart the server.
4. Basic Configuration
Edit plugins/UltiTools/config.yml:
# Storage backend: json, sqlite, mysql
datasource:
type: "sqlite"
# Language: zh for Chinese, en for English
language: "en"Run /ul reload after changing the configuration.
Common Commands
| Command | Description |
|---|---|
/ul list | List installed modules |
/ul reload | Reload all configuration files |
/ul reload <module> | Reload a specific module's config |
/upm list | List available modules |
/upm install <module> | Install a module |
/upm update all | Update all modules |
Note
All commands above require OP permission. /ul reload only reloads configuration files — installing new modules or updating JARs requires a server restart.
Next Steps
- Directory Structure — Understand UltiTools' file layout
- Module Management — Learn about the UPM package manager
- Configuration — Explore configuration options
- Browse Modules — View all available modules
Contributors
Ling Bao
Claude Opus 4.6