Tutorial TShock Complete Reference Guide - Everything You Need to Know

Ijwu · May 26, 2012

TShock guide and reference thread.

This will be a basic tutorial for setting up a TShock server that will touch on everything TShock has to offer. It will also be a complete command reference area at the end; taking form as an appendix.

Don't hesitate to inform me of any mistakes I've made in the thread or in PM. Don't hesitate to pick apart anything I've written if you feel it's wrong. The point is to provide the most accurate information possible, after all.

Note: Hopefully I'll be able to keep up with TShock updates in updating this thread. But there may be a point where I'm unable to do so. Be sure to keep an eye on the last time this thread was updated in order to ensure it's up to date.

Index:

First Steps In Your Server

User Groups and Basic Player Organization

Permissions and Advanced User Group Configuration

Setting Up Regions; Basic Region Use

Advanced Region Management and Region Command Reference

Item Banning and Item Ban Management

Item Bans and their Interactions With Groups

Mobility; How to Get to Places Fast

"Hei guiz can i hav hallow pls?"

Let's make things happen

Don't worry, I've got this under control!

Expanding TShock: Plugins and You

Ijwu · May 26, 2012

First Steps In Your Server - Show:

First Steps In Your Server - Show: |First Steps In Your Server - Hide:

When you first run TShock, it will inform you of an Auth-Code in the console. You may log in to the server and use this code to verify your character as the super admin. This will also lock the auth code system. You must join the server on your character, use /auth [authcode] and then register and log in. Then use the /auth-verify command. To register and log in you need to run the command /register [password] to create an account under your username with the password you put in. Now you may use /login [password] to login. You must use the password you used upon registration.
User Groups and Basic Player Organization - Show:

User Groups and Basic Player Organization - Show: |User Groups and Basic Player Organization - Hide:

As a now-verified superadmin, you can do a number of things involving users and user groups.

It should be understood that there are no 'admins' or 'moderators' in TShock. It's sort of an abstract concept, compared to what you may be used to, but bear with me. How the groups work in TShock is that you create them and assign them permissions. Permissions allow the group members to perform specific actions based on the permissions. For example: you might want your "admin" group to have the "kick" permission. That is, to allow them to kick people out of the server. You might have named it "admin" but the group you made isn't an admin group. It's just a group with the ability to kick people.

You have a suite of user commands at your disposal. They all fall under the /user command. You must specify a sub-command to perform specific actions.

These are the sub-commands for the /user command.

add

del

password

group

help

Each of these sub-commands is added to your main command when you run /user. For example, if I want to use the group sub-command, I would input /user group. The same goes for all of the others.

Each sub-command requires its own arguments, or specifications. These arguments let you tell the command what it is you want it to edit or what it is you want it to do.

Let us keep using the /user group example and illustrate the use of arguments.

This sub-command allows us to move a user from one group to another. The group sub-command requires these arguments: [username] [newgroupname]. We need to tell it which user we want to move and to which group we want them in.

Here is an example use for this command:

Code:

/user group Ijwu superadmin

Now that you know how the command, sub-commands, and the arguments work. I'll list all of the sub-commands, their required arguments, a brief description, and an example usage.

/user subcommands list - Show:

/user subcommands list - Show: |/user subcommands list - Hide:

Sub-command: add

Arguments:

Code:

[username:password] [group]

Note: This is in a code block because of the colon and the P creating a smiley face. Please ignore this code block, the information is the same for all intents and purposes.

Description: This allows the host or a superadmin to register an account intentionally and immediately. If you wish to reserve a name for a friend, you may use this command. If you wish to take a name out of the 'pool' of available names, you may also use this. This can also be used to register administrator accounts.

Example usage:

Code:

/user add Ijwu:123 superadmin

Sub-command: del

Arguments: [username]

Description: Deletes a registered account from your TShock database. This opens the account up again and allows the name to be registered to another person.

Example usage:

Code:

/user del Ijwu

Sub-command: password

Arguments: [username] [newpassword]

Description: Allows you to change a user's password. This is incase they lose it, want a new one, you're a jerk, or any other reason you can contrive.

Example usage:

Code:

/user password Ijwu 1234

Sub-command: group

Arguments: [username] [newgroup]

Description: Allows you to change a user's group. This can be done to promote or demote them by granting or taking away permissions which may be inherint in each group.

Example usage:

Code:

/user group Ijwu guest

Sub-command: help

Arguments: None

Description: Provides basic help about the /user command and tells you everything I've spent 20 minutes writing. If you didn't use this command before reading this then you're doing something very, very, wrong.

Example usage:

Code:

/user help
Permissions and Advanced User Group Configuration - Show:

Permissions and Advanced User Group Configuration - Show: |Permissions and Advanced User Group Configuration - Hide:

You might want to create or delete usergroups. This can be easily done using the /addgroup [name] [optional permissions] command. This can add the group with the name specified and also give it any initial permissions you wish to provide. You can then delete user groups with the /delgroup [name] command. This will simply remove the group of the specified name.

You may also gather information about the user groups currently a part of your server. To find out which groups your server has you can use the /group list command. This will output all of the groups that are a part of your server. You can also find which permissions are a part of a group using the command /group perm [group name]. This will output which permissions are granted to the specified group.

Now that you're able to organize your players into separate groups, you may want to allow or disallow them from performing specific actions. This can easily be done with the /modgroup command.

The /modgroup command allows you to add or delete permissions for a specific group. To re-iterate, permissions are special settings that allow a group to perform certain actions.

The /modgroup command has two sub-commands.

The subcommands will now be listed exactly as I listed the user sub-commands:

modgroup sub-commands - Show:

modgroup sub-commands - Show: |modgroup sub-commands - Hide:

Sub-command: add

Arguments: [group] [permission]

Description: Allows you to add the specified permission to a user group. This allows them to access all commands or abilities associated with the permission.

Example usage:

Code:

/modgroup add admin warp

Sub-command: del

Arguments: [group] [permission]

Description: Allows you to take away a permission from a specific group. This denies them access to all of the commands associated with the permission.

Example usage:

Code:

/modgroup del admin ban
Setting Up Regions; Basic Region Use - Show:

Setting Up Regions; Basic Region Use - Show: |Setting Up Regions; Basic Region Use - Hide:

As an aspiring server admin, you might have come across the problem of areas in your world constantly being changed that you wish to have protected.

You can use the region commands to accomplish this. Moreso, the region commands also allow more specific options. Those are to be explained in the next section.

To create a basic region, you must set two corners of a rectangle. The distance between these two corners will determine the width and height of the rectangles. You need to use the /region set command to do this. Keep in mind that there are two corners to set. To set the first corner of the rectangle, you must use the /region set 1 command and then edit any tile in the world. This edit can be breaking a tile (don't worry, it will come back!), clicking on a tile but not breaking it, setting a tile, shooting an ice rod shot, placing or breaking wires, or just editing that tile in any way. Once you've done so, you can then set the second point to complete the rectangle. To set the second point you need to use the /region set 2 command and edit any tile like you did for the first point.

With a rectangle like this selected, you may cause certain things to occur, or prevent them from occuring, to every single block in the area of the rectangle.

In this part of the tutorial we'll just turn on region protection. This denies editing of any of the tiles in the region to anybody without permission. To do this we need to define our region. We have the region set temporarily with the two points we set. Now we need to make it permanent and give it a name. You can use the /region define [name] command to do this. Just fill in whichever name you would like.

Next, we need to protect our region. To do this we'll set the 'protect' flag in the region to true. To protect the region you should use the /region protect [name] true command. This sets 'protection' to true in the region you specified. You can also disable the protection by using the /region protect [name] false command. This means the "true" and "false" parts of the command are interchangeable.

Note: Region names ARE case sensitive. If you wish to have a region with multiple words, use quotation marks around the region name. I cannot stress that enough. If you want a region named my region then use "my region" in your commands, literally!

Ijwu · May 26, 2012

Advanced Region Management and Region Command Reference - Show:

Advanced Region Management and Region Command Reference - Show: |Advanced Region Management and Region Command Reference - Hide:

Let's pretend for a moment. Let's say you've set a region but you didn't make it big enough, or it's not covering the tiles you'd like it to. You can change the boundaries of a defined region with a special command.

This command is the /region expand command. It is very useful and allows on-the-fly region modification. To use the /region expand command you need to have, of course, already set a region and defined it. Now, if you feel you want to expand one of its boundaries you will have to keep in mind which side you want to expand. You need to provide the command with the region name, the side you want to change, and the amount you want to change it (in tiles).

An example usage for this command would be /region expand region1 r 2. This would expand the region "region1" by 2 tiles to the right. Notice that I used the letter "r" in place of the word "right". They are interchangeable. The four directions you may expand a region to are up (u), down (d), left (l), and right (r). These commands are intuitive and you should even be able to guess them.

Note: The expand sub-command may be interchanged with the sub-command "resize". /region expand region1 left 2 and /region resize region1 left 2 cause the same effect.

You might want to only allow certain people to be able to change a region. Perhaps you have two separate teams and you want each team to have their own build site. Or perhaps you want to give a certain person a specific build area. These things are all possible using TShock's region commands.

You may use the /region allow command to allow a specific user to access and change a region. This user will behave as if everything is normal when in the region due to being added to the exception list. To add a user to a region you need to pass the region and user names to the command. Here is an example of the usage: /region allow Ijwu region1.

Inversely, you may remove a player from a group. This can be done with the /region remove command with the same syntax. An example would be /region remove Ijwu region1.

You may do they same thing with whole groups. These group commands use the same syntax but the commands are /region allowg and /region removeg. Since the general idea of these commands is explained above, these will be explained in the command list below.

region subcommands list - Show:

region subcommands list - Show: |region subcommands list - Hide:

Note: There are commands in here not explained above. It is highly recommended you read this list top to bottom!

Sub-command: set

Arguments: [1 or 2]

Description: Sets the designated temporary point for the area you are trying to highlight as a region.

Example usage:

Code:

/region set 1

You then proceed to edit any tile to set it as the point.

Sub-command: define

Arguments: [region name]

Description: Once you've designated both points with /region set, you may turn them into a region by using this command.

Example usage:

Code:

/region define region1

Sub-command: name

Arguments: None

Description: Once you run this command, you may hit a tile to retrieve which region it is a part of.

Example usage:

Code:

/region name

Then you hit any tile.

Sub-command: protect

Arguments: [region name] [true or false]

Description: Turns the protection of a region on or off depending on which option you used.

Example usage:

Code:

/region protect region1 true

Sub-command: delete

Arguments: [name]

Description: Deletes the specified region.

Example usage:

Code:

/region delete region1

Sub-command: clear

Arguments: None

Description: Clears any and all of the temporary points you may have selected.

Example usage:

Code:

/region clear

Sub-command: allow

Arguments: [user name] [region name]

Description: Allows a user to have normal permissions within a region. Allowing them to build and act normally within it.

Example usage:

Code:

/region allow Ijwu region1

Sub-command: remove

Arguments: [user name] [region name]

Description: Removes a player from a region's permissions list. This player can not build or act normally within the region that they are removed from.

Example usage:

Code:

/region remove Ijwu region1

Sub-command: allowg

Arguments: [group name] [region name]

Description: Allows a whole usergroup to edit and behave normally within a region. This command can be used for teams and large bulks of players.

Example usage:

Code:

/region allowg admin region1

Sub-command: removeg

Arguments: [group name] [region name]

Description: Removes a whole usergroup from having the ability to edit or act normally within the specified region.

Example usage:

Code:

/region removeg admin region1

Sub-command: list

Arguments: None or [page number]

Description: Shows you a list of the regions currently created in the world and server you're in. If the amount of regions exceed the amount a page may hold, then you can increment the pagenumber you used to see more.

Example usage:

Code:

/region list

Sub-command: info

Arguments: [region name]

Description: Shows you information about the region you provided. This will show the position, size, name, and options of the region.

Example usage:

Code:

/region info region1

Sub-command: expand

Arguments: [region name] [direction] [amount]

Description: Moves a region's borders in the direction specified by the amount specified. The directions available are: up, down, left, and right. They may also be abbreviated to: u, d, l, and r. You may use a negative number to contract the region.

Example usage:

Code:

/region expand region1 l -2

Sub-command: resize

Description: This command is synonymous to the expand command. They are both the same.

Sub-command: z

Arguments: [region name] [z-number]

Description: Sets the z-index for a region. The region with a smaller z will take precedence over any region it overlaps that has a higher z.

Example usage:

Code:

/region z region1 3

Sub-command: help

Arguments: None

Description: Shows similar, albeit less, information to what I've written in this tutorial area.

Example usage:

Code:

/region help
Item Banning and Item Ban Management - Show:

Item Banning and Item Ban Management - Show: |Item Banning and Item Ban Management - Hide:

You may feel the need to disallow certain items on your server. You may feel threatened by free-roaming griefers or you wish to keep the balance in your roleplay environment. It is possible to ban certain items from being used on your server.

With the manageitem permission you may add items to the server-wide ban list. To do so you need to use the /additem [itemname] where the itemname is the item you wish to add to the ban list. You may also use the /banitem [itemname] command for the same effect. If you wish to see what items you have banned you may use the /listitems command, also: the /listbanneditems command has the same effect. If you wish to remove an item from the ban list then you may use the /delitem [itemname] command to remove the itemname from the list of banned items. Similarly, you may use the /unbanitem [itemname] for the same effect.

Item Bans and their Interactions With Groups - Show:

Item Bans and their Interactions With Groups - Show: |Item Bans and their Interactions With Groups - Hide:

Now that you know how to block items from being used, you might want to allow a trusted user group to use one of your banned items. This is very possible with the itemgroup commands. You still require the manageitem permission.

To allow a group to use an already banned item you must use the /additemgroup [itemname] [groupname] command. This command will allow access to the specified item for the specified group. That user group will then be able to use the banned item you allowed them. You may undo this action with the /deleteitemgroup [itemname] [groupname] command. This command restricts access to a banned item for a group that has been given access to that item. The specified item will be re-blocked for the specified group.

Ijwu · May 26, 2012

Mobility; How to Get to Places, Fast - Show:

Mobility; How to Get to Places, Fast - Show: |Mobility; How to Get to Places, Fast - Hide:

Your players may find it tedious to traverse the game world to their homes or to certain areas each time they wish to move around. It is possible, with TShock, to make it much easier to travel around the world warp and tp commands are available for use. Should you belong in a usergroup that has the managewarps permission then you may create and delete warps. To create a warp you need to use the /warp add [name] command. The warp will be created at the position you are standing on and it will take on the name that you provided the command.

With the warp permission a user group can teleport to warps. First, though, they need to know which warps exist. To find a list of the available warps in a world a player may use the /warp list [page number] command. Putting in no argument for the page number will default to the first page. They need only use the /warp [name] command, entering the name of the warp to teleport to it. Remember, the commands to set and teleport to warps are case-sensitive. With the tphere permission, a player may send another player to a warp using the /warp send [playername] [warpname] command. This command sends the specified player to the designated warp.

If you wish to teleport to a player or bring them to you, then you have that ability! With the tp permission, one can use the /tp [name] to instantly change their position to the position of the player named. Partial name matches are allowed! With the tphere permission one can use the /tphere [name] to bring the named player to themselves.

With the tp permission a player can also use /home command to teleport themselves to their personal spawnpoint. With the tp permission, you may also use the /spawn command to move yourself instantly to the world spawn point.

Hei guiz can i hav hallow pls? - Show:

Hei guiz can i hav hallow pls? - Show: |Hei guiz can i hav hallow pls? - Hide:

Well, you have regions set up. You know how to get around. You have huge aspirations to build a house out of gold. You have no gold...

Not a problem. With TShock's item commands you can very easily create the items you need with minimal input. With the item permission, a player or user group are allowed to use the /item [itemname] [quantity] command. This command gives the user the item they specified in the amount specified. The quantity argument is optional, it will always default to a max-stack of that item. The item names can be partial matches but they must narrow down to only one item. If you wish to input an item whose name has multiple words then you must use quotes for the item's name. An example of spawning a multi-word item would be /i "pearlstone brick wall". This would spawn 250 pearlstone brick walls, it makes 250 because 250 is the max stack amount for this item. You may have also noticed I used /i instead of /item, that is because /i is an alias and works the same.

Next up is having players asking you for items. But... You don't want to grant them the permission to spawn any item they want. You have the ability to give players items, with the item permission; of course. The /give [item name] [playername] [quantity] command will allow you to give the specified item in the specified quantity to the specified player. The quantity argument is optional again, and will default to the max stack size.
Let's make things happen - Show:

Let's make things happen - Show: |Let's make things happen - Hide:

You might find the need to spice your online Terraria experience up a bit. As an admin, you're able to make certain events take place to enchance your time. With the causeevents permission, you're able to cause a series of different events to occur with commands.

You might want to have a treasure hunt. It's not a problem with the /dropmeteor command. Exactly as it's named, this command will drop a meteor on your world. Good luck finding it. Speaking of dropping treasure, you can use the /star command to drop a star somewhere on your world.

Want a challenge in PvE? Feel free to use the /fullmoon command to bring out all of the werewolves. If that's not enough for you then the /bloodmoon command might make things more challenging.

You could always, of course, use the /invade command to call a goblin invasion. You way provide a number argument to decide on the amount of goblins you want to appear.

Ok, the goblin invasion is a bit boring. That's why you can use commands to spawn any boss with the spawnboss permission.

So I don't have to get too far into it: here's a list of all of the boss spawning commands. (Copypasted right out of the appendix)

boss spawners - Show:

boss spawners - Show: |boss spawners - Hide:

Command: /eater
Arguments: [amount]
Description: Spawns the Eater of Worlds in the amount provided. The amount defaults to 1.
Permission needed: spawnboss
Example usage:

Code:

/eater 20

Command: /eye
Arguments: [amount]
Description: Spawns in the Eye of Cthulhu in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/eye 20

Command: /king
Arguments: [amount]
Description: Spawns the King Slime in the amount provided. The amount defaults to 1.
Permission needed: spawnboss
Example usage:

Code:

/king 20

Command: /skeletron
Arguments: [amount]
Description: Spawns Skeletron in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/skeletron 20

Command: /wof OR /wallofflesh
Arguments: None
Description: Spawns one Wall of Flesh. There can only be one Wall of Flesh in play at any moment and the spawning player must be in the Underworld upon command usage.
Permission needed: spawnboss
Example usage:

Code:

/wof

Command: /twins
Arguments: [amount]
Description: Spawns The Twins in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/twins 20

Command: /destroyer
Arguments: [amount]
Description: Spawns The Destroyer in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/destroyer 20

Command: /skeletronp OR /prime
Arguments: [amount]
Description: Spawns Skeletron Prime in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/prime 20

Command: /hardcore
Arguments: [amount]
Description: Spawns ALL of the bosses at once in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/hardcore 9001

You are also able to spawn any mob by name using the /spawnmob or /sm command. You need the spawnmob permission. This lets you spawn any mob in any amount up to 200. Example:

Code:

/sm "demon eye" 150
Don't worry, I've got this under control! - Show:

Don't worry, I've got this under control! - Show: |Don't worry, I've got this under control! - Hide:

Lol, no you don't; not yet, at least.

At some point in time you will encounter those players bent on making the gaming experience horrible for other people. These people will cause harm to your world and your players and you'll need a way to control them.

With the kick permission you are able to use the /kick permission to immediately remove a player from the server. They will be able to, however, re-join the server immediately. You may provide a reason to kick this player within this command and it wil be displayed to them. Example:

Code:

/kick Ijwu "You're a crazy jerk!"

If this player returns and continues their harassment then you may need to resort to more permanent measures. With the ban permission you'll be able to remove a player's priveledges to playing on your server. This will be permanent. You can do so with the /ban command, and like the /kick command you're able to specify a reason. Example:

Code:

/ban Ijwu "You've stolen enough of our cookies, you hideous monster!"

If you wish to unban a player and allow them to return to your server you are able to use the /unban command with the ban permission to remove the player from the ban list. Example:

Code:

/unban Ijwu
Expanding TShock: Plugins and You - Show:

Expanding TShock: Plugins and You - Show: |Expanding TShock: Plugins and You - Hide:

Now that you know what TShock is capable of on its own you may feel that you have some features in mind that you wished were a part of TShock. These features may already be made possible through the use of plugins. Plugins are third-party libraries that extend the functionality of TShock, thus allowing you to perform certain actions or have certain abilities that you could or did not before. You can find plugins here in the plugin releases section of the TShock forums. The function and usage of the plugins are detailed on their pages. It is up to the plugin author to provide all of the information on their plugin. You must learn to use and handle the plugin through the documentation they give you.

Ijwu · May 26, 2012

Complete command reference list - Part 1 - Show:

Complete command reference list - Part 1 - Show: |Complete command reference list - Part 1 - Hide:

This list was put together by looking at each command in the source code and deriving its meaning, arguements and examples from there. This means that you may find some commands here that you've never noticed before or didn't know what they did.

Command: /kick
Arguments: [playername] [reason]
Description: Removes the specified player from the server and from play. The reason appears to them after they are kicked. They may still re-login.
Permission needed: kick
Example usage:

Code:

/kick Ijwu "Being a jerk and writing a tutorial."

Command: /ban
Arguments: [playername] [reason]
Description: Stops the specified player from being able to join the server after removing them from play. The reason appears to them after they are removed.
Permission needed: ban
Example usage:

Code:

/ban Ijwu "Seriously, that Ijwu guy is the worst."

Command: /banip
Arguments: [ip] [reason]
Description: Bans the specified IP Address from being able to join the server. The reason appears to them after they are removed.
Permission needed: ban
Example usage:

Code:

/banip 76.222.331.231 "Lol, whose ip address is that?"

Command: /unban
Arguments: [player]
Description: Unbans the player, thus allowing them to rejoin the server.
Permission needed: ban
Example usage:

Code:

/unban Ijwu

Command: /unbanip
Arguments: [ip]
Description: Unbans the ip address from the server. That address may now join again.
Permission needed: ban
Example usage:

Code:

/unbanip 76.222.331.231

Command: /clearbans
Arguments: [clearbanscode] for second use only.
Description: Upon first use, you will receive a clearbans code. Upon second use, you must enter in the code. Clears all banned players or IP addresses on your server.
Permission needed: maintenance
Example usage:

Code:

/clearbans

then

Code:

/clearbans 4486

Command: /whitelist
Arguments: [player] OR [ip]
Description: Adds the specified player name or ip address to your server whitelist. If the whitelist is enabled in config, then those players will be granted access to your server.
Permission needed: whitelist
Example usage:

Code:

/whitelist Ijwu

Command: /off OR /exit
Arguments: None
Description: Saves the world and exits the server.
Permission needed: maintenance
Example usage:

Code:

/exit

Command: /off-nosave OR /exit-nosave
Arguments: None
Description: Exits the server without saving the world.
Permission needed: maintenance
Example usage:

Code:

/off-nosave

Command: /checkupdates
Arguments: None
Description: Checks if there are any TShock software updates available.
Permission needed: maintenance
Example usage:

Code:

/checkupdates

Command: /dropmeteor
Arguments: None
Description: Makes a meteor crash land on the world somewhere.
Permission needed: causeevents
Example usage:

Code:

/dropmeteor

Command: /star
Arguments: None
Description: Makes a star-fall occur somewhere.
Permission needed: causeevents
Example usage:

Code:

/star

Fun Fact: Almost all of the variables in the code for this command are called some variation of penis. I wonder who wrote this command.

Command: /fullmoon
Arguments: None
Description: Causes a fullmoon phase to occur. This effect is a toggle.
Permission needed: causeevents
Example usage:

Code:

/fullmoon

Command: /bloodmoon
Arguments: None
Description: Causes a bloodmoon to occur. This effect is a toggle.
Permission needed: causeevents
Example usage:

Code:

/bloodmoon

Command: /invade
Arguments: [invasion size]
Description: Causes a goblin invasion. If no size number is provided, then the invasion will take on the default size.
Permission needed: causevents
Example usage:

Code:

/invade 500

Command: /eater
Arguments: [amount]
Description: Spawns the Eater of Worlds in the amount provided. The amount defaults to 1.
Permission needed: spawnboss
Example usage:

Code:

/eater 20

Command: /eye
Arguments: [amount]
Description: Spawns in the Eye of Cthulhu in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/eye 20

Command: /king
Arguments: [amount]
Description: Spawns the King Slime in the amount provided. The amount defaults to 1.
Permission needed: spawnboss
Example usage:

Code:

/king 20

Command: /skeletron
Arguments: [amount]
Description: Spawns Skeletron in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/skeletron 20

Command: /wof OR /wallofflesh
Arguments: None
Description: Spawns one Wall of Flesh. There can only be one Wall of Flesh in play at any moment and the spawning player must be in the Underworld upon command usage.
Permission needed: spawnboss
Example usage:

Code:

/wof

Command: /twins
Arguments: [amount]
Description: Spawns The Twins in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/twins 20

Command: /destroyer
Arguments: [amount]
Description: Spawns The Destroyer in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/destroyer 20

Command: /skeletronp OR /prime
Arguments: [amount]
Description: Spawns Skeletron Prime in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/prime 20

Command: /hardcore
Arguments: [amount]
Description: Spawns ALL of the bosses at once in the amount provided. The amount defaults to 1. The time is automatically set to nighttime.
Permission needed: spawnboss
Example usage:

Code:

/hardcore 9001

Command: /spawnmob OR /sm
Arguments: [mob name] [amount]
Description: Spawns the mob provided in the amount provided.
Permission needed: spawnmob
Example usage:

Code:

/sm "Chaos Elemental" 5

Command: /home
Arguments: None
Description: Teleports the player to their personal spawnpoint.
Permission needed: tp
Example usage:

Code:

/home

Command: /spawn
Arguments: None
Description: Teleports the player to the world spawn point.
Permission needed: tp
Example usage:

Code:

/spawn

Command: /tp
Arguments: [player name]
Description: Teleports the player to the provided player if they are online.
Permission needed: tp
Example usage:

Code:

/tp Ijwu

Command: /tphere
Arguments: [player name]
Description: Teleports the provided player to the player using this command. In other words, brings the specified player to you.
Permission needed: tphere
Example usage:

Code:

/tphere Ijwu

Command: /sendwarp OR /sw
Arguments: [player name] [warp name]
Description: Teleports the specified player to the specified warp point.
Permission needed: tphere
Example usage:

Code:

/sw Ijwu warp1

Command: /tpallow
Arguments: None
Description: Allows or disallows others teleporting to you.
Permission needed: tpallow
Example usage:

Code:

/tpallow

Command: /warp
Arguments: [warp name] OR "list"
Description: Teleports you to the specified warp point. If the warp name "list" is provided then you will see a list of available warps.
Permission needed: warp
Example usage:

Code:

/warp warp1 OR /warp list

Command: /setwarp
Arguments: [warp name]
Description: Sets a warp using the provided name to your current position.
Permission needed: managewarp
Example usage:

Code:

/setwarp warp1

Command: /delwarp
Arguments: [warp name]
Description: Deletes the specified warp.
Permission needed: managewarp
Example usage:

Code:

/delwarp warp1

Command: /hidewarp
Arguments: [warp name] [true OR false]
Description: Makes the specified warp visible the to public or vice-versa. Putting in true will make the warp private. Putting in false will make the warp public.
Permission needed: managewarp
Example usage:

Code:

/hidewarp warp1 true

Command: /addgroup
Arguments: [group name] [optional permissions]
Description: Creates a user group with the specified name. You can designate permssions for the group to start out with.
Permission needed: managegroup
Example usage:

Code:

/addgroup Citizens tp tphere warp

Command: /delgroup
Arguments: [group name]
Description: Deletes the specified user group.
Permission needed: managegroup
Example usage:

Code:

/delgroup Citizens

Command: /modgroup
Arguments: "add" OR "del" (or "delete") [group name] [permission]
Description: Adds or deletes the specified permission to or from the specified group.
Permission needed: managegroup
Example usage:

Code:

/modgroup del Citizens warp

Command: /group
Arguments: "list" OR "perm" [groupname]
Description: With the "list" sub-command, this command creates a list of user groups. With the "perm" sub-command, this command shows you the permissions available to the specified user group.
Permission needed: managegroup
Example usage:

Code:

/group perm Citizens

Ijwu · May 26, 2012

Complete command reference list - Part 2 - Show:

Complete command reference list - Part 2 - Show: |Complete command reference list - Part 2 - Hide:

Command: /additem OR /banitem
Arguments: [item name]
Description: Adds the specified item to the server-wide ban list.
Permission needed: manageitem
Example usage:

Code:

/additem "Dirt Block"

Command: /delitem OR /unbanitem
Arguments: [item name]
Description: Removes the specified item from the server-wide ban list.
Permission needed: manageitem
Example usage:

Code:

/unbanitem "Dirt Block"

Command: /listitems OR /listbanneditems
Arguments: None
Description: Displays a list of all currently banned items.
Permission needed: manageitem
Example usage:

Code:

/listitems

Command: /additemgroup
Arguments: [item name] [group name]
Description: Gives permission to the specified group to use the specified banned item.
Permission needed: manageitem
Example usage:

Code:

/additemgroup "Cobalt Brick" Builder

Command: /delitemgroup
Arguments: [item name] [group name]
Description: Removes permission from the specified group to use the specified item.
Permission needed: manageitem
Example usage:

Code:

/delitemgroup "Cobalt Brick" Builder

Command: /setspawn
Arguments: None
Description: Sets the world spawn to your current position.
Permission needed: cfg
Example usage:

Code:

/setspawn

Command: /reload
Arguments: None
Description: Reloads the config, permissions, and region data. This ensures changes you make take effect.
Permission needed: cfg
Example usage:

Code:

/reload

Command: /serverpassword
Arguments: [new password]
Description: Changes the server password to the one specified.
Permission needed: cfg
Example usage:

Code:

/serverpassword IjwuIsAwesome

Command: /save
Arguments: None
Description: Force-saves the world and any changes that were made.
Permission needed: cfg
Example usage:

Code:

/save

Command: /settle
Arguments: None
Description: Forces all liquids in the world to settle.
Permission needed: cfg
Example usage:

Code:

/settle

Command: /maxspawns
Arguments: [number] OR "show" OR "default"
Description: Changes the max spawns in the world to the number provided. If "show" is the argument then you will receive a message showing the current max spawns. If "default" is the argument then the maxspawns will change to Terraria's default.
Permission needed: cfg
Example usage:

Code:

/maxspawns 100

Command: /spawnrate
Arguments: [number] OR "show" OR "default"
Description: Changes the spawnrate in the world to the number provided. If "show" is the argument then you will receive a message showing the current spawnrate. If "default" is the argument then the spawnrate will change to Terraria's default.
Permission needed: cfg
Example usage:

Code:

/spawnrate default

Command: /broadcast OR /say OR /bc
Arguments: [message]
Description: Shows a message to all of the players in the server as if the server itself is speaking to them.
Permission needed: cfg
Example usage:

Code:

/broadcast Fear your almighty server!

Command: /stats
Arguments: None
Description: Shows information on the server and the host machine.
Permission needed: cfg
Example usage:

Code:

/stats

Command: /world
Arguments: None
Description: Shows information on the current world file.
Permission needed: cfg
Example usage:

Code:

/world

Command: /time
Arguments: ["day" OR "night" OR "dusk" OR "noon" OR "midnight"]
Description: Changes the time of the day to the time argument provided.
Permission needed: time
Example usage:

Code:

/time day

Command: /slap
Arguments: [player] [damage]
Description: "Slaps" the specified player for the amount of damage specified. This hurts the player. If there is no damage specified then the damage will default to 5.
Permission needed: pvpfun
Example usage:

Code:

/slap Ijwu 20

Command: /antibuild
Arguments: None
Description: Toggles building in the server.
Permission needed: editspawn
Example usage:

Code:

/antibuild

Command: /protectspawn
Arguments: None
Description: Toggles building near the spawn.
Permission needed: editspawn
Example usage:

Code:

/protectspawn

Note: All of the /region commands are explained in a chapter in the guide area. Due to the complexity of the sub-commands, I will not be providing a reference here.

Command: /debugreg
Arguments: None
Description: Provides information on each region currently in the database.
Permission needed: manageregion
Example usage:

Code:

/debugreg

Command: /help
Arguments: [page number]
Description: Shows all of the commands available to the user. The page number will default to 1 if no number is provided.
Permission needed: None
Example usage:

Code:

/help

Command: /playing OR /online OR /who OR /version
Arguments: None
Description: Displays the current players on the server. Also displays the current TShock version.
Permission needed: None
Example usage:

Code:

/playing

Command: /auth
Arguments: [auth code]
Description: Upon successful auth code entry, the player using the command becomes a superadmin. This is explained in greater detail in the first chapter of the guide.
Permission needed: None
Example usage:

Code:

/auth 4331215

Command: /me
Arguments: [chat in third-person]
Description: Displays your chat argument in a third person view.
Permission needed: cantalkinthird
Example usage:

Code:

/me is very hungry for cookies. Give me cookies, you heartless fiends.

Command: /p
Arguments: [chat]
Description: Sends your chat message to the current party that you're no.
Permission needed: canpartychat
Example usage:

Code:

/p Seriously, guys. Give me your cookies.

Command: /motd
Arguments: None
Description: Displays the server's Message-Of-The-Day. This is always displayed upon login.
Permission needed: None
Example usage:

Code:

/motd

Command: /rules
Arguments: None
Description: Displays the server's rules as set by the administrator.
Permission needed: None
Example usage:

Code:

/rules

Command: /mute OR /unmute
Arguments: [player name]
Description: Mutes or unmutes the specified player. This command is a toggle.
Permission needed: mute
Example usage:

Code:

/mute Ijwu

Command: /displaylogs
Arguments: None
Description: Shows the user every log item in their chat as it happens.
Permission needed: logs
Example usage:

Code:

/displaylogs

Command: /password
Arguments: [old password] [new password]
Description: Allows a player to change their password.
Permission needed: canchangepassword
Example usage:

Code:

/password 123 lolthisisnotmypassword

Command: /register
Arguments: [password]
Description: Registers a user account using the user's name and the password provided.
Permission needed: canregister
Example usage:

Code:

/register stillnotmypassword

Note: All of the /user commands are explained in a chapter in the guide area. Due to the complexity of the sub-commands, I will not be providing a reference here.

Command: /userinfo OR /ui
Arguments: [player name]
Description: Displays some information about the player specified.
Permission needed: rootonly This means that only the superadmin can perform this command.
Example usage:

Code:

/ui Ijwu

Command: /auth-verify
Arguments: None
Description: Turns off the auth code system and authenticates the superadmin who correctly submitted the auth code.
Permission needed: rootonly
Example usage:

Code:

/auth-verify

Command: /login
Arguments: [password]
Description: Allows a player to log in by provided their password.
Permission needed: canlogin
Example usage:

Code:

/login seriouslymypasswordisnthere

Command: /whisper OR /w OR /tell
Arguments: [player name] [text]
Description: Sends a private message to the player specified.
Permission needed: whisper
Example usage:

Code:

/tell Ijwu "that he's a jerk. Ha, see what I did there?"

Command: /reply OR /r
Arguments: [message]
Description: Sends a message to the player who whispered you last.
Permission needed: whisper
Example usage:

Code:

/r "Dude, you're a jerk."

Command: /annoy
Arguments: [player] [length in seconds]
Description: Plays the whoopie cushion sound around a player for the length of time provided, to annoy them.
Permission needed: annoy
Example usage:

Code:

/annoy Ijwu

Command: /kill
Arguments: [player name]
Description: Kills the specified player.
Permission needed: kill
Example usage:

Code:

/kill Ijwu

Command: /butcher
Arguments: "true" OR "false" OR None
Description: Kills all hostile NPCs. If you provide the argument "true" then it will also kill friendly NPCs (Town NPCs). The "false" argument and no argument only kill hostile NPCs.
Permission needed: butcher
Example usage:

Code:

/butcher

Command: /item OR /i
Arguments: [item name] [amount] [prefix]
Description: Gives the user the item they requested in the amount requested. If no amount is provided then the player will be given a full stack of the item. The player may use partial name entries. The player must wrap their entry in quotes if the item name has more than one word. The prefix argument is optional and works by prefix name.
Permission needed: item
Example usage:

Code:

/i "pearlstone brick wall" 125

Ijwu · May 26, 2012

Complete command reference list - Part 3 - Show:

Complete command reference list - Part 3 - Show: |Complete command reference list - Part 3 - Hide:

Command: /give OR /g
Arguments: [item name] [player name] [amount] [prefix]
Description: Gives the specified player the specified item in the specified quantity. This works the same as the /item command except for its one extra argument.
Permission needed: item
Example usage:

Code:

/g "dirt block" Ijwu 1

Command: /clearitems
Arguments: "all" OR [radius]
Description: Clears all item drops in the radius provided. If the argument "all" is provided then this command will blanket the whole world.
Permission needed: clearitems
Example usage:

Code:

/clearitems 2

Command: /heal
Arguments: [player name] OR None
Description: Heals the specified player to full life and mana. If no argument is provided then this command affects the user only.
Permission needed: heal
Example usage:

Code:

/heal Ijwu

Command: /buff
Arguments: [buff name] [time in seconds]
Description: Buffs the user with the specified buff for the specified time.
Permission needed: buff
Example usage:

Code:

/buff shine 300

Command: /gbuff OR /buffplayer
Arguments: [player name] [buff name] [time in seconds]
Description: Buffs the specified player with the specified buff for the specified time.
Permission needed: buffplayer
Example usage:

Code:

/gbuff Ijwu shine 300

Command: /hardmode
Arguments: None
Description: If the "DisableHardmode" option in the config is disabled, then this command starts hardmode. This includes the world terraformation.
Permission needed: hardmode
Example usage:

Code:

/hardmode

Command: /stophardmode OR /disablehardmode
Arguments: None
Description: Turns off hardmode, but keeps all of the hardmode blocks created by hardmode.
Permission needed: hardmode
Example usage:

Code:

/stophardmode

Command: /savessi
Arguments: None
Description: Saves the Server-Sided Inventory data on each player.
Permission needed: savessi
Example usage:

Code:

/savessi

Command: /overridessi OR /ossi
Arguments: [player name]
Description: Turns off the Server-Sided Inventory for the selected player.
Permission neeed: savessi
Example usage:

Code:

/ossi Ijwu

The Grow Command - Show:

The Grow Command - Show: |The Grow Command - Hide:

The /grow command has several subcommands and requires the growpermission. The sub-commands will be outlined here.

Sub-command: tree
Arguments: None
Description: Attempts to grow a tree at your location.
Example usage:

Code:

/grow tree

Sub-command: epictree
Arguments: None
Description: Attempts to grow a very tall tree at your location.
Example usage:

Code:

/grow epictree

Sub-command: mushroom
Arguments: None
Description: Attempts to grow glowing mushrooms at your location.
Example usage:

Code:

/grow mushroom

Sub-command: cactus
Arguments: None
Description: Attempts to grow a cactus at your location.
Example usage:

Code:

/grow cactus

Sub-command: herb
Arguments: None
Description: Attempts to grow an herb at your location.
Example usage:

Code:

/grow herb

Ijwu · May 26, 2012

Permissions - Show:

Permissions - Show: |Permissions - Hide:

This whole list can be found in your docs folder in your server directory. All you need to do is open index.md.html in your web browser. You can navigate around from there.

Big thanks to the original compilers of this list, it's just a copy-paste put here for convenience. I take no credit for its creation.

allowclientsideworldedit
Description: Allow unrestricted Send Tile Square usage, for client side world editing
Commands: None

annoy
Description: None
Commands: /annoy

ban
Description: User can ban others
Commands: /ban /banip /unban /unbanip

buff
Description: User can buff self
Commands: /buff

buffplayer
Description: User can buff other players
Commands: /gbuff(/buffplayer)

butcher
Description: User can kill all enemy npcs
Commands: /butcher

bypassinventorychecks
Description: Bypass Server Side Inventory checks
Commands: None

canbuild
Description: Required to be able to build (modify tiles and liquid)
Commands: None

canchangepassword
Description: User can change password in game
Commands: /password

canlogin
Description: User can login in game
Commands: /login

canpartychat
Description: User can use party chat in game
Commands: /p

canregister
Description: User can register account in game
Commands: /register

cantalkinthird
Description: User can talk in third person
Commands: /me

causeevents
Description: None
Commands: /dropmeteor /star /genore /fullmoon /bloodmoon /invade

cfg
Description: User can edit sevrer configurations
Commands: /setspawn /reload /serverpassword /save /settle /maxspawns /spawnrate /broadcast(/bc /say) /stats /world

clearitems
Description: User can clear item drops.
Commands: /clear(/clearitems)

converthardmode
Description: User can convert hallow into corruption and vice-versa
Commands: /convertcorruption /converthallow /removespecial

editspawn
Description: Allows you to edit the spawn
Commands: /antibuild /protectspawn

grow
Description: None
Commands: /grow

hardmode
Description: User can change hardmode state.
Commands: /hardmode /stophardmode(/disablehardmode)

heal
Description: None
Commands: /heal

ignoredamagecap
Description: Prevents your actions from being ignored if damage is too high
Commands: None

ignorekilltiledetection
Description: Prevents you from being reverted by kill tile abuse detection
Commands: None

ignoreliquidsetdetection
Description: Prevents you from being disabled by liquid set abuse detection
Commands: None

ignorenoclipdetection
Description: Prevents you from being reverted by no clip detection
Commands: None

ignoreplacetiledetection
Description: Prevents you from being reverted by place tile abuse detection
Commands: None

ignoreprojectiledetection
Description: Prevents you from being disabled by liquid set abuse detection
Commands: None

ignorestackhackdetection
Description: Prevents you from being disabled by stack hack detection
Commands: None

ignorestathackdetection
Description: Prevents you from being kicked by hacked health detection
Commands: None

immunetoban
Description: Prevents you from being banned
Commands: None

immunetokick
Description: Prevents you from being kicked
Commands: None

item
Description: User can spawn items
Commands: /item(/i) /give(/g)

kick
Description: User can kick others
Commands: /kick

kill
Description: None
Commands: /kill

logs
Description: Specific log messages are sent to users with this permission
Commands: /displaylogs

maintenance
Description: User is notified when an update is available
Commands: /clearbans /off(/exit) /restart /off-nosave(/exit-nosave) /checkupdates

managegroup
Description: User can manage groups
Commands: /addgroup /delgroup /modgroup /group

manageitem
Description: User can manage item bans
Commands: /additem(/banitem) /delitem(/unbanitem) /listitems(/listbanneditems) /additemgroup /delitemgroup

manageregion
Description: User can edit regions
Commands: /region /debugreg

managewarp
Description: User can manage warps
Commands: /setwarp /delwarp /hidewarp

movenpc
Description: User can change the homes of NPCs.
Commands: None

mute
Description: User can mute and unmute users
Commands: /mute(/unmute)

pvpfun
Description: None
Commands: /slap

reservedslot
Description: Allows you to bypass the max slots for up to 5 slots above your max
Commands: None

rootonly
Description: Meant for super admins only
Commands: /user /userinfo(/ui) /auth-verify

seeids
Description: User can see the id of players with /who
Commands: None

spawnboss
Description: User can spawn bosses
Commands: /eater /eye /king /skeletron /wof(/wallofflesh) /twins /destroyer /skeletronp(/prime) /hardcore

spawnmob
Description: User can spawn npcs
Commands: /spawnmob(/sm)

startinvasion
Description: User can start invasions (Goblin/Snow Legion) using items
Commands: None

summonboss
Description: User can summon bosses using items
Commands: None

time
Description: None
Commands: /time

tp
Description: User can teleport
Commands: /home /spawn /tp

tpall
Description: Users can tp to anyone
Commands: None

tpallow
Description: Users can stop people from TPing to them
Commands: /tpallow

tphere
Description: User can teleport people to them
Commands: /tphere /sendwarp(/sw)

tphide
Description: Users can tp to people without showing a notice
Commands: None

usebanneditem
Description: Allows you to use banned items
Commands: None

warp
Description: User can use warps
Commands: /warp

whisper
Description: User can whisper to others
Commands: /whisper(/w /tell) /reply(/r)

whitelist
Description: User can modify the whitelist
Commands: /whitelist

goldzack1212 · Jul 1, 2012

can u tell me how to change max players i do 100 and it wont let me i follow what it says to do plz help

Ijwu · Jul 1, 2012

goldzack1212 said: ↑

can u tell me how to change max players i do 100 and it wont let me i follow what it says to do plz help

Let's take this to PM to not spam the thread with me trying to help you. I'll PM you. : )

brainworm · Jul 1, 2012

Ijwu said: ↑

To set the first corner of the rectangle, you must use the /region set 1 command and then edit any tile in the world. This edit can be breaking a tile (don't worry, it will come back!), clicking on a tile but not breaking it, setting a tile, or just shooting an ice rod shot.

Some people may also find putting/deleting a wire in the tile handy.

Ijwu · Jul 1, 2012

brainworm said: ↑

Some people may also find putting/deleting a wire in the tile handy.

Edit made, thanks for the feedback.

Silverforte · Jan 19, 2013

This was so helpful, for mostly the /user commands.
One quick thing,
Quote from original post: '/setwarp [name] command.'
Isn't it /warp add [name]?

Ijwu · Jan 19, 2013

Hmph, that's outdated. I'll fix it tomor-- Later today. (It's 1 AM)

Silverforte · Jan 19, 2013

Ijwu said: ↑

Hmph, that's outdated. I'll fix it tomor-- Later today. (It's 1 AM)

i still often use /setwarp instead of /warp add.
but this way its more flexible

Cross839 · May 5, 2013

I'm having difficulties making my character superadmin. I joined the server, used the auth code, registered and logged in but now I "Don't have permission" to use the /auth-verify command
I am completely new at this btw

Mr White · May 6, 2013

Option one: Go to console and type /user del [yourusername]
Then go through the whole thing again reading the wiki and doing everything exactly like it says

Option two: Go to console and type /user group [yourusername] superadmin
Then use /auth-verify

Olink · May 6, 2013

should do option one though, since you did it wrong, and will continue doing it wrong

Log in or Sign up

Tutorial TShock Complete Reference Guide - Everything You Need to Know

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

goldzack1212 New Member

Ijwu TShock Plugin Developer

brainworm Member

Ijwu TShock Plugin Developer

Silverforte New Member

Ijwu TShock Plugin Developer

Silverforte New Member

Cross839 New Member

Mr White TShock Plugin Developer

Olink TShock Developer

Share This Page

Log in or Sign up

Tutorial TShock Complete Reference Guide - Everything You Need to Know

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

Ijwu TShock Plugin Developer

goldzack1212 New Member

Ijwu TShock Plugin Developer

brainworm Member

Ijwu TShock Plugin Developer

Silverforte New Member

Ijwu TShock Plugin Developer

Silverforte New Member

Cross839 New Member

Mr White TShock Plugin Developer

Olink TShock Developer

Share This Page

Useful Searches