St3ix Docs

Storage

Where AFKPlus writes the zone, usernames, balances, and boosters.

Storage.Type is SQLITE, YAML, or MYSQL. The default is SQLITE and the file is plugins/AFKPlus/afkplus.db.

TypeKeysWhat is stored
SQLITEStorage.Sqlite.FileZone, players, balances, boosters in one database file.
YAMLStorage.Yaml.FileThe same records in zone.yml by default.
MYSQLHost, Port, Database, Username, Password, Table, PlayersZone table and player table. Table defaults to afk_zone. Players defaults to afk_players.

MySQL names may use letters, numbers, and underscore. The database name may also use a hyphen. A bad host or a refused login is printed at startup. The shop still opens, but balances stay at zero until storage connects.

/afk admin reload does not reconnect storage and does not wipe balances. It also does not replace config.yml.

Move to another engine

  1. /afk admin storage export writes plugins/AFKPlus/transfer.yml. The current database is left as it is.
  2. Stop the server and set Storage.Type.
  3. Start the server so the new engine connects.
  4. /afk admin storage import replaces zones in that engine and overwrites player balances and boosters from the file.

Both commands need afkplus.admin and work from the console. A missing transfer.yml imports nothing.

Suggestions

Stay on SQLite for a single Paper server. Use MySQL only when more than one server must share afk_players. Export before the switch, then check /shards after import and before you edit Rewards.

On this page