tshockapi 0.1.2

Quick access to TShock REST API using python.

Quick access to TShock REST API using python.

Endpoints

Server

/status

/tokentest

/v2/token/create

/v2/server/broadcast

/v3/server/rawcmd

/v3/server/motd

/v2/server/off

/v3/server/reload

/v3/server/rules

/v2/server/status

User

/v2/users/create

/v2/users/destroy

/v2/users/read

/v2/users/list

/v2/users/update

/v2/users/activelist

World

/v3/world/bloodmoon

/v2/world/butcher

/world/meteor

/world/read

/v2/world/save

Ban

/v3/bans/create

/v3/bans/destroy

/v3/bans/read

/v3/bans/list

Player

/v2/players/kick

/v2/players/kill

/v2/players/list

/v2/players/mute

/v4/players/read

/v2/players/unmute

Example

import tshockapi  # Import the tshockapi module

server = tshockapi.Server(host="127.0.0.1", port=7878, token="1234567890")  # Create a server object
print(server.v3_server_rawcmd(cmd="/who"))  # Print the result of the /who command
# {'status': '200', 'response': ['There are currently no players online.']}

Installation

Windows

pip install tshockapi

Linux

pip3 install tshockapi