Documentation
Getting started

Migration

Bring balances, homes, warps, kits, ranks and sanctions from your old plugins into InglisCore in a few clicks.

Switching to InglisCore does not mean starting from zero. The Import page of the web editor finds the plugins you used before, shows you exactly what will be imported, then copies the data in the background while the server keeps running.

Note

Your old plugin files are only read, never changed. Running an import again never creates duplicates.

Supported plugins

Plugin What can be imported
EssentialsX Balances, homes, warps, spawn, kits, jails, nicknames
CMI Balances
LuckPerms Ranks (groups), player ranks and permissions
LiteBans Sanctions
AdvancedBan Sanctions
Vault Balances from any other economy plugin still running

Players found in these plugins (name, first and last join) are also added, so their history is ready on day one.

Each kind of data goes to a module, and that module must be enabled to receive it: balances go to economy, homes, warps and spawn to teleport, kits to kits, jails to moderation, nicknames to identity, ranks and permissions to ranks, sanctions to sanctions. If a module is off, the editor shows Enable ... first next to that line.

Storage notes

  • EssentialsX is read straight from its data, the plugin does not even need to be installed anymore.
  • CMI balances are read from its SQLite storage.
  • LuckPerms is read directly when it stores its data as YAML, JSON, SQLite, MySQL or MariaDB. For other storage types (H2, the LuckPerms default, or MongoDB), keep LuckPerms installed and running during the scan, or run /lp export first: InglisCore then reads the latest export.
  • LiteBans must use SQLite, MySQL or MariaDB. Its H2 storage cannot be read.
  • AdvancedBan must use MySQL. Its built in file database cannot be read: switch AdvancedBan to MySQL, restart once, then scan again.
  • Vault is a last resort: it reads balances through the economy plugin that is still loaded. When another source already provides balances, the Vault line starts unchecked.

Step by step

  1. Open the web editor with /inglis and go to Import.
  2. Click Scan the server. Each plugin found gets a card with the number of players and, for each kind of data, how many entries were found. Plugins that were not found are listed below the cards.
  3. Tick the data you want. Everything readable is ticked by default when its module is enabled.
  4. Choose what happens when the data already exists (see below). If you have several currencies, pick the one that receives the imported balances.
  5. Click Preview. Nothing is written yet: a table shows, for each kind of data, what will be added, what will be replaced and what is skipped, with the reason for each skipped item.
  6. Click Import and confirm. A progress bar shows each step. You can leave the page and come back.

When it is done, a summary shows what was added, replaced, skipped and any errors. If some items were not imported, click Download the report to get the full list in a spreadsheet, with the reason for each line.

Warning

After the import, remove the old plugins or turn off their matching features, so the same data is not handled twice.

When the data already exists

Option What it does
Keep current What already exists in InglisCore is kept, only new data is imported. This is the default.
Replace The old plugin's data replaces what exists in InglisCore.
Add balances Old balances are added to current ones, only once per player. Everything else behaves like Keep current.

Running it again

You can scan and import as many times as you like. InglisCore remembers what it already imported, so a second run never duplicates a home, a warp, a sanction or a balance. With Add balances, a player's old balance is added only once per currency, even if you run the import again or several plugins hold a balance for the same player.

If the server stops in the middle of an import, simply run it again.

What is not imported

Some things have no equivalent or cannot be converted safely. They are listed in the preview and in the report instead of being silently dropped. The most common ones:

  • Kit entries that run a command or give money, and items the server cannot read.
  • Group spawns from EssentialsX (only the main spawn is imported).
  • Homes, warps or jails in a world that does not exist on this server.
  • LuckPerms permissions tied to a world or another context, meta values, and temporary permissions on a rank.
  • Player ranks pointing to a rank that does not exist.
  • Expired temporary ranks and permissions.
  • A nickname already used by another player.
Tip

Run the import on a quiet moment and do a Preview first. It costs nothing and tells you exactly what to expect.