Skip to content
Robert edited this page Mar 31, 2015 · 5 revisions

#Remote Admin Console#

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 windows 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. An executable windows program and a dll named Newtonsoft.Json.dll are necessary to run the tool on the windows computer. 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.

####WindowsRequirement# To start the remote Admin tool, click on the windows program RemoteAdminConsole.exe.

####Links# Source | Wiki Documentation

####Future# All suggestions for future functionality are welcome.

####Thanks# I want to especially thank member Zaicon for the exceptional help 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. Anyone may use this tool without asking for permission.

Clone this wiki locally