TShock: a developer readme answering a question it says it does not cover
☕️⚡️TShock provides Terraria servers with server-side characters, anti-cheat, and community management tools.
At a glance
- What is it?
- TShock is a C# toolbox that gives Terraria servers anti-cheat, server-side characters, groups, permissions and item bans. This readme is explicitly the developers and hackers document, it hands the operator questions to a documentation site that is still a work in progress, and the build instructions it does give produce a binary that is not self-contained.
- Who is it for?
- Treat this repository as the source of a server toolkit, not as a guide to running one. Anyone who only wants a working Terraria server has to find the operator documentation elsewhere, and the page names that destination as still unfinished.
- Can I use it commercially?
- Yes, with conditions. GPL-3.0 is a copyleft licence: if you distribute software that includes it, you must release that software's source code under the same licence. Running it internally without distributing it does not trigger that obligation.
- Is it still maintained?
- Yes. The repository last received commits 5 days ago.
- What is it written in?
- Mainly C#, according to GitHub's language statistics.
Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.
Star history
- Pryaxis/TShock2,911 ★ · +17
| Repository | 2026-10-04 | 2026-11-15 |
|---|---|---|
| Pryaxis/TShock | 2.9k | 2.9k |
17 Stars in the last 42 days, measured from the daily GitHub snapshot. Compare with other projects
Editorial analysis
The readme says it is for developers and hackers, not operators
The page states its own audience in the second paragraph: this is the readme for TShock developers and hackers. Server operators and plugin developers are being sent somewhere else, to a new TShock documentation site at ikebukuro.tshock.co, and the sentence that follows says that documentation is a work-in-progress right now. That leaves a gap with a shape worth naming. The feature sentence before it is written for anyone: TShock is a toolbox for Terraria servers and communities, packed with anti-cheat tools, server-side characters, groups, permissions, item bans and a long list of commands. So the capabilities are advertised on a page that then declines to explain how to deploy them, and the destination for that explanation is described as incomplete. Everything below the audience line is developer material: cloning the repository, building it, and working with the Terraria assembly it links against.
Every published command sets self-contained false
The packaging instruction is one line, and one flag in it decides what the operator has to install:
dotnet publish -r win-x64 -f net9.0 -c Release -p:PublishSingleFile=true --self-contained falsePublishSingleFile produces one executable, and self-contained false takes away the other half of that convenience: the .NET runtime is not bundled, so it has to already be present on the machine that runs the server. The same pair of flags appears in the Dockerfile, which runs the same publish with -o output/ and the same --self-contained false, so the container image makes the same assumption using the dotnet runtime base images rather than the SDK one. The target framework is pinned to net9.0 in both places, matching the .NET 9 SDK the build guide asks for. The build sequence itself is three commands, with the submodule flag doing real work:
git clone https://github.com/Pryaxis/TShock.git --recurse-submodules
cd TShock
dotnet buildRunning a server from a checkout is a separate command, dotnet run --project TShockLauncher, from the repository root rather than from inside TShockLauncher.
The container accepts four platforms, the readme lists five, and Apple Silicon is in neither
The two lists of supported targets do not match. The readme says a release can be built for win-x64, osx-x64, linux-x64, linux-arm64 or linux-arm, and that the output lands in TShockLauncher/bin/Release/net9.0/ under the architecture you picked. The Dockerfile translates a buildx platform string into one of those runtime identifiers with a case statement: linux/amd64 to linux-x64, linux/arm64 to linux-arm64, linux/arm/v7 to linux-arm, windows/amd64 to win-x64, and anything else falls through to an echo of Error: Unsupported platform followed by exit 1. So the container accepts four platforms against the readme's five, osx-x64 being the one the case statement omits. Apple Silicon appears nowhere in either list: there is no osx-arm64 runtime identifier and no darwin branch. The runtime stage makes the same narrowing in a different way, defining a linux_base image and a windows_base image and then selecting between them with FROM ${TARGETOS}_base.
Building needs the decompiled Terraria sources, and access is tied to contributing
The dependency that is not a NuGet package is Terraria itself. Because of how OTAPI works, plugins get direct access to all public fields in the Terraria namespace and can call Terraria member methods directly, which the page compares to net.minecraft.server calls in CraftBukkit. Those fields live in game code, so the page explains where to find them: Pryaxis provides the decompiled sources to Terraria's server, updated with each release, made available to developers of TShock. The access condition is stated in one sentence: if you have submitted a pull request to TShock, reach out on Discord to get access. The stated alternative is to download ILSpy and decompile Terraria or the server yourself. So the reference assembly a plugin compiles against is proprietary game code, reachable either through a contribution-gated channel or through a local decompile, and the TerrariaServerAPI entry at the top of the tree is why the clone step needs --recurse-submodules rather than being optional.
Direct field access is the API shape every plugin inherits
The developer guide spends a paragraph on why TShock plugin code does not look like other .NET work. Working with Terraria in TShock and in other Terraria Server API plugins is different from most other APIs, and the reason given is the nature of how OTAPI works: you have direct access to all public fields in the Terraria namespace, and you can access Terraria member methods directly. TShock and other plugins do this often, mostly to modify the game world, send data and receive data, with calls to Main given as the example of that direct access. The practical consequence is that there is no wrapper layer between a plugin and the game state, so a plugin can reach further than its author intended and a server operator's isolation assumptions do not hold. The page also points at the TShockResources organisation for other plugins to build on, notes that TShock is itself a plugin, and says most plugins are open source.
The release titles drop the minor version at 6.0.0
Three tags appear in the release list and their titles are not formatted the same way. Tag v6.2.1 is titled TShock 6.2.1 for Terraria 1.4.5.8 and is dated 2026-09-27. Tag v6.1.0 is titled TShock 6.1 for Terraria 1.4.5.6, dated 2026-03-11. Tag v6.0.0 is titled TShock 6 for Terraria 1.4.5.5, dated 2026-03-08. So the third release drops the minor component from the product name inside the title while keeping it in the tag, and the convention does not come back for 6.1. Two other details are worth reading off the same list. The 6.0.0 and 6.1.0 tags are three days apart, which suggests a major line cut followed quickly by a feature release rather than a long stabilisation period. And the newest tag, 6.2.1, is dated four days after the last push recorded on the default branch general-devel, which puts the branch behind the release it produced. Each title also pins a Terraria version, so a TShock build and a Terraria build are matched by hand.
The container splits config, worlds and plugins into three volumes
The runtime image declares three volumes and two exposed ports, and the entrypoint wires the volumes to command line switches. VOLUME covers /tshock, /worlds and /plugins. The entrypoint runs ./TShock.Server from a working directory of /server, and passes -configpath /tshock, -logpath /tshock/logs, -crashdir /tshock/crashes, -worldselectpath /worlds and -additionalplugins /plugins. So configuration, logs and crash dumps all land inside one volume, world selection lives in a second, and anything dropped into the third is loaded as an additional plugin directory at startup. EXPOSE lists 7777 and 7878, and the page does not say which service answers on which. The builder stage installs gettext before compiling, with the comment Install msgfmt for i18n, which is the one build-time dependency the image declares beyond the .NET SDK. The final image copies the publish output from the builder and nothing else, so anything not produced by dotnet publish has to arrive through a volume.
COPYING, appveyor.yml, crowdin.yml and prebuilts share one tree
The top level of the repository carries several parallel systems rather than one. The licence file is COPYING rather than LICENSE, and the repository licence field reads GPL-3.0. Continuous integration appears twice, as appveyor.yml alongside a .github/ directory, matching the two build badges in the page header. Translation has its own apparatus: crowdin.yml, an i18n/ directory and a README_cn.md linked from the header with a Chinese label. There is also a prebuilts/ directory, so binaries and sources live in the same repository, and a TShockLauncher.Tests/ project, a TShockInstaller/ project, a TShockPluginManager/ project, docs/, scripts/ and a .vscode/ directory. The code of conduct is quoted in full on this page and its second rule is unusual enough to quote as well: do not attempt to circumvent or bypass the code of conduct by using clever logic or reasoning, with the example given being insulting Facepunch members because they were not directly mentioned. The first rule adds that members adhere to United States and international law.
Editorial conclusion
Treat this repository as the source of a server toolkit, not as a guide to running one. Anyone who only wants a working Terraria server has to find the operator documentation elsewhere, and the page names that destination as still unfinished. For developers, the checklist before starting is short and specific: install the .NET 9 SDK, clone with submodules, build, and get the decompiled Terraria server sources before you write a line of plugin code. Decide early whether you are publishing for Apple Silicon, because the documented runtime identifiers stop at osx-x64 and the container build refuses any platform outside four Linux and Windows targets. And remember that both publish paths pass --self-contained false, so the runtime has to exist on the machine that runs the result.
Frequently asked questions
What is TShock?
It is a toolbox for Terraria servers and communities, described as packed with anti-cheat tools, server-side characters, groups, permissions, item bans and a long list of commands. It is a C# project licensed GPL-3.0 and releases are titled against a specific Terraria version.
how to install tshock
This page does not cover operator installation. It states it is the readme for TShock developers and hackers, and points server operators and plugin developers to a documentation site that is described as a work-in-progress right now. What it does give is a source build requiring the .NET 9 SDK, and a publish command that produces a single file executable without the runtime bundled.
Is TShock free?
The page states no price or cost for the software, and the repository licence field reads GPL-3.0. Whether a Terraria server itself costs anything is a separate question the page does not address at all.
How do I build TShock from source?
Install the .NET 9 SDK, then clone the repository with submodules, enter the directory and run dotnet build. To run a server from the checkout, run dotnet run --project TShockLauncher. Visual Studio 2022 or Visual Studio Code can be used instead of the command line.
Which platforms can TShock be published for?
The page lists win-x64, osx-x64, linux-x64, linux-arm64 and linux-arm. The Dockerfile's platform case statement accepts linux/amd64, linux/arm64, linux/arm/v7 and windows/amd64, and exits with an unsupported platform error for anything else, so macOS builds have no container path.
Where do I get the Terraria server sources that TShock plugins compile against?
Pryaxis provides the decompiled sources to Terraria's server, updated with each release. The page says that if you have submitted a pull request to TShock you should reach out on Discord to get access, and that the alternative is to download ILSpy and decompile Terraria or the server yourself.
Official sources
Add this badge to your README
If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.
[](https://hysenlabs.com/projects/pryaxis-tshock)Star history chart for your README
[](https://hysenlabs.com/projects/pryaxis-tshock)Was this useful?