# Getting Started

# Getting Started

## Installation

1. Stop the server.
2. Make sure **KyuubiSoft Core** 2.9.9 or newer is installed. Achievements needs it; when you update, update Core first.
3. Put `KyuubiSoftAchievements-3.1.6.jar` into the server's `mods/` folder. When you update, remove the old `KyuubiSoftAchievements-*.jar` first.
4. Start the server. The plugin creates its data folder `mods/kyuubisoft_achievements/` and fills it with the default files.

---

## Files after the first start

```
mods/
  KyuubiSoftAchievements-3.1.6.jar
  kyuubisoft_achievements/
    config.json                  main configuration
    configs/                     shipped content (replaced on updates, keep your edits out of it)
      achievements.json            277 standard achievements
      mmo_achievements.json        121 MMO Skill Tree achievements
      rpg_leveling_achievements.json  34 RPG Leveling achievements
      lootbags.json                20 lootbag rewards
    custom/                      your own content (never overwritten)
      custom_achievements.json, custom_mmo_achievements.json,
      custom_rpg_leveling_achievements.json, custom_lootbags.json
      *.example                    templates
    localization/                en-US.json ... tr-TR.json (9 languages) + custom_<lang>.json
    players/<uuid>.json          per player: progress, unlocks, points, title, waiting rewards
    stats/                       statistics export and server records
    backups/                     backup sets of the admin window (last 20)
    admin/                       players tool: action log and actions queued for offline players
```

With MySQL set up in KyuubiSoft Core, player data is stored there instead of `players/`.

:::tip
Change shipped achievements in the [Admin Window](./admin-panel) or with an entry of the same id in `custom/`. Edits inside `configs/` are lost when a new version replaces the file (a backup is kept).
:::

---

## First steps

### As a player

| Command | Opens |
|---------|-------|
| `/ksachievements` (`/ac`) | The achievement book on the overview |
| `/kstitles` (`/title`) | The book on the titles tab |
| `/ksrewards` (`/rw`) | The book on the rewards tab |

New players also get the green **Achievement Book** item on their first join (`item.hotbarSlot`, default `7` counted from 0, so the eighth slot). Right-click it to open the book.

### As an admin

Give yourself `ks.achievements.admin`, then:

```bash
# open the admin window
/acadmin panel

# grant yourself an achievement (with its rewards)
/acadmin grant YourName first_blood

# list a player's achievements
/acadmin list YourName
```

The admin window is also a tile in the KyuubiSoft hub (`/ksadmin`).

---

## Next steps

- [Configuration](./configuration) - all options
- [Achievements](./achievements) - how an achievement is built
- [Custom Achievements](./custom-achievements) - add your own
- [Admin Window](./admin-panel) - edit everything in game
- [Commands](./commands) - full command reference