themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Remove old useless junk files

Browse source
This commit is contained in:
Lucas Nicodemus 2015-02-21 19:38:01 -07:00
parent 19075094ff
commit 41d4206cc9
8 changed files with 0 additions and 1045 deletions
Download patch file Download diff file Expand all files Collapse all files

90
Build/TerrariaServer.XML
View file

@ -1,90 +0,0 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>TerrariaServer</name>
</assembly>
<members>
<member name="T:TShock.Hooks.IHooks">
<summary>
Hooks interface
</summary>
</member>
<member name="P:TShock.IGame.Players">
<summary>
List of players
</summary>
</member>
<member name="T:TShock.HandlerList">
<summary>
See generic HandlerList
</summary>
</member>
<member name="T:TShock.HandlerList`1">
<summary>
Works like an event. Allows for registering delegates with a higher or lower priority.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:TShock.HandlerList`1.Register(System.EventHandler{`0},TShock.HandlerPriority,System.Boolean)">
<summary>
Register a handler
</summary>
<param name="handler">Delegate to be called</param>
<param name="priority">Priority of the delegate</param>
<param name="gethandled">Should the handler receive a call even if it has been handled</param>
</member>
<member name="M:TShock.IPlayer.Damage(System.Int32)">
<summary>
Attempts to damage the player.
</summary>
<param name="amt">int - how much damage to give</param>
</member>
<member name="M:TShock.IPlayer.SendMessage(System.String,Color)">
<summary>
Sends message to specified player
</summary>
<param name="msg">string - text to send</param>
<param name="color">Color - color for the text</param>
</member>
<member name="P:TShock.IPlayer.Id">
<summary>
Meant to only be used by TServer.
</summary>
</member>
<member name="P:TShock.IPlayer.Name">
<summary>
The character name of the player.
</summary>
</member>
<member name="M:TShock.Plugin.CreateInterfaces">
<summary>
Return a list of interfaces this plugin exposes.
</summary>
<returns></returns>
</member>
<member name="M:TShock.Plugin.SetInterfaces(System.Collections.Generic.IEnumerable{System.Object})">
<summary>
Called before initialize passing all the interfaces gathered from plugins
</summary>
<param name="interfaces"></param>
</member>
<member name="M:TShock.Plugin.GetInterface``1(System.Collections.Generic.IEnumerable{System.Object})">
<summary>
Gets the T interface from the collection. Returns null if its not found.
</summary>
<typeparam name="T"></typeparam>
<param name="interfaces"></param>
<returns></returns>
</member>
<member name="P:TShock.Hooks.Player.PlayerHooks.Join">
<summary>
Called when the player first connects. They are not fully in the game yet, for that see Greet.
</summary>
</member>
<member name="P:TShock.Hooks.Player.PlayerHooks.Greet">
<summary>
Called when the player is actually loaded into the game.
</summary>
</member>
</members>
</doc>

6
docs/generate.bat
View file

@ -1,6 +0,0 @@
@echo off
:main
echo Generating Pandoc docs
cd src
for %%F in (*.md) do pandoc %%F > %%F.html
pause

15
docs/readme.md
View file

@ -1,15 +0,0 @@
# Building
1. Install [Pandoc](http://johnmacfarlane.net/pandoc).
2. cd to docs/src
3. pandoc index.md -o ../index.html
4. pandoc permissions.md -o ../permissions.html
# Adding stuff
1. Everything is [Markdown](http://daringfireball.net/projects/markdown/)
2. If you add a new page, include [Markdown-CSS](https://github.com/clownfart/Markdown-CSS) for best results.
# Demo
You can access the docs at the [TShock Github Page](http://tshock.github.com/).

580
docs/src/config.md
View file

@ -1,580 +0,0 @@
<link href="https://raw.github.com/clownfart/Markdown-CSS/master/markdown.css" rel="stylesheet"></link>
# The config file
[Back to index](index.md.html)
----
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,
"AnnounceSave": 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,
The following is the official documentation for the configuration file:
## AllowCorruptionCreep
**Type:** Boolean
**Description:** Allows corrutption to spread when a world is hardmode.
**Default:** "True"
## AllowHallowCreep
**Type:** Boolean
**Description:** Allows hallow to spread when a world is hardmode.
**Default:** "True"
## AllowIce
**Type:** Boolean
**Description:** Allow Ice placement even when user does not have canbuild
**Default:** "False"
## AllowLoginAnyUsername
**Type:** Boolean
**Description:** Allows users to login with any username with /login
**Default:** "True"
## AllowRegisterAnyUsername
**Type:** Boolean
**Description:** Allows users to register any username with /register
**Default:** "False"
## AutoSave
**Type:** Boolean
**Description:** Enable/Disable Terrarias built in auto save
**Default:** "True"
## AnnounceSave
**Type:** Boolean
**Description:** Enable/Disable save announcements
**Default:** "True"
## BackupInterval
**Type:** Int32
**Description:** Backup frequency in minutes. So, a value of 60 = 60 minutes. Backups are stored in the \tshock\backups folder.
**Default:** "0"
## BackupKeepFor
**Type:** Int32
**Description:** How long backups are kept in minutes. 2880 = 2 days.
**Default:** "60"
## BanOnMediumcoreDeath
**Type:** Boolean
**Description:** Bans a Hardcore player on death.
**Default:** "False"
## BufferPackets
**Type:** Boolean
**Description:** Buffers up the packets and sends them out at the end of each frame
**Default:** "True"
## ChatFormat
**Type:** String
**Description:** Change ingame chat format, {0} = Group Name, {1} = Group Prefix, {2} = Player Name, {3} = Group Suffix, {4} = Chat Message
**Default:** "{1}{2}{3}: {4}"
## DefaultGuestGroupName
**Type:** String
**Description:** Selects the default group name to place non registered users under
**Default:** "guest"
## DefaultMaximumSpawns
**Type:** Int32
**Description:** The default maximum mobs that will spawn per wave. Higher means more mobs in that wave.
**Default:** "5"
## DefaultRegistrationGroupName
**Type:** String
**Description:** Selects the default group name to place new registrants under
**Default:** "default"
## DefaultSpawnRate
**Type:** Int32
**Description:** The delay between waves. Shorter values lead to less mobs.
**Default:** "600"
## DisableBuild
**Type:** Boolean
**Description:** Disables any building; placing of blocks
**Default:** "False"
## DisableClownBombs
**Type:** Boolean
**Description:** Disables clown bomb projectiles from spawning
**Default:** "False"
## DisableDungeonGuardian
**Type:** Boolean
**Description:** Disables Dungeon Guardian from being spawned by player packets, this will instead force a respawn
**Default:** "False"
## DisableHardmode
**Type:** Boolean
**Description:** Disables hardmode, can't never be activated. Overrides /starthardmode
**Default:** "False"
## DisableInvisPvP
**Type:** Boolean
**Description:** Disables Invisibility potions from being used in PvP (Note, they can use them on the client, but the effect isn't sent to the rest of the server)
**Default:** "False"
## DisableLoginBeforeJoin
**Type:** Boolean
**Description:** Disable users from being able to login with account password when joining
**Default:** "False"
## DisablePiggybanksOnSSI
**Type:** Boolean
**Description:** Prevent banks on SSI
**Default:** "False"
## DisablePlayerCountReporting
**Type:** Boolean
**Description:** Disables reporting of playercount to the stat system.
**Default:** "False"
## DisableSnowBalls
**Type:** Boolean
**Description:** Disables snow ball projectiles from spawning
**Default:** "False"
## DisableSpewLogs
**Type:** Boolean
**Description:** Force-Disable printing logs to players with the log permission
**Default:** "True"
## DisableTombstones
**Type:** Boolean
**Description:** Disable tombstones for all players.
**Default:** "True"
## DisplayIPToAdmins
**Type:** Boolean
**Description:** Displays a player's IP on join to everyone who has the log permission
**Default:** "False"
## EnableBanOnUsernames
**Type:** Boolean
**Description:** Enables kicking of banned users by matching their Character Name
**Default:** "False"
## EnableDNSHostResolution
**Type:** Boolean
**Description:** Enables DNS resolution of incoming connections with GetGroupForIPExpensive.
**Default:** "False"
## EnableGeoIP
**Type:** Boolean
**Description:** This will announce a player's location on join
**Default:** "False"
## EnableInsecureTileFixes
**Type:** Boolean
**Description:** Some tiles are 'fixed' by not letting TShock handle them. Disabling this may break certain asthetic tiles.
**Default:** "True"
## EnableIPBans
**Type:** Boolean
**Description:** Enables kicking of banned users by matching their IP Address
**Default:** "True"
## EnableTokenEndpointAuthentication
**Type:** Boolean
**Description:** This will turn on a token requirement for the /status API endpoint.
**Default:** "False"
## EnableWhitelist
**Type:** Boolean
**Description:** Enable or disable the whitelist based on IP addresses in whitelist.txt
**Default:** "False"
## ForceTime
**Type:** String
**Description:** Force the world time to be normal, day, or night
**Default:** "normal"
## HardcoreOnly
**Type:** Boolean
**Description:** Hardcore players ONLY. This means softcore players cannot join.
**Default:** "False"
## HashAlgorithm
**Type:** String
**Description:** Valid types are "sha512", "sha256", "md5", append with "-xp" for the xp supported algorithms
**Default:** "sha512"
## IgnoreNoClip
**Type:** Boolean
**Description:** Ignores all no clip checks for players
**Default:** "False"
## IgnoreProjKill
**Type:** Boolean
**Description:** Ignores checking to see if player 'can' kill a projectile
**Default:** "False"
## IgnoreProjUpdate
**Type:** Boolean
**Description:** Ignores checking to see if player 'can' update a projectile
**Default:** "False"
## InfiniteInvasion
**Type:** Boolean
**Description:** Enable the ability for invaison size to never decrease. Make sure to run /invade, and note that this adds 2 million+ goblins to the spawn que for the map.
**Default:** "False"
## InvasionMultiplier
**Type:** Int32
**Description:** The equation for calculating invasion size is 100 + (multiplier * (number of active players with greater than 200 health))
**Default:** "1"
## KickOnMediumcoreDeath
**Type:** Boolean
**Description:** Kicks a Hardcore player on death.
**Default:** "False"
## KickProxyUsers
**Type:** Boolean
**Description:** Kicks users using a proxy as identified with the GeoIP database
**Default:** "True"
## LogonDiscardThreshold
**Type:** Int32
**Description:** Time, in milliseconds, to disallow discarding items after logging in when ServerSideInventory is ON
**Default:** "250"
## MasterServer
**Type:** String
**Description:** Not implemented
**Default:** "127.0.0.1"
## MaxDamage
**Type:** Int32
**Description:** The maximum damage a player/npc can inflict
**Default:** "175"
## MaximumLoginAttempts
**Type:** Int32
**Description:** Number of failed login attempts before kicking the player.
**Default:** "3"
## MaxProjDamage
**Type:** Int32
**Description:** The maximum damage a projectile can inflict
**Default:** "175"
## MaxRangeForDisabled
**Type:** Int32
**Description:** The maximum distance players disabled for various reasons can move from
**Default:** "10"
## MaxSlots
**Type:** Int32
**Description:** Max slots for the server. If you want people to be kicked with "Server is full" set this to how many players you want max and then set Terraria max players to 2 higher.
**Default:** "8"
## MediumcoreBanReason
**Type:** String
**Description:** Bans a Mediumcore player on death.
**Default:** "Death results in a ban"
## MediumcoreKickReason
**Type:** String
**Description:** Kicks a Mediumcore player on death.
**Default:** "Death results in a kick"
## MediumcoreOnly
**Type:** Boolean
**Description:** Mediumcore players ONLY. This means softcore players cannot join.
**Default:** "False"
## MySqlDbName
**Type:** String
**Description:** Database name to connect to
**Default:** ""
## MySqlHost
**Type:** String
**Description:** The MySQL Hostname and port to direct connections to
**Default:** "localhost:3306"
## MySqlPassword
**Type:** String
**Description:** Database password to connect with
**Default:** ""
## MySqlUsername
**Type:** String
**Description:** Database username to connect with
**Default:** ""
## PreventBannedItemSpawn
**Type:** Boolean
**Description:** Prevent banned items from being /i or /give
**Default:** "False"
## ProjectileThreshold
**Type:** Int32
**Description:** Disable a player if they exceed this number of projectile new within 1 second.
**Default:** "50"
## ProjIgnoreShrapnel
**Type:** Boolean
**Description:** Ignore shrapnel from crystal bullets for Projectile Threshold.
**Default:** "True"
## PvPMode
**Type:** String
**Description:** Set the server pvp mode. Vaild types are, "normal", "always", "disabled"
**Default:** "normal"
## RangeChecks
**Type:** Boolean
**Description:** Global protection agent for any block distance based anti-grief check.
**Default:** "True"
## RconPassword
**Type:** String
**Description:** Not implemented
**Default:** ""
## RconPort
**Type:** Int32
**Description:** Not implemented
**Default:** "7777"
## RegionProtectChests
**Type:** Boolean
**Description:** Protect chests with region and build permissions
**Default:** "False"
## RememberLeavePos
**Type:** Boolean
**Description:** Remembers where a player left off. It works by remembering the IP, NOT the character.
eg. When you try to disconnect, and reconnect to be automatically placed at spawn, you'll be at your last location. Note: Won't save after server restarts.
**Default:** "False"
## RequireLogin
**Type:** Boolean
**Description:** Require all players to register or login before being allowed to play.
**Default:** "False"
## RestApiEnabled
**Type:** Boolean
**Description:** Enable/Disable the rest api.
**Default:** "False"
## RestApiPort
**Type:** Int32
**Description:** This is the port which the rest api will listen on.
**Default:** "7878"
## SaveWorldOnCrash
**Type:** Boolean
**Description:** This will save the world if Terraria crashes from an unhandled exception.
**Default:** "True"
## ServerFullNoReservedReason
**Type:** String
**Description:** String that is used when kicking people when the server is full with no reserved slots.
**Default:** "Server is full. No reserved slots open."
## ServerFullReason
**Type:** String
**Description:** String that is used when kicking people when the server is full.
**Default:** "Server is full"
## ServerName
**Type:** String
**Description:** Used when replying to a rest /status request.
**Default:** ""
## ServerNickname
**Type:** String
**Description:** This is used when the API endpoint /status is queried.
**Default:** "TShock Server"
## ServerPassword
**Type:** String
**Description:** Server password required to join server
**Default:** ""
## ServerPort
**Type:** Int32
**Description:** The port the server runs on.
**Default:** "7777"
## ServerSideInventory
**Type:** Boolean
**Description:** Enable Server Side Inventory checks, EXPERIMENTAL
**Default:** "False"
## ServerSideInventorySave
**Type:** Int32
**Description:** How often SSI should save, in minutes
**Default:** "15"
## SpawnProtection
**Type:** Boolean
**Description:** Prevents tiles from being placed within SpawnProtectionRadius of the default spawn.
**Default:** "True"
## SpawnProtectionRadius
**Type:** Int32
**Description:** Radius from spawn tile for SpawnProtection.
**Default:** "10"
## StatueSpawn200
**Type:** Int32
**Description:** How many things a statue can spawn within 200 pixels(?) before it stops spawning. Default = 3
**Default:** "3"
## StatueSpawn600
**Type:** Int32
**Description:** How many things a statue can spawn within 600 pixels(?) before it stops spawning. Default = 6
**Default:** "6"
## StatueSpawnWorld
**Type:** Int32
**Description:** How many things a statue spawns can exist in the world before it stops spawning. Default = 10
**Default:** "10"
## StorageType
**Type:** String
**Description:** Valid types are "sqlite" and "mysql"
**Default:** "sqlite"
## SuperAdminChatPrefix
**Type:** String
**Description:** Super admin group chat prefix
**Default:** "(Admin) "
## SuperAdminChatRGB
**Type:** Single[]
**Description:** #.#.#. = Red/Blue/Green - RGB Colors for the Admin Chat Color. Max value: 255
**Default:** "System.Single[]"
## SuperAdminChatSuffix
**Type:** String
**Description:** Super admin group chat suffix
**Default:** ""
## TileKillThreshold
**Type:** Int32
**Description:** Disable/Revert a player if they exceed this number of tile kills within 1 second.
**Default:** "60"
## TileLiquidThreshold
**Type:** Int32
**Description:** Disable a player if they exceed this number of liquid sets within 1 second.
**Default:** "15"
## TilePlaceThreshold
**Type:** Int32
**Description:** Disable/Revert a player if they exceed this number of tile places within 1 second.
**Default:** "20"
## WhitelistKickReason
**Type:** String
**Description:** String that is used when a user is kicked due to not being on the whitelist.
**Default:** "You are not on the whitelist."

43
docs/src/index.md
View file

@ -1,43 +0,0 @@
<link href="https://raw.github.com/clownfart/Markdown-CSS/master/markdown.css" rel="stylesheet"></link>
# TShock Downloaded Documentation
*Created for TShock version: 3.9.x.x*
*Last updated: 5/26/2012*
----
## Preface
Welcome to the official TShock for Terraria downloaded documentation. This guide will walk through the installation and basic configuration of your newly downloaded TShock server, and should provide a basic knowledge as to how to get help from outside resources if needed.
## Resources
* [The Confluence wiki](http://develop.tshock.co:8080/) contains the most up to date information compiled by the community members. If your question isn't answered here, you might find it there.
* [The forums](http://tshock.co/xf/) provide an excellent place to ask other TShock users and developers questions. Please refrain from making posts about questions that may be answered here, however.
* [Our Github page](http://github.com/TShock/TShock) is where you'll be able to find the source code and the bug tracker.
* [IRC](irc://irc.shankshock.com/terraria) is our IRC channel, if you prefer that medium for support.
* Lastly, we can be found in the "Nyx" channel on the Teamspeak 3 server: ts3.shankshock.com, port 9987.
----
## Table of contents
1. [Installation & basic usage](install.md.html)
2. [Permissions](perms.md.html)
3. [The config file](config.md.html)
4. [Credits](#Credits)
----
## Credits<a id="Credits"></a>
TShock wouldn't be possible without:
* [Xenon Servers](http://xns.cc/)
* [Kerplunc Gaming](http://kerpluncgaming.com/)
* [Multiplay UK](http://multiplay.co.uk/)
* [Atlassian](http://www.atlassian.com/)
* [Github](http://github.com/)
* You :)

35
docs/src/install.md
View file

@ -1,35 +0,0 @@
<link href="https://raw.github.com/clownfart/Markdown-CSS/master/markdown.css" rel="stylesheet"></link>
# Install instructions & basic usage
[Back to index](index.md.html)
----
1. Assuming you've extracted TShock, you're done as far as files go. Run the TerrariaServer.exe file in the folder you've extracted TShock into.
2. Check to verify that the server window states that some version of TerrariaShock is now running. If this is not the case, stop. Re-download all files and extract them to a new folder, being sure to keep the file structure in tact.
3. Select a world and port to start the server. *TShock now uses its configuration file to control the number of players on the server. You can edit this value in the configuration file, discussed later. If you are generating a new world, you may experience a significantly longer time as the world creates itself. This is normal.
4. Once the server is finished starting, you will be greeted with TShock's main console window. You will see a message in yellow that states "*To become superadmin, join the game and type /auth*" preceding a series of numbers. This set of numbers we will refer to as the "authcode" in succeeding steps.
5. Connect to the server. Your IP address is 127.0.0.1, and the port will by default be on what you entered in the server console.
6. Immediately chat the following: "**/auth [authcode]**". Replace [authcode] with the code given in the server console. Example: /auth 123456.
7. Next, we will create a user account that you can login to. In the game, chat the command "**/user add [username]:[password] superadmin**". Replace [username] and [password] respectively with your appropriate details. You should be able to remeber your password, and it shouldn't be easily guessed. From now on, the phrase "run the command" is synonymous with "chat in the game chat box". In addition, where brackets ([]) are, we will assume you will replace those brackets with information that you have created.
8. Assuming the last step was a success, login. Run the command "**/login [username] [password]**".
9. To finalize installation, run the command "**/auth-verify**". This will disable the authcode, enable any previously disabled functionality, and allow the server to be used in production.
----
### 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. If the user has yet to register, you can use "**/user add [username]:[password] [group]**" to generate an account with elevated permissions for them.
* 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.
----
## Closing remarks<a id="Closing"></a>
Thanks for downloading TShock. Your continued support helps make TShock what it is today. We wouldn't be here without you.
From everyone at TShock, thank-you.

259
docs/src/permissions.md
View file

@ -1,259 +0,0 @@
<link href="https://raw.github.com/clownfart/Markdown-CSS/master/markdown.css" rel="stylesheet"></link>
# Permission Nodes
These are the permissions that TShock currently supports, with associated commands. [Back to permissions](perms.md.html)
----
## <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 /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="restapi">restapi</a>
**Description:** User can use rest api calls.
**Commands:** None
## <a id="rootonly">rootonly</a>
**Description:** Meant for super admins only
**Commands:** /user /auth-verify
## <a id="savessi">savessi</a>
**Description:** User can save all the players SSI state.
**Commands:** /savessi /overridessi(/ossi)
## <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="userinfo">userinfo</a>
**Description:** Allows player to get user info
**Commands:** /userinfo(/ui)
## <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

17
docs/src/perms.md
View file

@ -1,17 +0,0 @@
<link href="https://raw.github.com/clownfart/Markdown-CSS/master/markdown.css" rel="stylesheet"></link>
# Permissions
[Back to index](index.md.html)
## 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*.
## Adding permissions:
To add a permission to a given group, use the command "**/modgroup [add|del] [group] [permission]**". Example: */modgroup add trustedadmin tpall*.
## Permission nodes:
[A list of permission nodes can be found here.](permissions.md.html)