> For the complete documentation index, see [llms.txt](https://edelweiss-network.gitbook.io/practicebot/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edelweiss-network.gitbook.io/practicebot/practicebot.md).

# PracticeBot

Official PracticeBot 1.9.18-spearmace-beta documentation for server owners and addon developers.

#### PracticeBot

Official documentation for PracticeBot 1.9.18-spearmace-beta, a standalone Minecraft PvP training platform for Paper, Folia, and Canvas.

PracticeBot includes its own player-NPC engine, so Citizens and NexusNPC are not required. It provides player-spawned bots, reusable staff templates, live GUI editors, configurable nameplates, PlaceholderAPI support, administration tools, and a public Java API for addon developers.

> Use the server-owner guides for installation and configuration. Addon developers should compile against the standalone API artifact and use only `com.sheldera.practicebot.api.*`.

**Supported bot modes**

* Normal melee PvP
* Crystal PvP, including optional respawn-anchor combat
* Mace PvP
* Spear-Mace PvP (beta), combining spear mobility, mace swaps, Wind Charges, Pearl Catch and defensive recovery
* Cart PvP
* Modern UHC PvP
* Dummy bots for templates, integrations, and controlled scenarios

**Main features**

* Embedded player-NPC engine with Paper, Folia, and Canvas support
* Player spawn and per-bot settings GUIs
* Live template editor with offline-player Mojang skin lookup
* Fully configurable GUI items, including independent visual states
* Enhanced TextDisplay nameplates with optional health display
* Template kill statistics, PlaceholderAPI placeholders, and optional kill taunts
* ID-based runtime bot administration and maintenance commands
* Validated live configuration editing through `/pbadmin config`
* Public Bukkit Services API with lifecycle events, immutable state, runtime settings, metadata, and asynchronous inventory and NPC-aware teleport control

**Where to start**

**Server owners**

1. [Installation](https://edelweiss-network.gitbook.io/practicebot/server-owner-guide/installation)
2. [License activation](https://edelweiss-network.gitbook.io/practicebot/server-owner-guide/license)
3. [First setup](https://edelweiss-network.gitbook.io/practicebot/server-owner-guide/first-setup)
4. [Commands](https://edelweiss-network.gitbook.io/practicebot/server-owner-guide/commands)
5. [Configuration](https://edelweiss-network.gitbook.io/practicebot/server-owner-guide/configuration)
6. [Templates](https://edelweiss-network.gitbook.io/practicebot/templates-1)
7. [Upgrade guide](https://edelweiss-network.gitbook.io/practicebot/upgrade-guide)
8. [Troubleshooting](https://edelweiss-network.gitbook.io/practicebot/troubleshooting)

**Addon developers**

1. [Developer guide](https://edelweiss-network.gitbook.io/practicebot/developer-guide)
2. [Setup and dependency](https://edelweiss-network.gitbook.io/practicebot/setup-and-dependency)
3. [Service access](https://edelweiss-network.gitbook.io/practicebot/service-access)
4. [Spawning bots](https://edelweiss-network.gitbook.io/practicebot/spawning-bots)
5. [Bot handles and state](https://edelweiss-network.gitbook.io/practicebot/developer-guide/bot-handles-and-state)
6. [Runtime PvP settings](https://edelweiss-network.gitbook.io/practicebot/developer-guide/cpvp-runtime-settings)
7. [Events](https://edelweiss-network.gitbook.io/practicebot/developer-guide/events)
8. [Threading and safety](https://edelweiss-network.gitbook.io/practicebot/threading-and-safety)
9. [Public API reference](https://edelweiss-network.gitbook.io/practicebot/reference/public-api-reference)

**Reference**

* [Config Reference](https://edelweiss-network.gitbook.io/practicebot/reference/config-reference)
* [GUI Reference](https://edelweiss-network.gitbook.io/practicebot/reference/gui-reference)
* [Template Reference](https://edelweiss-network.gitbook.io/practicebot/reference/template-reference)
* [Public API Reference](https://edelweiss-network.gitbook.io/practicebot/reference/public-api-reference)
* [Documentation Map](https://edelweiss-network.gitbook.io/practicebot/summary)

**API compatibility boundary**

Only `com.sheldera.practicebot.api.*` is a supported addon contract. Classes in internal, bot, combat, GUI, license, NPC-engine, and manager packages may change between builds. Depending on the public API prevents obfuscation and implementation changes from breaking addons.

#### Spear-Mace beta

The new mode is included in 1.9.18-spearmace-beta for Minecraft 1.21.11 and the supported 26.x server lines. Test it in your arena before enabling it publicly. Personal Spear-Mace bots start with combat off; the bundled spearmace template starts with combat on.

Addon developers: the separate API artifact uses the same release version. PracticeBotApi.getApiVersion() reports 1.13.0. The API JAR is a compile-only dependency, not a server plugin.