Content generated with AI — it may contain mistakes.

ExyliaPracticeBot/Getting startedUpdated in v1.5.0

Installation

Dependencies, first boot, the files the plugin generates, and the one key that has to be set.

Page 2 of 215 min read

At the end of this page ExyliaPracticeBot is running with one world allowed, ready for your first bot. Installing takes a jar, one restart and one line in config.yml.

Before you start#

The server has to be Paper or Folia 1.21.9 or newer — newer than the rest of the Exylia suite, because every bot is a mannequin, an entity that first exists in 1.21.9. An older server refuses to load the jar. See Compatibility.

ExyliaPracticeBot needs ExyliaLib in plugins/ before the first boot; PacketEvents is optional.

PluginWhat for
packeteventsOptional, declared under softdepend. Without it the plugin runs and only the packet-drawn extras of ExyliaLib stay off.
ExyliaLibDeclared under softdepend. Configuration, menus, menu actions, database, tasks, text and effects. The plugin does not run without it.
Why ExyliaLib is soft

depend and softdepend are load-order rules, not a statement about how much each is needed. ExyliaLib is softdepend on purpose, and it is the one the plugin genuinely cannot run without: the loader that installs ExyliaLib is itself what has to load for that install to happen, and a hard depend would stop the plugin loading before the library could ever arrive. Soft here means "load me after it", not "optional".

The only optional plugin is ExyliaPracticeCore, and only if you want a player's /bot dressed from its kits (advanced.practice-kits). The plugin registers no PlaceholderAPI placeholders, so PlaceholderAPI buys you nothing here.

Installing#

Drop in the jar

Copy ExyliaPracticeBotV3.jar into the server's plugins/ folder, alongside packetevents (optional) and ExyliaLib.

Start the server

The first boot writes config.yml, messages.yml, the two menu files and the database table.

Check the console

You are looking for ExyliaPracticeBotV3 enabled!. If the line never appears, ExyliaLib is missing or the server is older than 1.21.9 — those are the two things that stop the plugin loading outright.

Allow a world

Open config.yml and put your world into the worlds list. Until you do, /bot spawn is refused everywhere. This is the step people miss; see below.

Spawn one

/bot opens the menu. Every player node defaults to true, so nothing needs granting; see Permissions to make features rank perks, and First steps.

Check that it works#

The console shows ExyliaPracticeBotV3 enabled!. In game, /bot opens the menu and Spawn bot puts a bot next to you. If it answers "You can't spawn a bot in this world", the world is not in worlds yet; see below.

Where bots may be spawned#

The worlds key at the top level of config.yml is the whitelist of worlds a bot may exist in. It is checked in three places — /bot spawn, the menu's spawn button, and the automatic respawn — so there is no way around it.

plugins/ExyliaPracticeBotV3/config.yml
yaml
# Worlds where a bot may be spawned. Empty means nowhere.
worlds:
  - exylia_sandbox_badlands
  - exylia_sandbox_desert
  - exylia_sandbox_mushroom
  - exylia_sandbox_plains
  - exylia_sandbox_snowy
The default list will not match your server

The file ships with five exylia_sandbox_* worlds, which are Exylia's own. On any other server none of those worlds exist, so the practical effect on a fresh install is the same as an empty list: no world is allowed and every spawn is refused with "You can't spawn a bot in this world. Please use /rtp first" until you replace the list with your own world names. An empty list allows nothing at all — it is not a wildcard.

World names are matched exactly, as world.getName() reports them — the folder name, not a display name. After editing, /botadmin reload re-reads the file without a restart.

Generated files#

Every file in plugins/ExyliaPracticeBotV3/
FileContents
config.ymllanguage, bot.mode and bot.difficulty, the world whitelist, respawn, interaction, everything under advanced (each mode's tuning and practice-kits), the slider limits, max-bots and reserved-for-matches. Also editable in game with /botadmin settings.
lang/<code>/messages.ymlEvery player-facing line, the name above the bot, plus the display labels for modes, difficulties, armour, enchantments, hands, knockback, strength and speed.
lang/<code>/menus/user/main.ymlThe main screen: mode, difficulty, armour, hands, potions, the toggles, spawn, remove and reset.
lang/<code>/menus/user/advanced.ymlThe fine-tuning screen: damage, reach, speeds, health, totems and the sandbox toggles.
database.ymlDatabase engine, written by ExyliaLib. H2 by default, embedded, nothing to install.
dumps/Created by /botadmin export, and read by /botadmin import <filename>.

<code> is the language set by language in config.yml: English, Spanish, Portuguese, French, Russian and Turkish ship with the plugin. A missing menu file is written again and a new button reaches it on update; a changed default waits in /exylialib updates instead of overwriting your edits. Editing menus is covered in Edit menus.

Folia#

plugin.yml declares folia-supported: true, and the plugin is written for it: every bot ticks on the thread that owns its own region, spawning happens on the thread that owns the destination, and each bot holds a chunk ticket for the chunk it is standing in so it keeps thinking even when nobody is nearby. Nothing extra to configure.

Database#

By default the plugin uses H2: a file inside the plugin folder, with no server, no installation and no maintenance. It stores one row per player in practicebot_players, holding that player's bot settings.

To share settings across servers, edit database.yml:

plugins/ExyliaPracticeBotV3/database.yml
yaml
database:
  type: mysql
  settings:
    pool-size: 0
  mysql:
    host: 127.0.0.1
    port: 3306
    database: minecraft
    username: root
    password: ""

Supported engines: h2, mysql, mariadb, postgresql and mongodb. Only the block matching type is read. The file is ExyliaLib's; its full reference is in the library's database page.

To wipe it, use ExyliaLib: /exylialib wipe ExyliaPracticeBotV3 <table|*> for the table, /exylialib resetplayer <player> for one player. See the ExyliaLib commands.

Nothing waits on the database while the plugin enables. A player's row is read when they join and written the moment a setting changes.

Updating#

Replace the jar and restart. Your edits to config.yml, messages.yml and both menu files are kept, and player settings live in the database. A config written by an older release is migrated in place on boot — the old restrictions.allowed-worlds key, for one, is moved to worlds rather than lost.

Bots themselves never survive a restart: they are session objects, and every one is removed on shutdown.

Something missing on this page? Tell us on Discord