Content generated with AI — it may contain mistakes.

ExyliaMines/Getting started

Installation

The loader jar and the licence, dependencies, how ExyliaLib is installed, the files the plugin generates, the database and updates.

Page 2 of 285 min read

Getting the plugin#

ExyliaMines is a premium plugin, bought on BuiltByBit. It ships through the Lukittu loader, so the file you install is the loader jar, Exylia-Mines-Loader.jar. Bought on BuiltByBit, the licence is embedded in that jar: there is no key to enter. The loader checks the licence on every start and then hands over to the plugin.

Before you start#

PluginWhat for
packeteventsOptional (a soft dependency). Without it the plugin runs and only the packet-drawn extras, such as holograms, stay off.
ExyliaLibRequired, version 1.567.0 or newer. Configuration, menus, database, regions, holograms, loot, effects, schedules, teleports and updates.

Optional, each one adding something when present:

PluginWhat it adds
ExyliaSurvivalCoreIts enchantment limits and blocked items apply inside mines. See Integrations.
ExyliaMarketIts autosell takes the drops of every mine. See Integrations.
PlaceholderAPIThe plugin's placeholders in other plugins: scoreboards, tab lists, hologram plugins.
VaultMoney in loot tables and lucky rewards, through ExyliaLib's economy.
Worlds or Multiverse-CoreNothing to configure: a mine in a world one of them loads late is set up the moment the world loads.
ExyliaLib is listed as soft, and installed for you

plugin.yml names ExyliaLib under softdepend on purpose: the loader is what installs it, so the loader has to be allowed to start without it. On a server without ExyliaLib it downloads the newest release into plugins/ and asks for a restart. On a server running a release older than 1.567.0 it stages the newest one in the update folder and says so in the console; restart once more to apply it. Without network access it skips the install and tries again on the next start — put ExyliaLib.jar in plugins/ by hand.

Installing#

Drop in the jars

Copy Exylia-Mines-Loader.jar and packetevents into plugins/. Add ExyliaLib.jar too if you have it; if you do not, the loader fetches it.

Start the server

The loader checks the licence and hands over to ExyliaMines, which writes its files and creates its tables. You should see ExyliaMines enabled and, once the mines are read from the database, Loaded 0 mine(s).

Restart if it asked you to

Without ExyliaLib, or with one older than 1.567.0, the loader installs the library, says a restart is needed and stops there. Restart once and both plugins start.

Open the editor

With exyliamines.admin, run /minesadmin. See First steps.

Generated files#

All of them live in plugins/ExyliaMines/.

FileContents
config.ymlLanguage, debug, default reset times, tick intervals, sounds, announcement reach and the Fortune rules. See Configuration.
templates.ymlThe starting points offered by Create from template.
boosts.ymlTimed boosts and the schedule that starts them.
lang/<language>/messages.ymlEvery line the plugin sends, the titles and boss bars, the hologram lines.
lang/<language>/menus/user/mines.ymlThe players' /mines menu.
lang/<language>/screens/mines.yml and screens/mines.htmlThe players' /mines list as a native screen.
lang/<language>/menus/admin/The twenty staff menus.
database.ymlThe database engine, written by ExyliaLib. H2 by default, embedded, nothing to install.

<language> is the language the plugin speaks: language in config.yml, which is default — follow ExyliaLib's language — on a fresh install. English, Spanish, Portuguese, French, Russian and Turkish are shipped (en, es, pt, fr, ru, tr); any other code starts as English for you to translate.

menus/admin/ is rewritten on every start

The staff screens are refreshed from the jar each time the plugin starts, so a button added in a release reaches every server. Edits there are lost; nothing an owner is meant to change lives in that folder. The players' menus/user/mines.yml is yours: a release only adds what is missing from it, and a changed default waits in /exylialib updates for you to apply or ignore.

A menu file that fails to parse is named in the console and that one screen is not registered; the rest of the plugin keeps running.

Mines are not in a file

Mines, their cycles, broken blocks, statistics and running boosts live in the database, not in YAML. That is what lets several servers share one database: each mine belongs to the server it was created on, and each server only loads its own.

Database#

By default the plugin uses H2: a file inside the plugin folder, with no server, no installation and no maintenance. It is perfectly fine for a single server.

To share data across servers, edit database.yml:

plugins/ExyliaMines/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.

The plugin creates five tables:

TableOne row per
minesmine: its server, type, area, composition or levels, reset settings, teleports, hologram, loot, effects and Fortune settings
mines_stateclassic mine: blocks mined since its last refill and when the next one is due
mines_broken_blocksblock of a realistic mine waiting to grow back
mines_statsplayer and mine: blocks mined there
mines_boostsboost running on a server

Each table is classified for ExyliaLib's /exylialib wipe and /exylialib resetplayer, which are how its data is reset; the plugin has no reset command of its own. See Commands.

Nothing waits on the database while the plugin enables. The mines are read asynchronously and set up as soon as they arrive, and a player's counts are read when they join.

Updating#

The loader downloads the current release when it starts, so a restart is an update. The loader jar itself only needs replacing when a release asks for it.

Your edits to config.yml, templates.yml, boosts.yml, messages.yml and the players' menu are kept, new keys are added with their comments, and the mines themselves live in the database.

Something missing on this page? Tell us on Discord