Admin Tool

Thrall Wars comes with an optionally downloadable admin tool that allows you to remotely manage large parts of your server.

Features include:

* Seeing who is online

* Sending messages to individual players as well as the entire server
* Kicking and banning players
* Doing family share checks
* Giving characters items
* Renaming characters
* Changing pippi ranks of characters
* Listing all clans on the server
* Checking building limits of clans

## Requirements

* Most parts of this tool require Pippi and the Thrall Wars Dungeon Mod to work properly. It is highly recommended you have both of them installed in your server
* The "Mark Donator" feature requires a Pippi rank called "Donator" set up already.

## Configuration

### Configuration File

The admin tool can be configured with the **settings.json** file, which is localed in the **Saved** folder of your installation. The default location is **C:\Program Files (x86)\Thrall War\Thrall War Remote Admin\Saved\settings.json**.

Every time we post new version of the Remote Admin Tool, your **setting.json** file will stay intact. You will only need to set it up once. We recommend you to make a **settings.json** for your server and hand it out to your other admins to give them remote access!

You can override the config file location with the environment variable **TW\_SETTINGS\_LOCATION**

Configuration uses the json format. Please familiarize yourself with it if you have not already: https://www.w3schools.com/js/js\_json\_intro.asp

### Configuring server connections

The admin tool can have connections to multiple servers. You configure them in the **settings.json** under the key **Servers.**

Each server gets it's own entry, like this:

```
{
 "Servers": [
 {
 "Description": "My Server 1",
 "IPNumber": "127.0.0.1",
 "Port": 25575,
 "Password": "verysecret"
 },
 {
 "Description": "My Server 2",
 "IPNumber": "192.168.1.1",
 "Port": 25575,
 "Password": "verysecret"
 }
 ]
}

```
You need to modify the Description, IPNumber, Port and Password and change it to your server's configuration before.

### Configuring build count limits

The admin tool has a feature to check build counts for clans, but it will need to be configured properly in **settings.json**. For now, building limits are configured based on the clan size. You will need to add one entry to the **settings.json** for each possible size of clans on your server.

Open the settings.json in a text edtior of your choice, for example notepad++. It might look like this:

```
{
 "Servers": [
 {
 "Description": "My Server 1",
 "IPNumber": "127.0.0.1",
 "Port": 25575,
 "Password": "verysecret"
 },
 {
 "Description": "My Server 2",
 "IPNumber": "192.168.1.1",
 "Port": 25575,
 "Password": "verysecret"
 }
 ]
}

```

Add a new key to the json named "BuildCountLimits", which is an array, like this:

```
{
 "Servers": [
 {
 "Description": "My Server 1",
 "IPNumber": "127.0.0.1",
 "Port": 25575,
 "Password": "verysecret"
 },
 {
 "Description": "My Server 2",
 "IPNumber": "192.168.1.1",
 "Port": 25575,
 "Password": "verysecret"
 }
 ],
 "BuildCountLimits": [

 ]
}

```

And now add an entry for each possible clan size like this:

```
{
 "Servers": [
 {
 "Description": "My Server 1",
 "IPNumber": "127.0.0.1",
 "Port": 25575,
 "Password": "verysecret"
 },
 {
 "Description": "My Server 2",
 "IPNumber": "192.168.1.1",
 "Port": 25575,
 "Password": "verysecret"
 }
 ],
 "BuildCountLimits": [
 {
 "Members": 1,
 "AllowedBuildingPieces": 500,
 "AllowedPlaceables": 200
 }
 ]
}

```

Where **Members** is the clan size for which the building limits are in effect. Save and restart your admin tool. You should now be able to use the build count feature!