Home

#TShockRemoteAdmin#

This tool provides a method to remotely control many operational aspects of at TShock (Terraria) server. The tool is based upon REST API extensions and operates by using a standalone Java program.

An extension (dll) is required to augment the existing REST API functions to provide a more robust set of capabilities used to manage the server. The dll must be placed in the plugin folder similar to all other TShock plugins.

####Getting Started###

The zip download must be extracted into a folder of your choice from which you will run the tool. A subfolder will be created name "resources" which contain various helper files for the tool. The file ExtraAdminRESTAPI.dll must be manually copied into the server's TShock ServerPlugins folder. A restart of the server will allow the new .dll file to be recognized.

####Enable RESTAPI# To use the API first it must be enabled. You can enable it through the config.json file that is created by the TShock server.

To enable the REST API find the following lines in the config.json file (choose a port that is open to your TShock server):

"RestApiEnabled": false, "RestApiPort": 7878,

Change the "false" to "true" and restart the server.

####Java Requirement# To start the remote Admin tool, you must have java installed on the same machine. The version of java must be at least version 7. You may check your version by opening a command level (terminal) windows and typing

java -version

The second digit indicates the version level referenced.

####Starting the Remote Admin tool# To start the Remote Admin tool, open a command level window, navigate to the folder where you unzipped the files and enter the following command -

java -jar TShockAdmin.jar

For users on Ubuntu (an possibly any other Unix derivative), there is a possible problem with a missing Tahoma font family. The issue does not effect the functionality of the tool, however many of the labels/strings will not fit properly on the screen. A temporary workaround is to use a modified java command line to include a more appropriate font family that will closely resemble the Tahoma fonts. Any font name can be used in the following line where "Serif" is now shown.

java -Dswing.aatext=true -Dswing.plaf.metal.controlFont=Serif -Dswing.plaf.metal.userFont=Serif -jar TShockAdmin.jar

####Links# Download | Source | Wiki Documentation

####Changelog# Version 3.3.1 is the starting platform for this tool. The dll is starting with version 3.3.3.1

####Future# The validation process for selecting items to be put in speciality slots, i.e. ammo, armor needs to be put in place.

####Thanks# I want to especially thank member Zaicon for the exceptional help in testing and making suggestions resulting in the finished product as it is released today.

####A personal message# The Remote Admin tool is a complex system and has required a significant amount of development effort. Hopefully you will find that the tool makes your server administration easier and reduces the time spent. If you find it useful I would appreciate your support in continuing the support and enhancement of this tool. Please consider donating a bit back to me. I appreciate any support you can provide.

####Legal Stuff# Comments are always welcome. If you have a suggestion for an improvement please don't hesitate to contact me. The dll is offered as an open source project. However, the tool is intellectual property of its developer and thus may not be used in any way without the consent of the copyright owner. Anyone may use this tool without asking for permission.