Permalink
Browse files

Added configuration file docs

Added permission documentation
  • Loading branch information...
1 parent c8ba96f commit e10d9f546a59e28235218fa01e19ae8a2b778afd @nicatronTg nicatronTg committed Feb 26, 2012
Showing with 366 additions and 3 deletions.
  1. +366 −3 docs/src/index.md
View
369 docs/src/index.md
@@ -25,7 +25,9 @@ Welcome to the official TShock for Terraria downloaded documentation. This guide
1. [Installation](#Installation)
2. [Basic usage](#Basics)
3. [Configuration](#Configuration)
-4. [Plugins](#Plugins)
+4. [Permissions](#Permissions)
+5. [The config file](#Config)
+6. [Plugins](#Plugins)
----
@@ -43,11 +45,372 @@ Welcome to the official TShock for Terraria downloaded documentation. This guide
----
-
### Basic Usage<a id="Basics"></a>
Now that TShock is running, you may be interested in a few other features prior to playing Terraria.
* You can add admins through two methods. If the user is already registered, you can use "**/user group [username] [group-to-change-to]**". By default, TShock comes with the "vip" group, the "trustedadmin" group, and the "newadmin" group.
* When you join the server and already have an account, the server will ask for your account password, even if the server has no password setup. In the event that you set a password on the server, unregistered users will be required to enter it. Users that already have an account must enter their own password.
-* If a user wishes to change accounts but retain their group, a config option exists that will allow you to allow users to login to accounts with any username.
+* If a user wishes to change accounts but retain their group, a config option exists that will allow you to allow users to login to accounts with any username.
+
+----
+
+### Configuration<a id="Configuration"></a>
+
+#### Permissions<a id="Permissions"></a>
+
+Like Bukkit and other administrative modifications, TShock supports adding groups and permissions. In the current implementation, you can only edit groups ingame, adding and removing them isn't supported *yet*.
+
+##### Permission Nodes:
+
+###### <a id="allowclientsideworldedit">allowclientsideworldedit</a>
+**Description:** Allow unrestricted Send Tile Square usage, for client side world editing
+**Commands:** None
+
+###### <a id="annoy">annoy</a>
+**Description:** None
+**Commands:** /annoy
+
+###### <a id="ban">ban</a>
+**Description:** User can ban others
+**Commands:** /ban /banip /unban /unbanip
+
+###### <a id="buff">buff</a>
+**Description:** User can buff self
+**Commands:** /buff
+
+###### <a id="buffplayer">buffplayer</a>
+**Description:** User can buff other players
+**Commands:** /gbuff(/buffplayer)
+
+###### <a id="butcher">butcher</a>
+**Description:** User can kill all enemy npcs
+**Commands:** /butcher
+
+###### <a id="bypassinventorychecks">bypassinventorychecks</a>
+**Description:** Bypass Server Side Inventory checks
+**Commands:** None
+
+###### <a id="canbuild">canbuild</a>
+**Description:** Required to be able to build (modify tiles and liquid)
+**Commands:** None
+
+###### <a id="canchangepassword">canchangepassword</a>
+**Description:** User can change password in game
+**Commands:** /password
+
+###### <a id="canlogin">canlogin</a>
+**Description:** User can login in game
+**Commands:** /login
+
+###### <a id="canpartychat">canpartychat</a>
+**Description:** User can use party chat in game
+**Commands:** /p
+
+###### <a id="canregister">canregister</a>
+**Description:** User can register account in game
+**Commands:** /register
+
+###### <a id="cantalkinthird">cantalkinthird</a>
+**Description:** User can talk in third person
+**Commands:** /me
+
+###### <a id="causeevents">causeevents</a>
+**Description:** None
+**Commands:** /dropmeteor /star /genore /fullmoon /bloodmoon /invade
+
+###### <a id="cfg">cfg</a>
+**Description:** User can edit sevrer configurations
+**Commands:** /setspawn /reload /serverpassword /save /settle /maxspawns /spawnrate /broadcast(/bc /say) /stats /world
+
+###### <a id="clearitems">clearitems</a>
+**Description:** User can clear item drops.
+**Commands:** /clear(/clearitems)
+
+###### <a id="converthardmode">converthardmode</a>
+**Description:** User can convert hallow into corruption and vice-versa
+**Commands:** /convertcorruption /converthallow /removespecial
+
+###### <a id="editspawn">editspawn</a>
+**Description:** Allows you to edit the spawn
+**Commands:** /antibuild /protectspawn
+
+###### <a id="grow">grow</a>
+**Description:** None
+**Commands:** /grow
+
+###### <a id="hardmode">hardmode</a>
+**Description:** User can change hardmode state.
+**Commands:** /hardmode /stophardmode(/disablehardmode)
+
+###### <a id="heal">heal</a>
+**Description:** None
+**Commands:** /heal
+
+###### <a id="ignoredamagecap">ignoredamagecap</a>
+**Description:** Prevents your actions from being ignored if damage is too high
+**Commands:** None
+
+###### <a id="ignorekilltiledetection">ignorekilltiledetection</a>
+**Description:** Prevents you from being reverted by kill tile abuse detection
+**Commands:** None
+
+###### <a id="ignoreliquidsetdetection">ignoreliquidsetdetection</a>
+**Description:** Prevents you from being disabled by liquid set abuse detection
+**Commands:** None
+
+###### <a id="ignorenoclipdetection">ignorenoclipdetection</a>
+**Description:** Prevents you from being reverted by no clip detection
+**Commands:** None
+
+###### <a id="ignoreplacetiledetection">ignoreplacetiledetection</a>
+**Description:** Prevents you from being reverted by place tile abuse detection
+**Commands:** None
+
+###### <a id="ignoreprojectiledetection">ignoreprojectiledetection</a>
+**Description:** Prevents you from being disabled by liquid set abuse detection
+**Commands:** None
+
+###### <a id="ignorestackhackdetection">ignorestackhackdetection</a>
+**Description:** Prevents you from being disabled by stack hack detection
+**Commands:** None
+
+###### <a id="ignorestathackdetection">ignorestathackdetection</a>
+**Description:** Prevents you from being kicked by hacked health detection
+**Commands:** None
+
+###### <a id="immunetoban">immunetoban</a>
+**Description:** Prevents you from being banned
+**Commands:** None
+
+###### <a id="immunetokick">immunetokick</a>
+**Description:** Prevents you from being kicked
+**Commands:** None
+
+###### <a id="item">item</a>
+**Description:** User can spawn items
+**Commands:** /item(/i) /give(/g)
+
+###### <a id="kick">kick</a>
+**Description:** User can kick others
+**Commands:** /kick
+
+###### <a id="kill">kill</a>
+**Description:** None
+**Commands:** /kill
+
+###### <a id="logs">logs</a>
+**Description:** Specific log messages are sent to users with this permission
+**Commands:** /displaylogs
+
+###### <a id="maintenance">maintenance</a>
+**Description:** User is notified when an update is available
+**Commands:** /clearbans /off(/exit) /restart /off-nosave(/exit-nosave) /checkupdates
+
+###### <a id="managegroup">managegroup</a>
+**Description:** User can manage groups
+**Commands:** /addgroup /delgroup /modgroup /group
+
+###### <a id="manageitem">manageitem</a>
+**Description:** User can manage item bans
+**Commands:** /additem(/banitem) /delitem(/unbanitem) /listitems(/listbanneditems) /additemgroup /delitemgroup
+
+###### <a id="manageregion">manageregion</a>
+**Description:** User can edit regions
+**Commands:** /region /debugreg
+
+###### <a id="managewarp">managewarp</a>
+**Description:** User can manage warps
+**Commands:** /setwarp /delwarp /hidewarp
+
+###### <a id="movenpc">movenpc</a>
+**Description:** User can change the homes of NPCs.
+**Commands:** None
+
+###### <a id="mute">mute</a>
+**Description:** User can mute and unmute users
+**Commands:** /mute(/unmute)
+
+###### <a id="pvpfun">pvpfun</a>
+**Description:** None
+**Commands:** /slap
+
+###### <a id="reservedslot">reservedslot</a>
+**Description:** Allows you to bypass the max slots for up to 5 slots above your max
+**Commands:** None
+
+###### <a id="rootonly">rootonly</a>
+**Description:** Meant for super admins only
+**Commands:** /user /userinfo(/ui) /auth-verify
+
+###### <a id="seeids">seeids</a>
+**Description:** User can see the id of players with /who
+**Commands:** None
+
+###### <a id="spawnboss">spawnboss</a>
+**Description:** User can spawn bosses
+**Commands:** /eater /eye /king /skeletron /wof(/wallofflesh) /twins /destroyer /skeletronp(/prime) /hardcore
+
+###### <a id="spawnmob">spawnmob</a>
+**Description:** User can spawn npcs
+**Commands:** /spawnmob(/sm)
+
+###### <a id="startinvasion">startinvasion</a>
+**Description:** User can start invasions (Goblin/Snow Legion) using items
+**Commands:** None
+
+###### <a id="summonboss">summonboss</a>
+**Description:** User can summon bosses using items
+**Commands:** None
+
+###### <a id="time">time</a>
+**Description:** None
+**Commands:** /time
+
+###### <a id="tp">tp</a>
+**Description:** User can teleport
+**Commands:** /home /spawn /tp
+
+###### <a id="tpall">tpall</a>
+**Description:** Users can tp to anyone
+**Commands:** None
+
+###### <a id="tpallow">tpallow</a>
+**Description:** Users can stop people from TPing to them
+**Commands:** /tpallow
+
+###### <a id="tphere">tphere</a>
+**Description:** User can teleport people to them
+**Commands:** /tphere /sendwarp(/sw)
+
+###### <a id="tphide">tphide</a>
+**Description:** Users can tp to people without showing a notice
+**Commands:** None
+
+###### <a id="usebanneditem">usebanneditem</a>
+**Description:** Allows you to use banned items
+**Commands:** None
+
+###### <a id="warp">warp</a>
+**Description:** User can use warps
+**Commands:** /warp
+
+###### <a id="whisper">whisper</a>
+**Description:** User can whisper to others
+**Commands:** /whisper(/w /tell) /reply(/r)
+
+###### <a id="whitelist">whitelist</a>
+**Description:** User can modify the whitelist
+**Commands:** /whitelist
+
+##### Adding permissions:
+
+To add a permission to a given group, use the command "**/modgroup [add|del] [group] [permission]**". Example: */modgroup add trustedadmin tpall*
+
+----
+
+#### The config file<a id="Config"></a>
+
+Each TShock installation automatically generates a configuration file which can edit basic settings when the server starts.
+
+The file "config.json" is located in the *tshock* folder, in the same directory as TerrariaServer.exe.
+
+Being a JSON file, it is extremely critical that you edit the file in a standard text editor. Use [Notepad++](http://notepad-plus-plus.org/) to edit your file, or another text editor used for programming. Before restarting TShock, check the syntax of your file using [JSONLint](http://jsonlint.com/), and verify that it contains no errors.
+
+An example configuration file is below.
+
+ {
+ "InvasionMultiplier": 1,
+ "DefaultMaximumSpawns": 0,
+ "DefaultSpawnRate": 600,
+ "ServerPort": 7777,
+ "EnableWhitelist": false,
+ "InfiniteInvasion": false,
+ "PvPMode": "normal",
+ "SpawnProtection": true,
+ "SpawnProtectionRadius": 5,
+ "MaxSlots": 8,
+ "RangeChecks": true,
+ "DisableBuild": false,
+ "SuperAdminChatRGB": [
+ 255.0,
+ 0.0,
+ 0.0
+ ],
+ "SuperAdminChatPrefix": "(Admin) ",
+ "SuperAdminChatSuffix": "",
+ "BackupInterval": 0,
+ "BackupKeepFor": 60,
+ "RememberLeavePos": false,
+ "HardcoreOnly": false,
+ "MediumcoreOnly": false,
+ "KickOnMediumcoreDeath": false,
+ "BanOnMediumcoreDeath": false,
+ "AutoSave": true,
+ "MaximumLoginAttempts": 3,
+ "RconPassword": "",
+ "RconPort": 7777,
+ "ServerName": "",
+ "MasterServer": "127.0.0.1",
+ "StorageType": "sqlite",
+ "MySqlHost": "localhost:3306",
+ "MySqlDbName": "",
+ "MySqlUsername": "",
+ "MySqlPassword": "",
+ "MediumcoreBanReason": "Death results in a ban",
+ "MediumcoreKickReason": "Death results in a kick",
+ "EnableDNSHostResolution": false,
+ "EnableIPBans": true,
+ "EnableBanOnUsernames": false,
+ "DefaultRegistrationGroupName": "default",
+ "DefaultGuestGroupName": "guest",
+ "DisableSpewLogs": true,
+ "HashAlgorithm": "sha512",
+ "BufferPackets": true,
+ "ServerFullReason": "Server is full",
+ "ServerFullNoReservedReason": "Server is full. No reserved slots open.",
+ "SaveWorldOnCrash": true,
+ "EnableGeoIP": false,
+ "EnableTokenEndpointAuthentication": false,
+ "ServerNickname": "TShock Server",
+ "RestApiEnabled": false,
+ "RestApiPort": 7878,
+ "DisableTombstones": true,
+ "DisplayIPToAdmins": false,
+ "EnableInsecureTileFixes": true,
+ "KickProxyUsers": true,
+ "DisableHardmode": false,
+ "DisableDungeonGuardian": false,
+ "ServerSideInventory": false,
+ "ServerSideInventorySave": 15,
+ "LogonDiscardThreshold": 250,
+ "DisablePlayerCountReporting": false,
+ "DisableClownBombs": false,
+ "DisableSnowBalls": false,
+ "ChatFormat": "{1}{2}{3}: {4}",
+ "ForceTime": "normal",
+ "TileKillThreshold": 60,
+ "TilePlaceThreshold": 20,
+ "TileLiquidThreshold": 15,
+ "ProjectileThreshold": 50,
+ "ProjIgnoreShrapnel": true,
+ "RequireLogin": true,
+ "DisableInvisPvP": false,
+ "MaxRangeForDisabled": 10,
+ "ServerPassword": "",
+ "RegionProtectChests": false,
+ "DisableLoginBeforeJoin": false,
+ "AllowRegisterAnyUsername": false,
+ "AllowLoginAnyUsername": true,
+ "MaxDamage": 175,
+ "MaxProjDamage": 175,
+ "IgnoreProjUpdate": false,
+ "IgnoreProjKill": false,
+ "IgnoreNoClip": false,
+ "AllowIce": true
+ }
+
+In this file, if you wanted to change the maximum players to 64, you would edit that the file so that the line referring to max players looked like so:
+
+ "MaxSlots": 64,
+

0 comments on commit e10d9f5

Please sign in to comment.