Skip to main content

Getting Started

This guide will walk you through installing and configuring the Achievement & Title System.

Installation​

Step 1: Download​

Download the latest version from CurseForge.

Step 2: Install​

Place the JAR file in your server's plugins/ directory:

your-server/
├── plugins/
│   └── KyuubiSoftAchievements-X.X.X.jar    ← Place here
├── worlds/
└── ...

Step 3: Start Server​

Start or restart your Hytale server. The plugin will automatically generate the config folder:

plugins/KyuubiAchievements/
├── config.json                    # Main configuration
├── configs/                       # Standard achievements
│   ├── achievements.json
│   ├── mmo_achievements.json
│   └── rpg_leveling_achievements.json
└── custom/                        # Your custom achievements
    └── *.example templates

Step 4: Verify Installation​

Check the server console for:

[KyuubiSoft Achievements] Achievement system loaded with 487 achievements
[KyuubiSoft Achievements] Loaded language: en-US

First Steps​

As a player, type /achievements (or /ac) to open the achievement gallery.

View Available Titles​

Type /titles (or /title) to see your unlocked titles.

Admin Quick Test​

If you have admin permissions, test the system:

# Grant yourself an achievement
/achievementadmin grant YourName first_blood

# List your achievements
/achievementadmin list YourName

Configuration Overview​

The main configuration file is config.json. Here's a minimal example:

{
  "language": "en-US",
  "display": {
    "displayMode": "both",
    "titlePosition": "prefix",
    "titleColor": "#FFD700"
  },
  "notifications": {
    "enabled": true,
    "displayMode": "both",
    "displayDurationMs": 5000
  }
}

See Configuration for detailed options.

Next Steps​