> For the complete documentation index, see [llms.txt](https://docs.mantic.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mantic.dev/manticswords.md).

# ManticSwords

Install ManticSwords, learn the first commands, and find the rest of the documentation.

ManticSwords adds upgradable mob swords and configurable progression to a Minecraft server: enchantments, crystals, prestige, leaderboards and scheduled events.

The plugin requires ManticLib.

## Install

1. Use a Bukkit or Spigot server version supported by your ManticSwords download.
2. Put `ManticLib.jar` and `ManticSwords.jar` in the server's `plugins` folder. ManticLib is required.
3. Start the server once. ManticSwords creates its files in `plugins/ManticSwords/`.
4. Stop the server and back up that folder before major changes.

If your download includes a license key, enter it in the `license` field in `config.yml`. The in-game editor hides license fields. Keep license and Discord webhook values private when sharing configuration files.

## First commands

Command names and aliases can be changed in `commands.yml`; these are the defaults.

| Command                            | Use                                                                    |
| ---------------------------------- | ---------------------------------------------------------------------- |
| `/manticsword menu`                | Open your ManticSwords menu.                                           |
| `/swordupgrade`                    | Open upgrades while holding a ManticSwords sword.                      |
| `/sworddisenchant`                 | Open the disenchant menu to trade an enchant level back for a refund.  |
| `/mob`                             | Check your mob kill count.                                             |
| `/mob <player>`                    | Check another player's mob kill count.                                 |
| `/mob top` or `/mobtop`            | Open the mob leaderboard.                                              |
| `/crystals balance [player]`       | Check a crystal balance with the built-in crystal economy.             |
| `/crystals pay <player> <amount>`  | Pay crystals with the built-in economy and `manticsword.crystals.pay`. |
| `/crystals shop` or `/crystalshop` | Open the crystal shop when the built-in economy and shop are enabled.  |
| `/crystaltop`                      | Open the crystal leaderboard with the built-in economy.                |
| `/swordprestige`                   | Open the prestige menu when prestige is enabled and permitted.         |

As a player with `manticsword.editor`, run `/manticsword editor` to change settings in game. After manual file edits, run `/manticsword reload`; changes to command names or aliases need a full server restart.

## Reset saved player data

There are two different resets. Both are console-only and both require running the command a second time within 10 seconds to confirm.

| Command                  | What it clears                                                                            | Permission                      |
| ------------------------ | ----------------------------------------------------------------------------------------- | ------------------------------- |
| `/crystals resetall`     | Crystal balances only. Progress, enchant levels, prestige and player settings stay saved. | `manticsword.crystals.resetall` |
| `/manticsword reset all` | All saved ManticSwords player data.                                                       | `manticsword.player.resetall`   |

Command names can be changed in `commands.yml`. To clear only saved player records while the server is stopped, back up the plugin folder and remove its `data` folder.

## Where to go next

1. [Permissions](https://docs.mantic.dev/manticswords/permissions.md) — staff commands and every permission node.
2. [Config Files](https://docs.mantic.dev/manticswords/config-files.md) — what each file controls and how to edit it.
3. [Disenchanting](https://docs.mantic.dev/manticswords/disenchanting.md) — refund rules and the disenchant menu.
4. [Captcha](https://docs.mantic.dev/manticswords/captcha.md) — click delay, punishment tiers and Discord reporting.
5. [Placeholders](https://docs.mantic.dev/manticswords/placeholders.md) — PlaceholderAPI values for scoreboards and menus.
6. [Custom items](https://docs.mantic.dev/manticswords/nexo-items.md) — Nexo, Oraxen and ItemsAdder items for swords, menus, drops and prestige.
7. [Developer API](https://docs.mantic.dev/manticswords/developer-api.md) — events, helpers and the compile-only API JAR.

## Online license verification

The plugin checks its existing license key online when it starts. The server must be able to reach `auth.mantic.dev` over HTTPS (port 443). If verification fails, read the server log for the reason, correct the key or network issue, then restart the server. A rate-limit response includes how long to wait when available.
