On a TShock server, open the Modding tab, search for a plugin on the Plugins tab and click Install. The panel puts the plugin and every plugin it needs into ServerPlugins. TShock loads plugins when it starts, so restart the server afterwards.
Your server must be on the TShock type first: How to switch your Terraria server to TShock or tModLoader.
Install a plugin
- Open your server in the panel and click the Modding tab.
- The TShock card at the top explains the framework. Below it, on the Plugins tab, make sure Browse is selected.
- Type a name in the search box. The plugins come from the TShock plugin collection published by UnrealMultiple, the plugins with an English description.
- Click Install on a plugin.
- The panel says
<name> is in ServerPlugins, with any plugins it needs. TShock loads it the next time the server restarts. - Restart the server. The Console shows TShock loading its plugins as it starts.
You need the Create and upload file permission to install. Seeing the list needs Browse files.
See what is installed
Click Installed on the Plugins tab. It lists the plugin files in ServerPlugins that belong to the collection, including libraries that came along with a plugin, such as LazyAPI or linq2db. TShock's own TShockAPI is not listed, and neither is a plugin you uploaded yourself that is not in the collection: see it in Files, in ServerPlugins.
Settings and commands of a plugin
Most plugins write their settings into the tshock folder the first time they load. Open it in Files after a restart. Their commands are TShock commands: type help in the Console to list them. Some need a permission in a TShock group: How to manage TShock groups and permissions.
Good to know
- Installing a plugin that is already there replaces it with the version in the collection.
- After a TShock update, older plugins may need an update too. TShock says so in the Console when it updates.
- A plugin that is not in the list can still be uploaded by hand: How to upload or remove a TShock plugin.
- If Install fails or a plugin does not load: A TShock plugin will not install or load.
- Back up before you add many plugins: How to back up and restore your Terraria world.
