Skip to content

Getting Started

Mark edited this page Apr 16, 2018 · 13 revisions

Getting Started

Installation

To install AdamantineShield, download the plugin from the Releases page (recommended version is 0.4.1) and place it in the mods folder of your server.

Upon starting the server, AdamantineShield will generate the configuration file. Stop the server and edit the configuration file as needed. Visit the Configuration page for more information on how to do this.

The server will likely produce an error about being unable to connect to the database, unless one is run on your local system and does not require a password. Once you have an empty database set up (preferably MySQL), enter the correct credentials into the configuration file.

While the option to use a local file-end database exists, this is not recommended for actual servers. File-end databases become very slow as they grow in size, especially without a SSD.


Usage

First, set the permissions for all players that should have access to the AdamantineShield commands. The following wildcard permissions can be used to make the permission setup easier:

  • adamantineshield.use.lookup - for the lookup/inspector commands.
  • adamantineshield.use.rollback - for the rollback commands. (Currently not yet implemented)
  • adamantineshield.admin - for powerful administrative commands, such as database purging.

Check the Commands page for a full list of commands and their respective permissions.

For an in-depth explanation about lookups, refer to the Lookup page.

AdamantineShield

Navigation

Setup

Usage

Clone this wiki locally