List of config keys: Difference between revisions
Appearance
No edit summary |
|||
| Line 366: | Line 366: | ||
| Enumeration | | Enumeration | ||
| "OneFile" | | "OneFile" | ||
| | | Log file organization: | ||
*'''OneFile''' - All logs are written to one file. | |||
*'''SplitBySession''' - A new timestamped logfile is made every time the server is started. | |||
*'''SplitByDay''' - A new timestamped logfile is created every 24 hours. | |||
| "OneFile" / "SplitBySession" / "SplitByDay" | |||
|- | |- | ||
| MaxLogs | | MaxLogs | ||
Revision as of 03:29, 6 November 2011
| This page is a work in progress |
General
| Key | Type | Default | Description | Restrictions |
|---|---|---|---|---|
| ServerName | String | "Custom Minecraft Server (fCraft)" | The name of the server, as shown on the welcome screen and the official server list (if server is public). | Between 1 and 64 characters long. |
| MOTD | String | "Welcome to the server!" | MOTD (Message Of The Day) is a message shown to connecting players right under the server name. It may be left blank. If WoMEnableEnvExtensions is enabled, non-WoM users will not see this. | Between 0 and 64 characters long. |
| MaxPlayers | Integer | 20 | Maximum number of players on the server. Having more players uses more RAM and more bandwidth. If a player's rank is given a "reserved slot" on the server, they can join even if server is full. | Between 1 and 1000. |
| MaxPlayersPerWorld | Integer | 20 | Maximum number of players allowed to be on the same world at the same time. Minecraft protocol limits total number of players per world to 128. Note that having more people on a world increases everyone's bandwidth use. | Between 1 and 128. |
| DefaultRank | Rank | Blank ("lowest rank") | New players will be assigned this rank by default. It's generally a good idea not to give new players many powers until they prove themselves trustworthy. | Full rank name. Leave blank for "lowest rank." |
| IsPublic | True/False | False | Public servers are listed on minecraft.net server list, so expect random players to join. Private servers can only be joined by players who already know the server port/address or URL. Note that the URL changes if your computer's IP or server's port change. | "True" or "False" |
| Port | Integer | 25565 | Port number on your local machine that fCraft uses to listen for incoming connections. If you are behind a router, you may need to set up port forwarding. You may also need to add a firewall exception for ServerGUI/ServerCLI/ConfigGUI. Note that your server's URL will change if you change the port number. | Between 1 and 65535. |
| UploadBandwidth | Integer (KB/s) | 100 | Total available upload bandwidth, in kilobytes per second (KB/s). This number is used to pace drawing commands to prevent server from overwhelming the Internet connection with data. | Between 1 and 32767. |
Chat
| Key | Type | Default | Description | Restrictions |
|---|---|---|---|---|
| RankColorsInChat | True/False | True | Whether to color player names in chat and in-game based on their rank. | "True" or "False" |
| RankColorsInWorldNames | True/False | True | Whether to color world names in chat based on their build/access permissions. | "True" or "False" |
| RankPrefixesInChat | True/False | False | Whether to show 1-character prefixes in chat before player names. This can be used to set up IRC-style "+" and "@" prefixes for ops. | "True" or "False" |
| RankPrefixesInList | True/False | False | Whether to show prefixes in the player list. As a side-effect, Minecraft client will not show custom skins for players with prefixed names. | "True" or "False" |
| ShowConnectionMessages | True/False | True | Whether to announce players joining or leaving the server in chat. | "True" or "False" |
| ShowJoinedWorldMessages | True/False | True | Whether to show messages when players change worlds. | "True" or "False" |
| SystemMessageColor | Color | Yellow (E) | Color of normal system messages (e.g. command feedback). | Color code or name. |
| HelpColor | Color | Lime (A) | Color of command usage examples in help. | Color code or name. |
| SayColor | Color | Green (2) | Color of messages produced by /Say command. | Color code or name. |
| AnnouncementColor | Color | Green (2) | Color of announcements and rules. Default is dark-green. Note that this default color can be overridden by colorcodes in announcement and rule files. | Color code or name. |
| PrivateMessageColor | Color | Aqua (B) | Color of private and rank-wide messages. | Color code or name. |
| MeColor | Color | Purple (5) | Color of /Me command messages. | Color code or name. |
| WarningColor | Color | Red (C) | Color of error and warning messages. | Color code or name. |
| AnnouncementInterval | Integer (Minutes) | 0 ("disabled") | Announcement interval, in minutes. Set to 0 to disable announcements. Announcements are shown to all players, one line at a time, in random order. | Between 1 and 2147483647, or 0 to disable. |
Worlds
| Key | Type | Default | Description | Restrictions |
|---|---|---|---|---|
| DefaultBuildRank | Rank | Blank ("default rank") | When new worlds are created with the /WLoad command, the build permission for new worlds will default to this rank. | Full rank name.
Leave blank for "default rank." |
| MapPath | Path | Blank ("./maps/") | Custom path for storing map files. If you change this value, make sure to move the map files before starting the server again. If folder does not exist, fCraft will attempt to create it. Requires a full server restart to change the setting (cannot be updated with /Reload). If the command-line "mappath" parameter is given, this setting is overridden. | Absolute path, or path relative to the working path.
Leave blank for default value ("./maps/"). |
Security
| Key | Type | Default | Description | Restrictions |
|---|---|---|---|---|
| VerifyNames | Enumeration | "Balanced" | Name verification ensures that connecting players are not impersonating someone else. "Always" uses only the main verification method. It can sometimes produce false negatives - for example if server has just restarted, or if minecraft.net heartbeats are timing out. "Balanced" checks player's current and on-record IP address to eliminate false negatives. "Never" is dangerous, and may allow players to impersonate others. | "Never" / "Balanced" / "Always" |
| MaxConnectionsPerIP | Integer | 0 ("unlimited") | Restricts the number of connections allowed from any one IP address. Note that all players on the same LAN will share an IP, and may be prevented from joining together. | Between 1 and 2147483647, or 0 for "unlimited". |
| AllowUnverifiedLAN | True/False | False | Allow players from your local network (LAN) to connect without name verification. May be useful if minecraft.net is blocked on your LAN for some reason, or your LAN friends are having trouble joining. Warning: Unverified players can log in with ANY name - even as you! Do not enable this on public networks. | "True" or "False" |
| PatrolledRank | Rank | Blank ("default rank") | When players use /Patrol or /SpecPatrol commands, they will be teleported to players of this (or lower) rank. "Patrolling" means teleporting to other players to check on them, usually while hidden. | Full rank name. Leave blank for "default rank." |
| AntispamMessageCount | Integer | 4 | Number of messages that a player needs to type within AntispamInterval seconds to trigger the AntiSpam warning. Set this to 0 to disable AntiSpam. | Between 2 and 64, or 0 for "unlimited". |
| AntispamInterval | Integer | 5 | Number of seconds over which the player needs to type AntispamMessageCount messages to trigger AntiSpam warning. Set this to 0 to disable AntiSpam. | Between 1 and 64, or 0 for "unlimited". |
| AntispamMuteDuration | Integer (Seconds) | 5 | Duration of automatic mute if AntiSpam is triggered, in seconds. Set this to 0 to disable automatic mute (and only leave the warning). | Between 1 and 86400, or 0 for "disabled". |
| AntispamMaxWarnings | Integer | 2 | Number of warnings given to a player (number of times AntiSpam is triggered) before the player is kicked. Set this to 0 to disable automatic kicks. | Between 1 and 64, or 0 for "disabled". |
| PaidPlayersOnly | True/False | False | Only allow players who have a paid Minecraft account (not recommended). This will help filter out griefers with throwaway accounts, but will also prevent many legitimate players from joining. | "True" or "False" |
| RequireBanReason | True/False | False | Require players to specify a reason/memo when banning or unbanning someone. | "True" or "False" |
| RequireKickReason | True/False | False | Require players to specify a reason/memo when kicking someone. | "True" or "False" |
| RequireRankChangeReason | True/False | False | Require players to specify a reason/memo when promoting or demoting someone. | "True" or "False" |
| AnnounceKickAndBanReasons | True/False | True | Announce the reason/memo in chat when someone gets kicked/banned/unbanned. | "True" or "False" |
| AnnounceRankChanges | True/False | True | Announce promotions and demotions in chat. | "True" or "False" |
| AnnounceRankChangeReasons | True/False | True | Announce the reason/memo in chat when someone gets promoted or demoted. | "True" or "False" |
| BlockDBEnabled | True/False | True | If enabled, allows edit information to be stored per-block. Enables /BlockDB, /BInfo, /UndoArea, and /UndoPlayer commands. Requires a full server restart to change the setting (cannot be updated with /Reload). | "True" or "False" |
| BlockDBAutoEnable | True/False | True | Automatically enabled BlockDB on all worlds editable by a certain rank or below. Has no effect unless BlockDBEnabled is set to "True" | "True" or "False" |
| BlockDBAutoEnableRank | Rank | Blank ("default rank") | Worlds editable by players of this rank (or below) will have BlockDB enabled automatically. Has no effect unless BlockDBEnabled and BlockDBAutoEnable are set to "True" | Full rank name. Leave blank for "default rank." |
Saving and Backup
| Key | Type | Default | Description | Restrictions |
|---|---|---|---|---|
| SaveInterval | Integer (Seconds) | 90 | Auto-save interval for loaded map files. A higher setting (120+ seconds) is recommended for busy servers with many maps. If disabled (set to 0), maps are only saved when a world is unloaded or when the server is shut down. | Between 10 and 2147483647 seconds, or 0 for "disabled". |
| BackupOnStartup | True/False | False | Whether to create a backup of every map when the server starts. | "True" or "False" |
| BackupOnJoin | True/False | False | Create backups any time a player joins a map. Both a timestamp and player's name are included in the filename. This is not recommended for busy servers - you could have thousands of backups in a day. | "True" or "False" |
| BackupOnlyWhenChanged | True/False | False | Only create backups if the map was modified since last backup. | "True" or "False" |
| DefaultBackupInterval | Integer (Minutes) | 20 | Default interval for saving periodic map backups for loaded worlds. A world is considered ""loaded"" if there is at least one player on it. This setting can be overridden on a per-world basis. Set to 0 to disable periodic backups. | Between 1 and 2147483647 minutes, or 0 for "disabled". |
| MaxBackups | Integer (Files) | 0 ("unlimited") | Maximum number of backup files that fCraft should keep. If exceeded, oldest backups will be deleted first. | Between 1 and 2147483647 backups, or 0 for "unlimited". |
| MaxBackupSize | Integer (MB) | 0 ("unlimited") | Maximum combined filesize of all backups, in MB. If exceeded, oldest backups will be deleted first. | Between 1 and 2147483647 MB, or 0 for "unlimited". |
| BackupDataOnStartup | True/False | False | Create backups of server data (PlayerDB and IPBanList) on startup. | "True" or "False" |
Logging
| Key | Type | Default | Description | Restrictions |
|---|---|---|---|---|
| LogMode | Enumeration | "OneFile" | Log file organization:
|
"OneFile" / "SplitBySession" / "SplitByDay" |
| MaxLogs | Int (Files) | 0 ("unlimited") | Maximum number of log files to keep. If exceeded, oldest logs will be erased first. Set this to 0 to keep all logs. | Between 1 and 2147483647 logfiles, or 0 for "unlimited". |