Descriptions in config and permissions

This commit is contained in:
MarioE 2012-05-31 21:52:48 -04:00
parent 12140644c3
commit f22ee0c09d
2 changed files with 59 additions and 57 deletions

View file

@ -27,21 +27,21 @@ namespace TShockAPI
public class ConfigFile public class ConfigFile
{ {
[Description( [Description(
"The equation for calculating invasion size is 100 + (multiplier * (number of active players with greater than 200 health))" "The equation for calculating invasion size is 100 + (multiplier * (number of active players with greater than 200 health))."
)] public int InvasionMultiplier = 1; )] public int InvasionMultiplier = 1;
[Description("The default maximum mobs that will spawn per wave. Higher means more mobs in that wave.")] public int [Description("The default maximum mobs that will spawn per wave. Higher means more mobs in that wave.")] public int
DefaultMaximumSpawns = 5; DefaultMaximumSpawns = 5;
[Description("The delay between waves. Shorter values lead to less mobs.")] public int DefaultSpawnRate = 600; [Description("The delay between waves. Lower values lead to more mobs.")] public int DefaultSpawnRate = 600;
[Description("The port the server runs on.")] public int ServerPort = 7777; [Description("The port the server runs on.")] public int ServerPort = 7777;
[Description("Enable or disable the whitelist based on IP addresses in whitelist.txt")] public bool EnableWhitelist; [Description("Enable or disable the whitelist based on IP addresses in whitelist.txt")] public bool EnableWhitelist;
[Description( [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." "Enable the ability for invasion size to never decrease. Make sure to run /invade, and note that this adds 2 million+ goblins to the spawn queue for the map."
)] public bool InfiniteInvasion; )] public bool InfiniteInvasion;
[Description("Set the server pvp mode. Vaild types are, \"normal\", \"always\", \"disabled\"")] public string PvPMode [Description("Set the server pvp mode. Valid types are, \"normal\", \"always\", and \"disabled.\"")] public string PvPMode
= "normal"; = "normal";
[Description("Prevents tiles from being placed within SpawnProtectionRadius of the default spawn.")] public bool [Description("Prevents tiles from being placed within SpawnProtectionRadius of the default spawn.")] public bool
@ -73,48 +73,48 @@ namespace TShockAPI
[Description("Hardcore players ONLY. This means softcore players cannot join.")] public bool HardcoreOnly; [Description("Hardcore players ONLY. This means softcore players cannot join.")] public bool HardcoreOnly;
[Description("Mediumcore players ONLY. This means softcore players cannot join.")] public bool MediumcoreOnly; [Description("Mediumcore players ONLY. This means softcore players cannot join.")] public bool MediumcoreOnly;
[Description("Kicks a Hardcore player on death.")] public bool KickOnMediumcoreDeath; [Description("Kicks a hardcore player on death.")] public bool KickOnMediumcoreDeath;
[Description("Bans a Hardcore player on death.")] public bool BanOnMediumcoreDeath; [Description("Bans a hardcore player on death.")] public bool BanOnMediumcoreDeath;
[Description("Enable/Disable Terrarias built in auto save")] public bool AutoSave = true; [Description("Enable/disable Terraria's built in auto save.")] public bool AutoSave = true;
[Description("Number of failed login attempts before kicking the player.")] public int MaximumLoginAttempts = 3; [Description("Number of failed login attempts before kicking the player.")] public int MaximumLoginAttempts = 3;
[Description("Not implemented")] public string RconPassword = ""; [Description("Not implemented.")] public string RconPassword = "";
[Description("Not implemented")] public int RconPort = 7777; [Description("Not implemented.")] public int RconPort = 7777;
[Description("Used when replying to a rest /status request or sent to the client when UseServerName is true.")] public string ServerName = ""; [Description("Used when replying to a rest /status request or sent to the client when UseServerName is true.")] public string ServerName = "";
[Description("Sends ServerName in place of the world name to clients.")] public bool UseServerName = false; [Description("Sends ServerName in place of the world name to clients.")] public bool UseServerName = false;
[Description("Not implemented")] public string MasterServer = "127.0.0.1"; [Description("Not implemented.")] public string MasterServer = "127.0.0.1";
[Description("Valid types are \"sqlite\" and \"mysql\"")] public string StorageType = "sqlite"; [Description("Valid types are \"sqlite\" and \"mysql\"")] public string StorageType = "sqlite";
[Description("The MySQL Hostname and port to direct connections to")] public string MySqlHost = "localhost:3306"; [Description("The MySQL hostname and port to direct connections to")] public string MySqlHost = "localhost:3306";
[Description("Database name to connect to")] public string MySqlDbName = ""; [Description("Database name to connect to")] public string MySqlDbName = "";
[Description("Database username to connect with")] public string MySqlUsername = ""; [Description("Database username to connect with")] public string MySqlUsername = "";
[Description("Database password to connect with")] public string MySqlPassword = ""; [Description("Database password to connect with")] public string MySqlPassword = "";
[Description("Bans a Mediumcore player on death.")] public string MediumcoreBanReason = "Death results in a ban"; [Description("Bans a mediumcore player on death.")] public string MediumcoreBanReason = "Death results in a ban";
[Description("Kicks a Mediumcore player on death.")] public string MediumcoreKickReason = "Death results in a kick"; [Description("Kicks a mediumcore player on death.")] public string MediumcoreKickReason = "Death results in a kick";
[Description("Enables DNS resolution of incoming connections with GetGroupForIPExpensive.")] public bool [Description("Enables DNS resolution of incoming connections with GetGroupForIPExpensive.")] public bool
EnableDNSHostResolution; EnableDNSHostResolution;
[Description("Enables kicking of banned users by matching their IP Address")] public bool EnableIPBans = true; [Description("Enables kicking of banned users by matching their IP Address.")] public bool EnableIPBans = true;
[Description("Enables kicking of banned users by matching their Character Name")] public bool EnableBanOnUsernames; [Description("Enables kicking of banned users by matching their Character Name.")] public bool EnableBanOnUsernames;
[Description("Selects the default group name to place new registrants under")] public string [Description("Selects the default group name to place new registrants under.")] public string
DefaultRegistrationGroupName = "default"; DefaultRegistrationGroupName = "default";
[Description("Selects the default group name to place non registered users under")] public string [Description("Selects the default group name to place non registered users under")] public string
DefaultGuestGroupName = "guest"; DefaultGuestGroupName = "guest";
[Description("Force-Disable printing logs to players with the log permission")] public bool DisableSpewLogs = true; [Description("Force-disable printing logs to players with the log permission.")] public bool DisableSpewLogs = true;
[Description("Valid types are \"sha512\", \"sha256\", \"md5\", append with \"-xp\" for the xp supported algorithms")] public string HashAlgorithm = "sha512"; [Description("Valid types are \"sha512\", \"sha256\", \"md5\", append with \"-xp\" for the xp supported algorithms.")] public string HashAlgorithm = "sha512";
[Description("Buffers up the packets and sends them out at the end of each frame")] public bool BufferPackets = true; [Description("Buffers up the packets and sends them out at the end of each frame.")] public bool BufferPackets = true;
[Description("String that is used when kicking people when the server is full.")] public string ServerFullReason = [Description("String that is used when kicking people when the server is full.")] public string ServerFullReason =
"Server is full"; "Server is full";
@ -134,90 +134,92 @@ namespace TShockAPI
[Description("Deprecated. Use ServerName instead.")] public string ServerNickname = "TShock Server"; [Description("Deprecated. Use ServerName instead.")] public string ServerNickname = "TShock Server";
[Description("Enable/Disable the rest api.")] public bool RestApiEnabled; [Description("Enable/disable the rest api.")] public bool RestApiEnabled;
[Description("This is the port which the rest api will listen on.")] public int RestApiPort = 7878; [Description("This is the port which the rest api will listen on.")] public int RestApiPort = 7878;
[Description("Disable tombstones for all players.")] public bool DisableTombstones = true; [Description("Disable tombstones for all players.")] public bool DisableTombstones = true;
[Description("Displays a player's IP on join to everyone who has the log permission")] public bool DisplayIPToAdmins; [Description("Displays a player's IP on join to everyone who has the log permission.")] public bool DisplayIPToAdmins;
[Description( [Description(
"Some tiles are 'fixed' by not letting TShock handle them. Disabling this may break certain asthetic tiles.")] public "Some tiles are 'fixed' by not letting TShock handle them. Disabling this may break certain aesthetic tiles.")] public
bool EnableInsecureTileFixes = true; bool EnableInsecureTileFixes = true;
[Description("Kicks users using a proxy as identified with the GeoIP database")] public bool KickProxyUsers = true; [Description("Kicks users using a proxy as identified with the GeoIP database.")] public bool KickProxyUsers = true;
[Description("Disables hardmode, can't never be activated. Overrides /starthardmode")] public bool DisableHardmode; [Description("Disables hardmode, can't never be activated. Overrides /starthardmode.")] public bool DisableHardmode;
[Description("Disables Dungeon Guardian from being spawned by player packets, this will instead force a respawn")] public bool DisableDungeonGuardian; [Description("Disables the dungeon guardian from being spawned by player packets, this will instead force a respawn.")] public bool DisableDungeonGuardian;
[Description("Enable Server Side Inventory checks, EXPERIMENTAL")] public bool ServerSideInventory; [Description("Enable server side inventory checks, EXPERIMENTAL")] public bool ServerSideInventory;
[Description("How often SSI should save, in minutes")] public int ServerSideInventorySave = 15; [Description("How often SSI should save, in minutes.")] public int ServerSideInventorySave = 15;
[Description("Time, in milliseconds, to disallow discarding items after logging in when ServerSideInventory is ON")] public int LogonDiscardThreshold=250; [Description("Time, in milliseconds, to disallow discarding items after logging in when ServerSideInventory is ON.")] public int LogonDiscardThreshold=250;
[Description("Disables reporting of playercount to the stat system.")] public bool DisablePlayerCountReporting; [Description("Disables reporting of playercount to the stat system.")] public bool DisablePlayerCountReporting;
[Description("Disables clown bomb projectiles from spawning")] public bool DisableClownBombs; [Description("Disables clown bomb projectiles from spawning.")] public bool DisableClownBombs;
[Description("Disables snow ball projectiles from spawning")] public bool DisableSnowBalls; [Description("Disables snow ball projectiles from spawning.")] public bool DisableSnowBalls;
[Description( [Description(
"Change ingame chat format, {0} = Group Name, {1} = Group Prefix, {2} = Player Name, {3} = Group Suffix, {4} = Chat Message" "Changes ingame chat format: {0} = Group Name, {1} = Group Prefix, {2} = Player Name, {3} = Group Suffix, {4} = Chat Message"
)] public string ChatFormat = "{1}{2}{3}: {4}"; )] public string ChatFormat = "{1}{2}{3}: {4}";
[Description("Change the chat format when using chat above heads. This begins with a player name wrapped in brackets, as per Terraria's formatting. Same formatting as ChatFormat.")] public string ChatAboveHeadsFormat = "{4}"; [Description("Change the chat format when using chat above heads. This begins with a player name wrapped in brackets, as per Terraria's formatting. Same formatting as ChatFormat.")] public string ChatAboveHeadsFormat = "{4}";
[Description("Force the world time to be normal, day, or night")] public string ForceTime = "normal"; [Description("Force the world time to be normal, day, or night.")] public string ForceTime = "normal";
[Description("Disable/Revert a player if they exceed this number of tile kills within 1 second.")] public int [Description("Disables/reverts a player if this number of tile kills is exceeded within 1 second.")] public int
TileKillThreshold = 60; TileKillThreshold = 60;
[Description("Disable/Revert a player if they exceed this number of tile places within 1 second.")] public int [Description("Disables/reverts a player if this number of tile places is exceeded within 1 second.")]
public int
TilePlaceThreshold = 20; TilePlaceThreshold = 20;
[Description("Disable a player if they exceed this number of liquid sets within 1 second.")] public int [Description("Disables a player if this number of liquid sets is exceeded within 1 second.")] public int
TileLiquidThreshold = 15; TileLiquidThreshold = 15;
[Description("Disable a player if they exceed this number of projectile new within 1 second.")] public int [Description("Disable a player if this number of projectiles is created within 1 second.")]
public int
ProjectileThreshold = 50; ProjectileThreshold = 50;
[Description("Ignore shrapnel from crystal bullets for Projectile Threshold.")] public bool [Description("Ignore shrapnel from crystal bullets for projectile threshold.")] public bool
ProjIgnoreShrapnel = true; ProjIgnoreShrapnel = true;
[Description("Require all players to register or login before being allowed to play.")] public bool RequireLogin; [Description("Requires all players to register or login before being allowed to play.")] public bool RequireLogin;
[Description( [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)" "Disables invisibility potions from being used in PvP (Note, can be used in the client, but the effect isn't sent to the rest of the server)."
)] public bool DisableInvisPvP; )] public bool DisableInvisPvP;
[Description("The maximum distance players disabled for various reasons can move from")] public int [Description("The maximum distance players disabled for various reasons can move from.")] public int
MaxRangeForDisabled = 10; MaxRangeForDisabled = 10;
[Description("Server password required to join server")] public string ServerPassword = ""; [Description("Server password required to join the server.")] public string ServerPassword = "";
[Description("Protect chests with region and build permissions")] public bool RegionProtectChests; [Description("Protect chests with region and build permissions.")] public bool RegionProtectChests;
[Description("Disable users from being able to login with account password when joining")] public bool [Description("Disable users from being able to login with account password when joining.")] public bool
DisableLoginBeforeJoin; DisableLoginBeforeJoin;
[Description("Allows users to register any username with /register")] public bool AllowRegisterAnyUsername; [Description("Allows users to register any username with /register.")] public bool AllowRegisterAnyUsername;
[Description("Allows users to login with any username with /login")] public bool AllowLoginAnyUsername = true; [Description("Allows users to login with any username with /login.")] public bool AllowLoginAnyUsername = true;
[Description("The maximum damage a player/npc can inflict")] public int MaxDamage = 175; [Description("The maximum damage a player/npc can inflict.")] public int MaxDamage = 175;
[Description("The maximum damage a projectile can inflict")] public int MaxProjDamage = 175; [Description("The maximum damage a projectile can inflict.")] public int MaxProjDamage = 175;
[Description("Ignores checking to see if player 'can' update a projectile")] public bool IgnoreProjUpdate = false; [Description("Ignores checking to see if player 'can' update a projectile.")] public bool IgnoreProjUpdate = false;
[Description("Ignores checking to see if player 'can' kill a projectile")] public bool IgnoreProjKill = false; [Description("Ignores checking to see if player 'can' kill a projectile.")] public bool IgnoreProjKill = false;
[Description("Ignores all no clip checks for players")] public bool IgnoreNoClip = false; [Description("Ignores all no clip checks for players.")] public bool IgnoreNoClip = false;
[Description("Allow Ice placement even when user does not have canbuild")] public bool AllowIce = false; [Description("Allow ice placement even when user does not have canbuild.")] public bool AllowIce = false;
[Description("Allows corrutption to spread when a world is hardmode.")] public bool AllowCorruptionCreep = true; [Description("Allows corrutption to spread when a world is hardmode.")] public bool AllowCorruptionCreep = true;
@ -229,11 +231,11 @@ namespace TShockAPI
[Description("How many things a statue spawns can exist in the world before it stops spawning. Default = 10")] public int StatueSpawnWorld = 10; [Description("How many things a statue spawns can exist in the world before it stops spawning. Default = 10")] public int StatueSpawnWorld = 10;
[Description("Prevent banned items from being /i or /give")] public bool PreventBannedItemSpawn = false; [Description("Prevent banned items from being /i or /give.")] public bool PreventBannedItemSpawn = false;
[Description("Prevent banks on SSI")] public bool DisablePiggybanksOnSSI = false; [Description("Prevent banks on SSI.")] public bool DisablePiggybanksOnSSI = false;
[Description("Prevent players from interacting with the world if dead")] public bool PreventDeadModification = [Description("Prevent players from interacting with the world if dead.")] public bool PreventDeadModification =
false; false;
[Description("Displays chat messages above players' heads, but will disable chat prefixes to compensate.")] public [Description("Displays chat messages above players' heads, but will disable chat prefixes to compensate.")] public

View file

@ -129,7 +129,7 @@ namespace TShockAPI
[Description("User can change the homes of NPCs.")] public static readonly string movenpc; [Description("User can change the homes of NPCs.")] public static readonly string movenpc;
[Description("Users can stop people from TPing to them")] public static readonly string tpallow; [Description("Users can stop people from teleporting to them")] public static readonly string tpallow;
[Description("Users can tp to anyone")] public static readonly string tpall; [Description("Users can tp to anyone")] public static readonly string tpall;
@ -149,9 +149,9 @@ namespace TShockAPI
[Description("User can talk in third person")] public static readonly string cantalkinthird; [Description("User can talk in third person")] public static readonly string cantalkinthird;
[Description("Bypass Server Side Inventory checks")] public static readonly string bypassinventorychecks; [Description("Bypass server side inventory checks")] public static readonly string bypassinventorychecks;
[Description("Allow unrestricted Send Tile Square usage, for client side world editing")] public static readonly [Description("Allow unrestricted SendTileSquare usage, for client side world editing.")] public static readonly
string allowclientsideworldedit; string allowclientsideworldedit;
[Description("User can summon bosses using items")] [Description("User can summon bosses using items")]