Installation
Install InglisCore, finish the setup wizard in your browser and keep the plugin up to date.
Installing InglisCore takes a couple of minutes. There is nothing to configure by hand: the plugin starts with a built in database and guides you through the rest in your browser.
Install the plugin
- Stop your server.
- Drop the InglisCore jar into the
pluginsfolder. - Start the server.
On the first start, InglisCore uses a built in SQLite database. No database server and no setup are needed: every module is ready right away with sensible defaults.
The setup link
When the server has started, the console shows a welcome banner with a private setup link:
================================================================
Welcome to InglisCore!
Finish the setup from your browser:
http://your.server.ip:25565/auth?token=...
================================================================
Open this link in your browser to start the setup wizard. By default the web editor answers on your Minecraft port, so no extra port needs to be opened.
- The setup link stays valid for 24 hours, or until the setup is finished.
- Lost it? Type
/inglis setupin the console to get a new one. - Wrong address in the link (for example a local IP)? Set the right one from the console with
/inglis setup url http://ip:port, then run/inglis setupagain.
Anyone with the setup link can configure your server. Keep it to yourself.
The setup wizard
The wizard has four short steps. Everything you choose here can be changed later from the editor.
- Server language. The language of messages sent to players. Players can still get messages in their own client language.
- Server ID. A short unique name for this server, such as
lobby,survival-1orfactions. It identifies the server on your network and in per server settings. Use lowercase letters, numbers,-and_. - Data storage. Keep SQLite for a single server, or choose MySQL / MariaDB to share data between several servers. For MySQL, fill in the host, port, database, user and password, tick SSL if your database requires it, and press Test. You can only continue once the connection succeeds.
- Starting point. Pick a ready made preset (Friendly survival, Factions / PvP or Minimalist) or keep the default settings. Presets can also be applied later from the Presets page. To start from a full server configuration exported elsewhere, see templates.
Press Finish, then Open the editor. From now on, open the editor at any time with /inglis web. See web editor.
Using MySQL or MariaDB
If you chose MySQL in the wizard, your settings and messages are copied to the new database for you. Restart the server to switch over.
MySQL is required to link several servers together. The other servers of your network then join with an invite code instead of going through the wizard. See network.
If the MySQL database cannot be reached when the server starts, InglisCore starts in safe mode: modules are disabled and only operators can join, so nobody plays on empty data. It retries the connection every 30 seconds and leaves safe mode on its own as soon as the database is back.
Changing the web port
By default the web editor shares your Minecraft port. Some hosts do not allow this, or you may prefer a separate port. You can change it in the editor under System, or from the console:
| Command | What it does |
|---|---|
/inglis setup port <port> |
Serves the editor on a dedicated port as well. Use off to remove it. |
/inglis setup share <on|off> |
Turns sharing of the Minecraft port on or off. |
/inglis setup url <http://ip:port> |
Sets the public address used in access links. Use reset to go back to automatic detection. Console only. |
Port changes need a server restart. If sharing the Minecraft port fails, the console tells you and suggests setting a dedicated port. Remember to open that port in your host's firewall.
/inglis info shows the plugin version, platform, storage, server ID, enabled modules and where the web editor is reachable.
Updating InglisCore
- Download the new version.
- Stop the server and replace the old jar in
pluginswith the new one. - Start the server.
Your settings, messages and player data live in the database and are kept. On a network, update every server so they all run the same version.
Upgrading from the free edition to the complete edition works the same way: replace the jar and everything you set up is kept. See editions.
Commands and permissions
| Command | Permission | Description |
|---|---|---|
/inglis web |
inglis.web |
Gives you a personal link to the web editor. |
/inglis web revoke |
inglis.web |
Closes every open web editor session. |
/inglis info |
inglis.admin |
Shows the plugin status. |
/inglis setup |
inglis.web |
Recovery settings: port, port sharing and public address. |
/inglis join <code> <pin> |
Console only | Attaches this server to a network. See network. |
Every /inglis command also needs inglis.admin. Both permissions are given to operators by default. /inglis also works as /ingliscore and /ic.