Installation
Which jar to use, what the server needs and which plugins get along with PvpBot.
Requirements
| Server | Version | Java | Jar |
|---|---|---|---|
| Paper | 26.3 | 25 or newer | Paper 26.3 edition |
| Paper | 26.2 | 25 or newer | Paper edition |
| Paper | 1.21.11 | 21 or newer | Paper edition (1.21.11 build) |
| Spigot | 26.3 | 25 or newer | Spigot 26.3 edition |
| Spigot | 26.2 | 25 or newer | Spigot 26.2 edition |
| Spigot | 1.21.11 | 21 or newer | Spigot 1.21.11 edition |
Each jar only works on its own platform and version: PvpBot uses server internals to create the bots, so a Paper jar won't start on Spigot and vice versa. The features are the same in every edition (see Spigot edition). The wrong jar says so in the console and won't spawn bots.
Steps
- Stop the server.
- Download the jar for your server and version from Modrinth.
- Put it in the
plugins/folder. - Start the server. PvpBot creates
plugins/PvpBot/config.ymlwith every setting commented. - As an op, run
/pvpbot spawn. If a bot appears, you're set.
config.yml. New settings missing from the file use their default value;
/pvpbot settings marks them with * until you change them with /pvpbot set.Permissions
| Permission | Default | Grants |
|---|---|---|
pvpbot.admin | op | Every /pvpbot (alias /bot) and /ghost command. |
Regular players need no permission to command the bots you hand them: they do it by typing in chat (see Companions).
Plugin files
Everything lives in plugins/PvpBot/:
| File | Contents |
|---|---|
config.yml | Settings, presets, skins, name tables, the companions' world. |
bots.yml | The active bots, brought back after a restart if bots-relog is on. |
factions.yml | Factions, members, relations, leaders, overfactions, per-faction settings and kit tables. |
kits.yml | Saved kits. |
scripts.yml | Saved scripts. |
paths.yml | Patrol routes. |
ownership.yml | Which player owns which bot. |
skin-cache.yml | Skins already fetched, so restarts don't ask Mojang again. |
ghost-recordings/ | Paths recorded with /ghost record. |
After editing a file by hand, run /pvpbot reload.
Compatible plugins
SkinsRestorer
Optional. If it's installed, PvpBot stores each fetched skin directly in its storage, so SkinsRestorer doesn't overwrite it with a default one when the bot joins.
Login plugins (AuthMe, LoginTo)
A bot can't type /login, so login plugins would keep it locked forever (the usual symptom is a bot that
hops on the spot and takes no damage). With auth-autologin: true, on by default, PvpBot registers every bot
as already logged in. Nothing changes for real players. See Troubleshooting if that
isn't enough.
Protection (WorldGuard, GriefPrevention, claims)
Every block a bot places or breaks goes through the server's normal events, so protection plugins see it and can refuse it. The same goes for the rails and carts of cart PvP.
Language, updates and metrics
The top of config.yml has three switches under plugin::
| Key | Default | What it does |
|---|---|---|
plugin.language | en | The language PvpBot talks in: en or it. |
plugin.update-check | true | Says in the console, and to admins as they join, when a newer PvpBot is out. |
plugin.metrics | true | Sends anonymous usage numbers through bStats (how many servers, which versions, how many bots). Also off if plugins/bStats/config.yml says so. |
To change what PvpBot says, copy a line's key from the language file into plugins/PvpBot/messages.yml and
write your version. Only the lines you put there change, so updates never overwrite them. {0},
{1}… are the values filled in. /pvpbot reload picks up changes.
chat:
following: "{0} is on your six."
err:
no-bot: "There's no bot called {0} - /pvpbot list shows them all."