fCraft Wiki - User contributions [en]

Installation instructions

2013-06-01T14:09:03Z

Hellenion: /* Linux, Unix, MacOS X (Mono) */ NTFS recommendation

=Windows=
# fCraft requires Microsoft .NET Framework 3.5. Your system may already have it installed, and you can [http://www.microsoft.com/download/en/details.aspx?id=22 download it from microsoft.com].
# Download a current copy of fCraft here: {{LatestVersion}}
# Extract the zip file into the directory where you wish to keep all the server data (maps, logs, config, etc).
# Run <code>ConfigGUI.exe</code> before starting the server and carefully configure the options. Your configuration will be stored in ''config.xml''. You world list will be stored in ''worlds.xml''.
# After configuring the server, you can run either <code>ServerGUI.exe</code> (GUI version) OR <code>ServerCLI.exe</code> (command-line version) to start the server. Do not run both at the same time.

=Linux, Unix, MacOS X (Mono)=
{{notice|fCraft has only been officially tested on
*Ubuntu 10/12
*Debian 6
*MacOS X 10.6
If you are using a different distribution, use at your own risk.}}
# Download a current copy of fCraft here: {{LatestVersion}}. Use ''gunzip'' to extract it.
## Putting the PlayerDB.txt on an NTFS partition can greatly reduce chance of corruption on unsafe shutdown/power loss.
# fCraft requires Mono 2.6.4 (minimum) or Mono 2.10+ (recommended) runtime. You can [http://www.go-mono.com/mono-downloads/download.html download from www.mono-project.org], or (on some Linux distributions) install it through your package manager (like ''yum'' or ''apt-get''). If the latest version of Mono is not available for your platform, you can [[Building Mono|build your own copy of Mono]]. Note that to be able to use graphical fCraft components (ServerGUI and ConfigGUI) you will also need ''libgdiplus'' (GDI+ library).
# If you're intending to run a public server that appears on minecraft.net's server list, you need to import https certificates to tell mono you trust them, this can be done by running <CODE>mozroots --import --ask-remove</CODE> as the fCraft user on your system.
# Before starting fCraft, make sure that it has read/write permissions in the fCraft directory. I do not recommend running fCraft as root - it is always safer to run servers under their own limited user accounts.
# To run ".exe" files with Mono, use the following syntax:
#: Mono 2.6.4: <code>mono SomeFile.exe</code>
#: Mono 2.8+: <code>mono --gc=sgen SomeFile.exe</code>
{{notice|'''Consider using [[fcraftd]] script, made by Hellenion, to manage your *nix server!}}
# From here on out is roughly the same as on Windows. You can run <code>ConfigGUI.exe</code> to configure your server, and then either <code>ServerGUI.exe</code> OR <code>ServerCLI.exe</code> to start the server.
#: If you want to run console-only on a headless server, the ConfigGUI probably won't work for you to configure things. You can run ConfigGUI on your local machine and upload edited config.xml and worlds.xml files. Alternatively, edit <code>config.xml</code> manually with your favorite text editor. Detailed information about config.xml keys can be found [[List of config keys|here]].

=[[Troubleshooting]]=
==Autentication/Decription failed for heartbeats==
This recently surfaced when mollstam introduced https for minecraft.net, causing some trust issues with fCraft's heartbeats, especially under mono, since mono trusts no certificates by default. To fix this one must import certificates, with <CODE>mozroots --import --ask-remove</CODE> Mozillas certificates are imported into mono. This must be done on the user-account that will run the server, importing it as root does not apply it system-wide. (it can be made system wide with <CODE>--machine</CODE> but this is not the default for a reason.)

/Zones

2013-03-01T21:57:54Z

Hellenion: added a link to ZAdd

{{CommandBox
|name=Zones
|purpose=Displays all zones on the current world.
|aliases=
|uses=/Zones

/Zones WorldName
|cat=Zone
|perm=
|console=Yes
|v=0.400
|}}
Lists all zones names, dimensions, and rank requirements on a map. To add a zone, see {{cmd|ZAdd}}.

==<code>/Zones</code>==
:Lists all zones on the current world. Not usable from console.

==<code>/Zones WorldName</code>==
:Lists all zones on a specified world.

{{LastUpdated|1650}}

Fcraftd

2013-02-12T22:09:21Z

Hellenion: /* Known bugs */ expanded cause of bug

{{DISPLAYTITLE:fcraftd}}fcraftd is an unofficial script that attempts to work around monos incapabilities. It is a bash script that works on most if not all linux boxes. Despite what the name may suggest, fcraftd was not written to make fCraft into a system daemon, though possible, might not be a good idea.

== Features ==
:* fCraft continues running even after logout
:* Ability to connect back to console at any time, even with multiple administrators at once
:* Reliable restarting under mono
:* Supports external HeartbeatSaver
:* No further knowledge of linux neccesary
:* An optional simple configuration file
:* Ability to stop or restart without console interaction
:* Ability to update/install fCraft

== <DEL>Source</DEL> <INS>Downloads</INS> ==
: fcraftd is free and open-source, but may not be mass distributed by any entities other than the solidus server and fcraft.net. For example: Sharing is O.K., mirroring is not. You're free to edit fcraftd, but as before: These may not be mass distributed by say, putting up a link of the modified version on your own site. Exemptions to this are assigned at will only by the [http://radar.solidusserver.net/ solidus server].

:* [http://radar.solidusserver.net/ware/fcraftd Direct download]
:* config file template direct download (soon)

== Usage ==
=== Installation ===
:: You can install fcraftd at system level, making it available to all users from everywhere. Or can be installed locally to anywhere the user wants it to be. Putting it next to fCraft.dll will require the least from the user.
:: Edits to the script itself are rarely necessary with support for both system- as user-level configuration. Being FHS-aware, it'll load an overriding system <CODE>fcraftd.conf</CODE> from the <CODE>etc/</CODE> directory corresponding to the <CODE>bin/</CODE> it is in, after having loaded the user's similarly named configuration from the current directory or from <CODE>~/.config/</CODE>.
=== Options ===
:: Note that all of these have configurable options, see the section on [[#Configuration|Configuration]].
::; <CODE>fcraftd start</CODE>
::: Starts fCraft if not yet running, otherwise drops to the <CODE>console</CODE> option.
::: by default fCraft can be installed anywhere in $PATH or in the user's current directory.
::; <CODE>fcraftd stop</CODE>
::: Shuts fCraft down by means of the {{cmd|Shutdown}} command, then waits for it to die.
::: Will only stop fCraft sessions started by fcraftd.
::; <CODE>fcraftd console</CODE>
::: Connects to fCraft's console if started.
::: Return to shell by pressing <CODE>Ctrl</CODE>+<CODE>a</CODE> first, then press '<CODE>d</CODE>'.
::; <CODE>fcraftd restart</CODE>
::: Shuts down the server completely before starting it afresh.
::: Does currently not use fCraft's {{cmd|Restart}}, but rather a full flush to clear any memory-leaks.
::; <CODE>fcraftd status</CODE>
::: Prints whether or not the server is currently running.
::; <CODE>fcraftd beat</CODE>
::: Starts fCrafts external [[HeartbeatSaver]], like fCraft, only one can be ran per user.
::; <CODE>fcraftd flatline</CODE>
::: Stops the users HeartbeatSaver.
::; <CODE>fcraftd install</CODE>
::: Installs the latest version of fCraft (Not the fcraftd script), can be used for both fresh installs as for updating an outdated fCraft version, uses the [[UpdateInstaller]]. The updater will install fCraft to the locations specified in the config.
::: The updater binary will be removed after a successful update.

=== Configuration ===
:: just reassign the vars

== Known bugs ==
:* fCraft's autoupdater doesn't work or crashes fCraft, only manual updating works.
:** The updater doesn't save to the binaries folder, so the arguments passed are incorrect, causing it to fail.
:* Although mostly FHS aware, will not load system-config from <CODE>/etc/opt/*</CODE>
:* fcraftd was written for (but does not depend on) an initscripts/SysV linux installation, which has become deprecated
:* fcraftd depends on the <CODE>screen</CODE> program, which is likely to be replaced by <CODE>tmux</CODE> in the future
:* fcraftd probably does not conform strict posix

Fcraftd

2012-11-26T06:44:32Z

Hellenion: Most of the documentation and a download link

fcraftd is an unofficial script that attempts to work around monos incapabilities. It is a bash script that works on most if not all linux boxes. Despite what the name may suggest, fcraftd was not written to make fCraft into a system daemon, though possible, might not be a good idea.

== Features ==
:* fCraft continues running even after logout
:* Ability to connect back to console at any time, even with multiple administrators at once
:* Reliable restarting under mono
:* Supports external HeartbeatSaver
:* No further knowledge of linux neccesary
:* An optional simple configuration file
:* Ability to stop or restart without console interaction
:* Ability to update/install fCraft

== <DEL>Source</DEL> <INS>Downloads</INS> ==
: fcraftd is free and open-source, but may not be mass distributed by any entities other than the solidus server and fcraft.net. For example: Sharing is O.K., mirroring is not. You're free to edit fcraftd, but as before: These may not be mass distributed by say, putting up a link of the modified version on your own site. Exemptions to this are assigned at will only by the [http://radar.solidusserver.net/ solidus server].

:* [http://radar.solidusserver.net/ware/fcraftd Direct download]
:* config file template direct download (soon)

== Usage ==
=== Installation ===
:: You can install fcraftd at system level, making it available to all users from everywhere. Or can be installed locally to anywhere the user wants it to be. Putting it next to fCraft.dll will require the least from the user.
:: Edits to the script itself are rarely necessary with support for both system- as user-level configuration. Being FHS-aware, it'll load an overriding system <CODE>fcraftd.conf</CODE> from the <CODE>etc/</CODE> directory corresponding to the <CODE>bin/</CODE> it is in, after having loaded the user's similarly named configuration from the current directory or from <CODE>~/.config/</CODE>.
=== Options ===
:: Note that all of these have configurable options, see the section on [[#Configuration|Configuration]].
::; <CODE>fcraftd start</CODE>
::: Starts fCraft if not yet running, otherwise drops to the <CODE>console</CODE> option.
::: by default fCraft can be installed anywhere in $PATH or in the user's current directory.
::; <CODE>fcraftd stop</CODE>
::: Shuts fCraft down by means of the {{cmd|Shutdown}} command, then waits for it to die.
::: Will only stop fCraft sessions started by fcraftd.
::; <CODE>fcraftd console</CODE>
::: Connects to fCraft's console if started.
::: Return to shell by pressing <CODE>Ctrl</CODE>+<CODE>a</CODE> first, then press '<CODE>d</CODE>'.
::; <CODE>fcraftd restart</CODE>
::: Shuts down the server completely before starting it afresh.
::: Does currently not use fCraft's {{cmd|Restart}}, but rather a full flush to clear any memory-leaks.
::; <CODE>fcraftd status</CODE>
::: Prints whether or not the server is currently running.
::; <CODE>fcraftd beat</CODE>
::: Starts fCrafts external [[HeartbeatSaver]], like fCraft, only one can be ran per user.
::; <CODE>fcraftd flatline</CODE>
::: Stops the users HeartbeatSaver.
::; <CODE>fcraftd install</CODE>
::: Installs the latest version of fCraft (Not the fcraftd script), can be used for both fresh installs as for updating an outdated fCraft version, uses the [[UpdateInstaller]]. The updater will install fCraft to the locations specified in the config.
::: The updater binary will be removed after a successful update.

=== Configuration ===
:: just reassign the vars

== Known bugs ==
:* fCraft's autoupdater doesn't work or crashes fCraft, only manual updating works.
:* Although mostly FHS aware, will not load system-config from <CODE>/etc/opt/*</CODE>
:* fcraftd was written for (but does not depend on) an initscripts/SysV linux installation, which has become deprecated
:* fcraftd depends on the <CODE>screen</CODE> program, which is likely to be replaced by <CODE>tmux</CODE> in the future
:* fcraftd probably does not conform strict posix

Fcraftd

2012-11-24T13:09:44Z

Hellenion: moved planned feature to actual features

fcraftd is an unofficial script that attempts to work around monos incapabilities. It is a standard bash script that works on most if not all linux boxes. Despite what the name may suggest, fcraftd was not written to make fCraft into a system daemon, though possible, might not be a good idea.

== Features ==
:* fCraft continues running even after logout
:* Ability to connect back to console at any time, even with multiple administrators at once
:* Reliable restarting under mono
:* Supports external HeartbeatSaver
:* No further knowledge of linux neccesary
:* An optional simple configuration file
:* Ability to stop or restart without console interaction
:* Ability to update/install fCraft

== Known bugs ==
:* fCraft's autoupdater doesn't work or crashes fCraft, only manual updating works.
:* fcraftd was written for (but does not depend on) an initscripts/SysV linux installation, which has become deprecated
:* fcraftd depends on the <CODE>screen</CODE> program, which is likely to be replaced by <CODE>tmux</CODE> in the future
:* fcraftd probably does not conform strict posix

== <DEL>Source</DEL> <INS>Downloads</INS> ==
:...<STRONG><EM>SOON</EM></STRONG>

Fcraftd

2012-11-22T22:03:27Z

Hellenion: fcraftd draft

fcraftd is an unofficial script that attempts to work around monos incapabilities. It is a standard bash script that works on most if not all linux boxes. Despite what the name may suggest, fcraftd was not written to make fCraft into a system daemon, though possible, might not be a good idea.

== Features ==
:* fCraft continues running even after logout
:* Ability to connect back to console at any time, even with multiple administrators at once
:* Reliable restarting under mono
:* Supports external HeartbeatSaver
:* No further knowledge of linux neccesary
:* An optional simple configuration file
:* Ability to stop or restart without console interaction

== Known bugs ==
:* The updater doesn't work or crashes fCraft
:* fcraftd was written for (but does not depend on) an initscripts/SysV linux installation, which has become deprecated
:* fcraftd depends on the <CODE>screen</CODE> program, which is likely to be replaced by <CODE>tmux</CODE> in the future
:* fcraftd probably does not conform strict posix

== <DEL>Source</DEL> <INS>Downloads</INS> ==
:...<STRONG><EM>SOON</EM></STRONG>

== Planned ==
:*Ability to update/install fCraft

UpdateInstaller

2012-11-14T08:55:33Z

Hellenion: Start of a the UpdateInstaller page

The [[UpdateInstaller]] is a utility downloaded by the server front-ends when they get out of date, update checks are preformed only when the server starts. Depending on your configuration, it can be automatically launched to always stay up-to-date. The UpdateInstaller has the latest fCraft build embedded and extracts it to replace the current fCraft binaries.

UpdateInstaller doesn't normally change the <CODE>config.xml</CODE> or <CODE>PlayerDB.txt</CODE>, so all configuration and player info is preserved. config.xml updating is done only by the ConfigGUI, while the PlayerDB is converted to a possible new version by the server itself.

UpdateInstaller is normally started by the server front-end, which will exit itself to allow for a clean update.

List of command-line options

2012-11-13T21:02:34Z

Hellenion: Specified exit code behaviour and provided a tip on automation.

In addition to many settings stored in config.xml, fCraft has several special options that can only be set via command-line switches:

{|class="wikitable"
| align="right" | <code>--path=<path></code>
| Working path (directory) that fCraft should use. If the given path is relative, it's computed against the location of fCraft.dll. If no path is given, location of fCraft.dll is used.
|-
| align="right" | <code>--logpath=<path></code>
| Path (directory) where the log files should be placed. If the given path is relative, it's computed against the working path.
|-
| align="right" | <code>--mappath=<path></code>
| Path (directory) where the map files should be loaded from/saved to. This setting overrides MapPath key in config.xml. If the given path is relative, it's computed against the working path.
|-
| align="right" | <code>--config=<path></code>
| Path (file) of the configuration file, including the file name (typically "config.xml"). If the given path is relative, it's computed against the working path.
|-
| align="right" | <code>--norestart</code>
| If this flag is present, fCraft will shutdown whenever it would normally restart (e.g. automatic updates or /restart command). This may be useful if you are using an auto-restart script or a process monitor. Even though the server will not restart, it still exits with a restart [[List_of_exit_codes|exit-code]].
|-
| align="right" | <code>--exitoncrash</code>
| If this flag is present, fCraft front-ends will exit at once in the event of an unrecoverable crash, instead of showing a message and prompting for user input. This is preferable when fCraft is managed automatically rather than manually.
|-
| align="right" | <code>--nolog</code>
| If this flag is present, all logging is disabled.
|-
| align="right" | <code>--nocolor</code>
| If this flag is present, ServerCLI will not use any colors or formatting in its console output.
|-
|}
[[Category:Config]]

/Restart

2012-11-13T20:55:32Z

Hellenion: explained --norestart behaviour

{{alert|This command is very unreliable under Mono. Use {{cmd|Shutdown}} instead!}}
{{CommandBox
|name=Restart
|purpose=Restarts the server.
|aliases=
|uses=/Restart <Delay>

/Restart <Delay> <Message>

/Restart Abort
|cat=Maintenance
|perm={{rperm|ShutdownServer}}
|console=Yes
|v=0.500
|}}
Restarts the server remotely. If you want the server to shut itself down and not start back up, use {{cmd|Shutdown}} instead.

If the <CODE>--norestart</CODE> [[List_of_command-line_options|option]] is given, this command will simply shut down the server.

==<code>/Restart <Delay></code>==
:Restarts the server after a specified delay.

==<code>/Restart <Delay> <Message></code>==
:Restarts the server after a specified delay. The given message is announced in the countdown.

==<code>/Restart Abort</code>==
:Aborts any current shutdown or restart countdown. Equivalent to {{cmd|Shutdown|abort}}

{{LastUpdated|1650}}

List of exit codes

2012-11-13T17:29:33Z

Hellenion: Note about the restart exit codes

When ServerCLI or ServerGUI exit, they specify context in the process exit code/exit status.

{| class="wikitable"
|-
! Code
! Name
! Context
|-
|0
|ShutdownCommand
|Server is shutting down, because someone called {{cmd|Shutdown}}.
|-
|1
|RestartCommand
|Server is restarting, because someone called {{cmd|Restart}}.
|-
|2
|FailedToInitialize
|fCraft failed to [[API: Startup|initialize]] (InitLibrary or InitServer failed).
|-
|3
|FailedToStart
|Server initialized properly, but failed to [[API: Startup|start]] (StartServer failed).
|-
|4
|Crashed
|Server has experienced a non-recoverable crash.
|-
|5
|ProcessClosing
|Server process is being closed (ServerGUI was closed, or Ctrl+C/Ctrl+Break was pressed in ServerCLI).
|-
|6
|RestartTimer
|[[List of config keys#Advanced|RestartInterval]] timer triggered.
|-
|7
|RestartForUpdate
|Updater should be ran, then server should be restarted.
|-
|8
|ShutdownForUpdate
|Updater should be ran, then server should NOT be restarted.
|}

===Restarting===
:The restart exit codes are honoured even if the <CODE>--norestart</CODE> [[List_of_command-line_options|option]] is specified.

Architecture

2012-11-13T17:01:04Z

Hellenion: /* Headless operation */ Maprenderer is no longer upcoming

fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.exe).

=Project Directory Structure=
*'''AutoRankEditor''' - experimental
*'''bin'''
**'''Debug''' - binaries built in Debug, Debug_Events, Debug_IRC, and Debug_Scheduler configurations.
**'''Release''' - binaries built in Release configuration.
*'''ConfigCLI''' - experimental command-line config editor
*'''ConfigGUI''' - graphical config editor
*'''fCraft''' - shared components
**'''AutoRank''' - fCraft.AutoRank namespace; AutoRankManager, conditions, and criteria.
**'''Commands''' - fCraft, fCraft.Events namespaces; Command descriptors and handlers, Command/CommandDescriptor/CommandManager classes, CommandCategory enum.
**'''Drawing''' - fCraft.Drawing, fCraft.Events namespaces; DrawOperation base class and Brush-related interfaces; BrushManager; copy/paste- and undo-related classes; Axis enum.
***'''Brushes''' - fCraft.Drawing namespace; All brush implementations.
***'''DrawOps''' - fCraft.Drawing namespace; All DrawOperation implementations.
**'''MapConversion''' - fCraft.MapConversion namespace; MapUtility, class, MapFormat enum, IMapConverter implementations (importers and exporters), NBT and .INI utilities.
**'''Network''' - fCraft, fCraft.Events namespaces; Heartbeat, IP bans, IRC, low-level network utilities, networking component of the Player class.
**'''Player''' - fCraft, fCraft.Events namespaces; Permissions and ranks, player-related constants, PlayerDB and PlayerInfo, Player class, Chat.
**'''System''' - fCraft, fCraft.Events namespaces; Config, Server central class, Logger, Scheduler.
**'''Utils''' - fCraft, JetBrains.Annotations, System.IO.Compression namespaces; various utility classes, extension methods, Vector classes, code annotations.
**'''World''' - fCraft namespace; World and WorldManager classes, Block enum, BlockDB classes, map generation, Zones.
*'''fCraftGUI''' - fCraft.GUI namespace; graphical components shared by ServerGUI and ConfigGUI.
*'''ServerCLI''' - fCraft.ServerCLI namespace; Command-line server front end.
*'''ServerGUI''' - fCraft.ServerGUI namespace; Graphical server front end.
*'''UpdateInstaller''' - fCraft.UpdateInstaller namespace; Self-extracting updater.
*'''UpdateBuilder''' - fCraft.UpdateBuilder namespace; Zips files to include in the UpdateInstaller. Used only during the build process.

==Headless operation==
:Headless servers needn't keep ServerGUI, ConfigGUI nor fCraftGUI, they cannot be ran and are not required by the CLI variants. The [[MapRenderer]] <i>does</i> need fCraftGUI, even though it doesn't create such an interface.
:A server update does re-install the deleted binaries, but those can be removed though a command in the post-update script.

=Key Classes=
*'''fCraft.Command'''
:''fCraft/Commands/Command.cs''
:A text scanner that aids parsing chat commands and their arguments.

*'''fCraft.CommandDescriptor'''
:''fCraft/Commands/CommandDescriptor.cs'''
:Describes a chat command. Defines properties, permission requirements, and usage information. Specifies a handler method. Used to add regular commands.

*'''fCraft.Drawing.DrawOperation'''
:''fCraft/Drawing/DrawOperation.cs''
:Abstract class representing a drawing operation. Used to add draw commands.

*'''fCraft.Chat'''
:''fCraft/Player/Chat.cs''
: Helper class for handling and broadcasting player-generated chat.

*'''fCraft.Permission'''
:''fCraft/Player/Permission.cs''
:Enumeration of all permission types/categories. Every rank definition contains a combination of these.

*'''fCraft.Player'''
:''fCraft/Network/Player.Networking.cs'', ''fCraft/Player/Player.cs'', ''fCraft/Player/Player.Events.cs''
:Object representing volatile state ("session") of a connected player. For persistent state of a known player account, see PlayerInfo. Use "Info" property of the Player class to access the associated PlayerInfo record.

*'''fCraft.PlayerDB'''
:''fCraft/Player/PlayerDB.cs''
:Persistent database of player information. Can be used to look up online or offline players and to gather statistics.

*'''fCraft.PlayerInfo'''
:''fCraft/Player/PlayerInfo.Actions.cs'', ''fCraft/Player/PlayerInfo.cs'', ''fCraft/Player/PlayerInfo.Events.cs''
:Object representing persistent state ("record") of a player, online or offline. There is exactly one PlayerInfo object for each known Minecraft account. All data is stored in the PlayerDB.

*'''fCraft.Rank'''
:''fCraft/Player/Rank.cs''
:A rank that can be assigned to a player. Each player can only hold one rank at a time. Each rank has a name, a set of permissions, and a set of restrictions on those permissions.

*'''fCraft.ConfigKey'''
:''fCraft/System/ConfigKey.cs''
:Enumeration of available configuration keys. ''Config.cs'' contains extension methods for getting/setting keys, resetting key values, and getting key metadata.

*'''fCraft.Logger'''
:''fCraft/System/Logger.cs''
:Central logging class. Logs to file, relays messages to the frontend, submits crash reports.

*'''fCraft.Scheduler'''
:''fCraft/System/Scheduler.cs''
:A general-purpose task scheduler. Can be used to run tasks at certain times, once or periodically. Usable to offloading intensive tasks to the background.

*'''fCraft.Server'''
:''fCraft/System/Server.cs''
:Core of an fCraft server. Manages startup/shutdown, online player sessions, and global events and scheduled tasks.

*'''fCraft.Block'''
:''fCraft/World/Block.cs''
:Enumeration of all standard Minecraft Classic block types.

*'''fCraft.Map'''
:''fCraft/World/Map.cs''
:Represents a loaded map file. Provides methods to get/set blocks, metadata, and zones.

*'''fCraft.World'''
:''fCraft/World/World.cs'', 'fCraft/World/World.Events.cs''
:Represents an entry on the world list. May or may not have a map file loaded. Manages players, access/build security, various metadata, flushing, locking, saving and backups.

=Event Sequences=
*[[API: Startup]]
*[[API: Login]]
*[[API: Shutdown]]
[[Category:Dev]]

User:Hellenion

2012-10-01T18:52:02Z

Hellenion: Start of a user page

... the the element of elements that do not contain themselves.

Installation instructions

2012-10-01T17:43:30Z

Hellenion: /* Linux, Unix, MacOS X (Mono) */ indenting

=Windows=
# fCraft requires Microsoft .NET Framework 3.5. Your system may already have it installed, and you can [http://www.microsoft.com/download/en/details.aspx?id=22 download it from microsoft.com].
# Download a current copy of fCraft here: {{LatestVersion}}
# Extract the zip file into the directory where you wish to keep all the server data (maps, logs, config, etc).
# Run <code>ConfigGUI.exe</code> before starting the server and carefully configure the options. Your configuration will be stored in ''config.xml''. You world list will be stored in ''worlds.xml''.
# After configuring the server, you can run either <code>ServerGUI.exe</code> (GUI version) OR <code>ServerCLI.exe</code> (command-line version) to start the server. Do not run both at the same time.

=Linux, Unix, MacOS X (Mono)=
{{notice|fCraft has only been officially tested on
*Ubuntu 10
*Debian 6
*MacOS X 10.6
If you are using a different distribution, use at your own risk.}}
# Download a current copy of fCraft here: {{LatestVersion}}. Use ''gunzip'' to extract it.
# fCraft requires Mono 2.6.4 (minimum) or Mono 2.10+ (recommended) runtime. You can [http://www.go-mono.com/mono-downloads/download.html download from www.mono-project.org], or (on some Linux distributions) install it through your package manager (like ''yum'' or ''apt-get''). If the latest version of Mono is not available for your platform, you can [[Building Mono|build your own copy of Mono]]. Note that to be able to use graphical fCraft components (ServerGUI and ConfigGUI) you will also need ''libgdiplus'' (GDI+ library).
# If you're intending to run a public server that appears on minecraft.net's server list, you need to import https certificates to tell mono you trust them, this can be done by running <CODE>mozroots --import --ask-remove</CODE> as the fCraft user on your system.
# Before starting fCraft, make sure that it has read/write permissions in the fCraft directory. I do not recommend running fCraft as root - it is always safer to run servers under their own limited user accounts.
# To run ".exe" files with Mono, use the following syntax:
#: Mono 2.6.4: <code>mono SomeFile.exe</code>
#: Mono 2.8+: <code>mono --gc=sgen SomeFile.exe</code>
# From here on out is roughly the same as on Windows. You can run <code>ConfigGUI.exe</code> to configure your server, and then either <code>ServerGUI.exe</code> OR <code>ServerCLI.exe</code> to start the server.
#: If you want to run console-only on a headless server, the ConfigGUI probably won't work for you to configure things. You can run ConfigGUI on your local machine and upload edited config.xml and worlds.xml files. Alternatively, edit <code>config.xml</code> manually with your favorite text editor. Detailed information about config.xml keys can be found [[List of config keys|here]].

=[[Troubleshooting]]=
==Autentication/Decription failed for heartbeats==
This recently surfaced when mollstam introduced https for minecraft.net, causing some trust issues with fCraft's heartbeats, especially under mono, since mono trusts no certificates by default. To fix this one must import certificates, with <CODE>mozroots --import --ask-remove</CODE> Mozillas certificates are imported into mono. This must be done on the user-account that will run the server, importing it as root does not apply it system-wide. (it can be made system wide with <CODE>--machine</CODE> but this is not the default for a reason.)

Installation instructions

2012-10-01T17:42:26Z

Hellenion: /* Linux, Unix, MacOS X (Mono) */ importing certificates is required for public servers.

=Windows=
# fCraft requires Microsoft .NET Framework 3.5. Your system may already have it installed, and you can [http://www.microsoft.com/download/en/details.aspx?id=22 download it from microsoft.com].
# Download a current copy of fCraft here: {{LatestVersion}}
# Extract the zip file into the directory where you wish to keep all the server data (maps, logs, config, etc).
# Run <code>ConfigGUI.exe</code> before starting the server and carefully configure the options. Your configuration will be stored in ''config.xml''. You world list will be stored in ''worlds.xml''.
# After configuring the server, you can run either <code>ServerGUI.exe</code> (GUI version) OR <code>ServerCLI.exe</code> (command-line version) to start the server. Do not run both at the same time.

=Linux, Unix, MacOS X (Mono)=
{{notice|fCraft has only been officially tested on
*Ubuntu 10
*Debian 6
*MacOS X 10.6
If you are using a different distribution, use at your own risk.}}
# Download a current copy of fCraft here: {{LatestVersion}}. Use ''gunzip'' to extract it.
# fCraft requires Mono 2.6.4 (minimum) or Mono 2.10+ (recommended) runtime. You can [http://www.go-mono.com/mono-downloads/download.html download from www.mono-project.org], or (on some Linux distributions) install it through your package manager (like ''yum'' or ''apt-get''). If the latest version of Mono is not available for your platform, you can [[Building Mono|build your own copy of Mono]]. Note that to be able to use graphical fCraft components (ServerGUI and ConfigGUI) you will also need ''libgdiplus'' (GDI+ library).
#: If you're intending to run a public server that appears on minecraft.net's server list, you need to import https certificates to tell mono you trust them, this can be done with <CODE>mozroots --import --ask-remove</CODE> as the fCraft user on your system.
# Before starting fCraft, make sure that it has read/write permissions in the fCraft directory. I do not recommend running fCraft as root - it is always safer to run servers under their own limited user accounts.
# To run ".exe" files with Mono, use the following syntax:
#: Mono 2.6.4: <code>mono SomeFile.exe</code>
#: Mono 2.8+: <code>mono --gc=sgen SomeFile.exe</code>
# From here on out is roughly the same as on Windows. You can run <code>ConfigGUI.exe</code> to configure your server, and then either <code>ServerGUI.exe</code> OR <code>ServerCLI.exe</code> to start the server.
#: If you want to run console-only on a headless server, the ConfigGUI probably won't work for you to configure things. You can run ConfigGUI on your local machine and upload edited config.xml and worlds.xml files. Alternatively, edit <code>config.xml</code> manually with your favorite text editor. Detailed information about config.xml keys can be found [[List of config keys|here]].

=[[Troubleshooting]]=
==Autentication/Decription failed for heartbeats==
This recently surfaced when mollstam introduced https for minecraft.net, causing some trust issues with fCraft's heartbeats, especially under mono, since mono trusts no certificates by default. To fix this one must import certificates, with <CODE>mozroots --import --ask-remove</CODE> Mozillas certificates are imported into mono. This must be done on the user-account that will run the server, importing it as root does not apply it system-wide. (it can be made system wide with <CODE>--machine</CODE> but this is not the default for a reason.)

Installation instructions

2012-10-01T17:37:31Z

Hellenion: /* Autentication/Decription failed for heartbeats */ improved rationale

=Windows=
# fCraft requires Microsoft .NET Framework 3.5. Your system may already have it installed, and you can [http://www.microsoft.com/download/en/details.aspx?id=22 download it from microsoft.com].
# Download a current copy of fCraft here: {{LatestVersion}}
# Extract the zip file into the directory where you wish to keep all the server data (maps, logs, config, etc).
# Run <code>ConfigGUI.exe</code> before starting the server and carefully configure the options. Your configuration will be stored in ''config.xml''. You world list will be stored in ''worlds.xml''.
# After configuring the server, you can run either <code>ServerGUI.exe</code> (GUI version) OR <code>ServerCLI.exe</code> (command-line version) to start the server. Do not run both at the same time.

=Linux, Unix, MacOS X (Mono)=
{{notice|fCraft has only been officially tested on
*Ubuntu 10
*Debian 6
*MacOS X 10.6
If you are using a different distribution, use at your own risk.}}
# Download a current copy of fCraft here: {{LatestVersion}}. Use ''gunzip'' to extract it.
# fCraft requires Mono 2.6.4 (minimum) or Mono 2.10+ (recommended) runtime. You can [http://www.go-mono.com/mono-downloads/download.html download from www.mono-project.org], or (on some Linux distributions) install it through your package manager (like ''yum'' or ''apt-get''). If the latest version of Mono is not available for your platform, you can [[Building Mono|build your own copy of Mono]]. Note that to be able to use graphical fCraft components (ServerGUI and ConfigGUI) you will also need ''libgdiplus'' (GDI+ library).
# Before starting fCraft, make sure that it has read/write permissions in the fCraft directory. I do not recommend running fCraft as root - it is always safer to run servers under their own limited user accounts.
# To run ".exe" files with Mono, use the following syntax:
#: Mono 2.6.4: <code>mono SomeFile.exe</code>
#: Mono 2.8+: <code>mono --gc=sgen SomeFile.exe</code>
# From here on out is roughly the same as on Windows. You can run <code>ConfigGUI.exe</code> to configure your server, and then either <code>ServerGUI.exe</code> OR <code>ServerCLI.exe</code> to start the server.
#: If you want to run console-only on a headless server, the ConfigGUI probably won't work for you to configure things. You can run ConfigGUI on your local machine and upload edited config.xml and worlds.xml files. Alternatively, edit <code>config.xml</code> manually with your favorite text editor. Detailed information about config.xml keys can be found [[List of config keys|here]].

=[[Troubleshooting]]=
==Autentication/Decription failed for heartbeats==
This recently surfaced when mollstam introduced https for minecraft.net, causing some trust issues with fCraft's heartbeats, especially under mono, since mono trusts no certificates by default. To fix this one must import certificates, with <CODE>mozroots --import --ask-remove</CODE> Mozillas certificates are imported into mono. This must be done on the user-account that will run the server, importing it as root does not apply it system-wide. (it can be made system wide with <CODE>--machine</CODE> but this is not the default for a reason.)

Private Messages

2012-09-26T16:14:59Z

Hellenion: All there is to know about PMs

Private messages are chat sent to only specific players, and is not made public. Private messages <i>do</i> show up in the log and can be intercepted with {{cmd|Spectate}}. Unlike commands, private messages do not start with a <CODE>/</CODE>, instead they are solemnly defined by the <CODE>@</CODE> sign. Sending private messages requires {{rperm|chat}} permission.

==<CODE>@PlayerName Message</CODE>==
:<CODE>@PlayerName</CODE> sends a message to just that single player. The player will receive a [[List_of_config_keys#Chat|special coloured message]] with the specified <CODE>Message</CODE> and the name of the person who sent it.
:Spelling out the name of a person each message can get tedious in long private conversations, for this, <CODE>@-</CODE> can be used. the <CODE>-</CODE>(Hyphen/Minus) is automatically substituted by the last PlayerName used by you.
:Sending a message to a hidden player will print an error about that player not being online. While this message is displayed, the hidden player <i>does</i> receive the message. This has been made so for hidden players to be undetectable.

==<CODE>@@RankName Message</CODE>==
:<CODE>@@RankName</CODE> sends a message to all the players online with that particular rank. The same [[List_of_config_keys#Chat|colour]] is used for rank-wide messages as for private messages. It is shown to which rank the message was sent and who sent it, being easily distinguishable from private messages so no confusion may occur.
:One can easily chat with ones own rank by just using <CODE>@@ Message</CODE>, without the RankName, but with a space between the <CODE>@@</CODE> and the <CODE>Message</CODE>. <CODE>@@-</CODE> to specify the last-used RankName will not work, this notation can never be used for RankNames anywhere, only WorldNames and PlayerNames honour this notation.
:Messages like this can be sent to ranks of which <i>no</i> players are online, no error will be reported.

==<CODE>/Staff</CODE>==
:For Staff-chat, see {{cmd|Staff}}.

Installation instructions

2012-09-25T22:54:39Z

Hellenion: /* Troubleshooting */ Added a piece aboot the Auth errors that surfaced recently.

=Windows=
# fCraft requires Microsoft .NET Framework 3.5. Your system may already have it installed, and you can [http://www.microsoft.com/download/en/details.aspx?id=22 download it from microsoft.com].
# Download a current copy of fCraft here: {{LatestVersion}}
# Extract the zip file into the directory where you wish to keep all the server data (maps, logs, config, etc).
# Run <code>ConfigGUI.exe</code> before starting the server and carefully configure the options. Your configuration will be stored in ''config.xml''. You world list will be stored in ''worlds.xml''.
# After configuring the server, you can run either <code>ServerGUI.exe</code> (GUI version) OR <code>ServerCLI.exe</code> (command-line version) to start the server. Do not run both at the same time.

=Linux, Unix, MacOS X (Mono)=
{{notice|fCraft has only been officially tested on
*Ubuntu 10
*Debian 6
*MacOS X 10.6
If you are using a different distribution, use at your own risk.}}
# Download a current copy of fCraft here: {{LatestVersion}}. Use ''gunzip'' to extract it.
# fCraft requires Mono 2.6.4 (minimum) or Mono 2.10+ (recommended) runtime. You can [http://www.go-mono.com/mono-downloads/download.html download from www.mono-project.org], or (on some Linux distributions) install it through your package manager (like ''yum'' or ''apt-get''). If the latest version of Mono is not available for your platform, you can [[Building Mono|build your own copy of Mono]]. Note that to be able to use graphical fCraft components (ServerGUI and ConfigGUI) you will also need ''libgdiplus'' (GDI+ library).
# Before starting fCraft, make sure that it has read/write permissions in the fCraft directory. I do not recommend running fCraft as root - it is always safer to run servers under their own limited user accounts.
# To run ".exe" files with Mono, use the following syntax:
#: Mono 2.6.4: <code>mono SomeFile.exe</code>
#: Mono 2.8+: <code>mono --gc=sgen SomeFile.exe</code>
# From here on out is roughly the same as on Windows. You can run <code>ConfigGUI.exe</code> to configure your server, and then either <code>ServerGUI.exe</code> OR <code>ServerCLI.exe</code> to start the server.
#: If you want to run console-only on a headless server, the ConfigGUI probably won't work for you to configure things. You can run ConfigGUI on your local machine and upload edited config.xml and worlds.xml files. Alternatively, edit <code>config.xml</code> manually with your favorite text editor. Detailed information about config.xml keys can be found [[List of config keys|here]].

=[[Troubleshooting]]=
==Autentication/Decription failed for heartbeats==
This recently surfaced when mollstam moved www.minecraft.net in favour of minecraft.net, causing some trust issues with fCraft's heartbeats. To fix this one must import the latest certificates with <CODE>mozroots --import --ask-remove</CODE>. This must be done on the user-account that will run the server, importing it as root does not apply it system-wide. (it can be made system wide with <CODE>--machine</CODE> but this is not the default for a reason.

/Rules

2012-09-24T15:32:59Z

Hellenion: /* Blank lines */ indented

{{CommandBox
|name=Rules
|purpose=Display the server rules.
|aliases=
|uses=/Rules

/Rules <Section>
|cat=Info
|perm=
|console=Yes
|v=0.316
|}}
==<code>/Rules</code>==
:Prints contents of ''rules.txt'' file. If no such file exists, prints a placeholder message ("Rules: Use common sense!"). This message can be changed by editing ''rules.txt'', or by using ConfigGUI (General tab -> Edit Rules). You may use any [[/Colors|color codes]] or [[Constants|string constants]] in ''rules.txt''.

==<code>/Rules <Section></code>==
:Additional rule sections may be specified by creating a "rules" directory, and placing text files into it. For instance, {{cmd|rules|blah}} will read from ''rules/blah.txt'' file. Colors and constants may also be used in these section files.

==Blank lines==
:Empty lines in <code>rules.txt</code> are ignored, but may be desireable. To print an empty line, simply put <code>&R</code> in it, which is the default color. This way the line won't be ignored by the parser, and the linewrapper doesn't need to print any additional characters.

{{LastUpdated|1201}}

/Rules

2012-09-24T15:31:36Z

Hellenion: Added something about rule formatting.

{{CommandBox
|name=Rules
|purpose=Display the server rules.
|aliases=
|uses=/Rules

/Rules <Section>
|cat=Info
|perm=
|console=Yes
|v=0.316
|}}
==<code>/Rules</code>==
:Prints contents of ''rules.txt'' file. If no such file exists, prints a placeholder message ("Rules: Use common sense!"). This message can be changed by editing ''rules.txt'', or by using ConfigGUI (General tab -> Edit Rules). You may use any [[/Colors|color codes]] or [[Constants|string constants]] in ''rules.txt''.

==<code>/Rules <Section></code>==
:Additional rule sections may be specified by creating a "rules" directory, and placing text files into it. For instance, {{cmd|rules|blah}} will read from ''rules/blah.txt'' file. Colors and constants may also be used in these section files.

==Blank lines==
Empty lines in <code>rules.txt</code> are ignored, but may be desireable. To print an empty line, simply put <code>&R</code> in it, which is the default color. This way the line won't be ignored by the parser, and the linewrapper doesn't print any additional characters.

{{LastUpdated|1201}}

Blocks

2012-09-01T14:54:43Z

Hellenion: /* Grass, Admincrete, Water, and Lava */ forgot {{cmd|Water}}

<div style="float:right;margin-left:5px">
{| class=wikitable
!
!Block
!ID
!Aliases
|-
|
|None
|255
|
* skip
|-
|
|Air
|0
|
*a
*nothing
*empty
*delete
*erase
*blank
|-
|[[File:Block-Stone.png|25px]]
|Stone
|1
|
*cement
*concrete
|-
|[[File:Block-Grass.png|25px]]
|Grass
|2
|
*g
*gras
|-
|[[File:Block-Dirt.png|25px]]
|Dirt
|3
|
*soil
|-
|[[File:Block-Cobblestone.png|25px]]
|Cobblestone
|4
|
*cobble
*stones
*rocks
|-
|[[File:Block-Wood.png|25px]]
|Wood
|5
|
*plank
*planks
*board
*boards
|-
|[[File:Block-Sapling.png|25px]]
|Sapling
|6
|
*tree
*plant
|-
|[[File:Block-Admincrete.png|25px]]
|Admincrete
|7
|
*adminium
*adminite
*opcrete
*hardrock
*solid
*bedrock
|-
|[[File:Block-Water.png|25px]]
|Water
|8
|
*w
|-
|[[File:Block-Water.png|25px]]
|Stillwater
|9
|
|-
|[[File:Block-Lava.png|25px]]
|Lava
|10
|
*l
*magma
|-
|[[File:Block-Lava.png|25px]]
|StillLava
|11
|
|-
|[[File:Block-Sand.png|25px]]
|Sand
|12
|
|-
|[[File:Block-Gravel.png|25px]]
|Gravel
|13
|
|-
|[[File:Block-GoldOre.png|25px]]
|GoldOre
|14
|
*gold_ore
|-
|[[File:Block-IronOre.png|25px]]
|IronOre
|15
|
*iron_ore
*copperore
*copper_ore
*ore
|-
|[[File:Block-Coal.png|25px]]
|Coal
|16
|
*coals
*coalore
*blackore
|-
|[[File:Block-Log.png|25px]]
|Log
|17
|
*trunk
*stump
*treestump
*treetrunk
|-
|[[File:Block-Leaves.png|25px]]
|Leaves
|18
|
*leaf
*foliage
|-
|[[File:Block-Sponge.png|25px]]
|Sponge
|19
|
*cheese
|-
|[[File:Block-Glass.png|25px]]
|Glass
|20
|
|-
|[[File:Block-Red.png|25px]]
|Red
|21
|
*redcloth
*redwool
|-
|[[File:Block-Orange.png|25px]]
|Orange
|22
|
*orangecloth
*orangewool
|-
|[[File:Block-Yellow.png|25px]]
|Yellow
|23
|
*yellowcloth
*yellowwool
|-
|[[File:Block-Lime.png|25px]]
|Lime
|24
|
*limecloth
*limewool
*greenyellow
*yellowgreen
*lightgreen
*lightgreencloth
*lightgreenwool
|-
|[[File:Block-Green.png|25px]]
|Green
|25
|
*greencloth
*greenwool
|-
|[[File:Block-Teal.png|25px]]
|Teal
|26
|
*springgreen
*emerald
*tealwool
*tealcloth
|-
|[[File:Block-Aqua.png|25px]]
|Aqua
|27
|
*aquawool
*aquacloth
|-
|[[File:Block-Cyan.png|25px]]
|Cyan
|28
|
*cyanwool
*cyancloth
|-
|[[File:Block-Blue.png|25px]]
|Blue
|29
|
*lightblue
*bluewool
*bluecloth
|-
|[[File:Block-Indigo.png|25px]]
|Indigo
|30
|
*indigowool
*indigocloth
|-
|[[File:Block-Violet.png|25px]]
|Violet
|31
|
*violetwool
*violetcloth
*lightpurple
*purple
*purplewool
*purplecloth
|-
|[[File:Block-Magenta.png|25px]]
|Magenta
|32
|
*fuchsia
*magentawool
*magentacloth
|-
|[[File:Block-Pink.png|25px]]
|Pink
|33
|
*darkpink
*pinkwool
*pinkcloth
|-
|[[File:Block-Black.png|25px]]
|Black
|34
|
*darkgray
*darkgrey
|-
|[[File:Block-Gray.png|25px]]
|Gray
|35
|
*grey
*lightgray
*lightgrey
|-
|[[File:Block-White.png|25px]]
|White
|36
|
*cloth
*cotton
|-
|[[File:Block-YellowFlower.png|25px]]
|YellowFlower
|37
|
*yellow_flower
*flower
*dandelion
|-
|[[File:Block-RedFlower.png|25px]]
|RedFlower
|38
|
*rose
*redrose
*red_flower
|-
|[[File:Block-BrownMushroom.png|25px]]
|BrownMushroom
|39
|
*mushroom
*shroom
*brown_shroom
|-
|[[File:Block-RedMushroom.png|25px]]
|RedMushroom
|40
|
*red_shroom
|-
|[[File:Block-Gold.png|25px]]
|Gold
|41
|
*goldblock
*goldsolid
*golden
*copper
*brass
|-
|[[File:Block-Iron.png|25px]]
|Iron
|42
|
*ironblock
*steel
*metal
*silver
|-
|[[File:Block-DoubleSlab.png|25px]]
|DoubleSlab
|43
|
*stairs
*steps
*slabs
*doublestep
*doublestair
*double_step
*double_stair
*double_slab
*staircasefull
|-
|[[File:Block-Slab.png|25px]]
|Slab
|44
|
*step
*stair
*halfstep
*halfblock
*staircasestep
|-
|[[File:Block-Bricks.png|25px]]
|Bricks
|45
|
*brick
|-
|[[File:Block-TNT.png|25px]]
|TNT
|46
|
*explosive
*dynamite
|-
|[[File:Block-Books.png|25px]]
|Books
|47
|
*book
*shelf
*shelves
*bookcase
*bookshelf
*bookshelves
|-
|[[File:Block-MossyCobble.png|25px]]
|MossyCobble
|48
|
*moss
*mossy
*stonevine
*mossyrock
*mossyrocks
*mossystone
*mossystones
*greencobblestone
*mossycobblestone
*mossy_cobblestone
|-
|[[File:Block-Obsidian.png|25px]]
|Obsidian
|49
|
*onyx
|}
</div>

==Physics==
:fCraft does not have physics, as a result:
:*Grass does not spread to lit dirt
:*Grass does not die in shade
:*Plants do not grow into trees
:*Water and lava do not flood
:*Leaves do not die
:*Sponges do not soak up nearby water
:*Flowers and Mushrooms do not die
:*TNT does not explode

==Special blocks==
===None===
::The "none" block may be used in more complex drawing commands to denote those blocks should '''not''' be altered.

===Grass, Admincrete, Water, and Lava===
::These blocks can only be placed through {{cmd|Bind}}ing, or through the commands {{cmd|Grass}}, {{cmd|Solid}}, {{cmd|Water}} and {{cmd|Lava}} .

===Admincrete===
::Admincrete cannot be broken without {{perm|DeleteAdmincrete}} as the client prevents you from clicking it. Note that hacking clients may circumvent this restriction and pass through admincrete walls anyway.

===StillWater and StillLava===
::These blocks behave identically to their normal counterparts, but are saved differently.

===Slab/DoubleSlab===
::If one stair is placed above another, the bottom one will be changed into a doublestair. This can be prevented by placing the top one first or using a drawing command.

Blocks

2012-09-01T07:01:51Z

Hellenion: Added a row for images, section about physics and a section about special blocks

{| class=wikitable
!
!Block
!ID
!aliases
|-
|
|Undefined
|255
|
* none
|-
|
|Air
|0
|
*a
*nothing
*empty
*delete
*erase
*blank
|-
|
|Stone
|1
|
*cement
*concrete
|-
|
|Grass
|2
|
*g
*gras
|-
|
|Dirt
|3
|
*soil
|-
|
|Cobblestone
|4
|
*stones
*rocks
|-
|
|Wood
|5
|
*plank
*planks
*board
*boards
|-
|
|Plant
|6
|
*tree
*sappling
|-
|
|Admincrete
|7
|
*adminium
*adminite
*opcrete
*hardrock
*solid
*bedrock
|-
|
|Water
|8
|
*w
|-
|
|Stillwater
|9
|
|-
|
|Lava
|10
|
*l
*magma
|-
|
|StillLava
|11
|
|-
|
|Sand
|12
|
|-
|
|Gravel
|13
|
|-
|
|GoldOre
|14
|
*gold_ore
|-
|
|IronOre
|15
|
*iron_ore
*copper
*copperore
*copper_ore
*ore
|-
|
|Coal
|16
|
*coals
*coalore
*blackore
|-
|
|Log
|17
|
*trunk
*stump
*treestump
*treetrunk
|-
|
|Leaves
|18
|
*leaf
*foliage
|-
|
|Sponge
|19
|
*cheese
|-
|
|Glass
|20
|
|-
|
|Red
|21
|
*redcloth
*redwool
|-
|
|Orange
|22
|
*orangecloth
*orangewool
|-
|
|Yellow
|23
|
*yellowcloth
*yellowwool
|-
|
|Lime
|24
|
*limecloth
*limewool
*greenyellow
*yellowgreen
*lightgreen
*lightgreencloth
*lightgreenwool
|-
|
|Green
|25
|
*greencloth
*greenwool
|-
|
|Teal
|26
|
*springgreen
*emerald
*tealwool
*tealcloth
|-
|
|Aqua
|27
|
*aquawool
*aquacloth
|-
|
|Cyan
|28
|
*cyanwool
*cyancloth
|-
|
|Blue
|29
|
*bluewool
*bluecloth
|-
|
|Indigo
|30
|
*indigowool
*indigocloth
|-
|
|Violet
|31
|
*violetwool
*violetcloth
*lightpurple
*purple
*purplewool
*purplecloth
|-
|
|Magenta
|32
|
*fuchsia
*magentawool
*magentacloth
|-
|
|Pink
|33
|
*darkpink
*pinkwool
*pinkcloth
|-
|
|Black
|34
|
*darkgray
*darkgrey
|-
|
|Gray
|35
|
*grey
*lightgray
*lightgrey
|-
|
|White
|36
|
*cloth
*cotton
|-
|
|YellowFlower
|37
|
*yellow_flower
*flower
|-
|
|RedFlower
|38
|
*rose
*redrose
*red_flower
|-
|
|BrownMushroom
|39
|
*mushroom
*shroom
*brown_shroom
|-
|
|RedMushroom
|40
|
*red_shroom
|-
|
|Gold
|41
|
*goldblock
*goldsolid
*golden
*copper
*brass
|-
|
|Iron
|42
|
*ironblock
*steel
*metal
*silver
|-
|
|DoubleStair
|43
|
*slabs
*steps
*stairs
*doublestep
*double_step
*double_stair
*staircasefull
|-
|
|Stair
|44
|
*slab
*step
*halfstep
*halfblock
*staircasestep
|-
|
|Brick
|45
|
*bricks
|-
|
|TNT
|46
|
*explosive
*dynamite
|-
|
|Books
|47
|
*book
*shelf
*shelves
*bookcase
*bookshelf
*bookshelves
|-
|
|MossyRocks
|48
|
*moss
*mossy
*stonevine
*mossyrock
*mossystone
*mossystones
*greencobblestone
*mossycobblestone
*mossy_cobblestone
*blockthathasgreypixelsonitmostlybutsomeareactuallygreen
|-
|
|Obsidian
|49
|
|}
==Physics==
:fCraft does not have physics, as a result:
:*Grass does not spread to lit dirt
:*Grass does not die in shade
:*Plants do not grow into trees
:*Water and lava do not flood
:*Leaves do not die
:*Sponges do not soak up nearby water
:*Flowers and Mushrooms do not die
:*TNT does not explode
==Special blocks==
===Undefined===
::The undefined block may be used in more complex drawing commands to denote those blocks must '''not''' be altered.
===Grass, Admincrete, Water and Lava===
::These blocks can only be placed through {{cmd|Bind}}ing or the commands {{cmd|Grass}}, {{cmd|Solid}} and {{cmd|Lava}} .
===Admincrete===
::Admincrete cannot be broken without {{perm|DeleteAdmincrete}} as the client prevents you from clicking it. Note that hacking clients may circumvent this restriction and pass through admincrete walls anyway.
===StillWater and StillLava===
::These blocks behave identically to their normal counterparts, but are saved differently.
===Stair/DoubleStair===
::If one stair is placed above another, the bottom one will be changed into a doublestair. This can be prevented by placing the top one first or using a drawing command.
===MossyRocks===
::One alias of mossyPocks is too long to be used in-game, as the normal client only accepts 64 characters. It could, however, be used from console if there was a way for console to use it.

Blocks

2012-09-01T06:15:48Z

Hellenion:

{| class=wikitable
!Block
!ID
!aliases
|-
|Undefined
|255
|
* none
|-
|Air
|0
|
*a
*nothing
*empty
*delete
*erase
*blank
|-
|Stone
|1
|
*cement
*concrete
|-
|Grass
|2
|
*g
*gras
|-
|Dirt
|3
|
*soil
|-
|Cobblestone
|4
|
*stones
*rocks
|-
|Wood
|5
|
*plank
*planks
*board
*boards
|-
|Plant
|6
|
*tree
*sappling
|-
|Admincrete
|7
|
*adminium
*adminite
*opcrete
*hardrock
*solid
*bedrock
|-
|Water
|8
|
*w
|-
|Stillwater
|9
|
|-
|Lava
|10
|
*l
*magma
|-
|StillLava
|11
|
|-
|Sand
|12
|
|-
|Gravel
|13
|
|-
|GoldOre
|14
|
*gold_ore
|-
|IronOre
|15
|
*iron_ore
*copper
*copperore
*copper_ore
*ore
|-
|Coal
|16
|
*coals
*coalore
*blackore
|-
|Log
|17
|
*trunk
*stump
*treestump
*treetrunk
|-
|Leaves
|18
|
*leaf
*foliage
|-
|Sponge
|19
|
*cheese
|-
|Glass
|20
|
|-
|Red
|21
|
*redcloth
*redwool
|-
|Orange
|22
|
*orangecloth
*orangewool
|-
|Yellow
|23
|
*yellowcloth
*yellowwool
|-
|Lime
|24
|
*limecloth
*limewool
*greenyellow
*yellowgreen
*lightgreen
*lightgreencloth
*lightgreenwool
|-
|Green
|25
|
*greencloth
*greenwool
|-
|Teal
|26
|
*springgreen
*emerald
*tealwool
*tealcloth
|-
|Aqua
|27
|
*aquawool
*aquacloth
|-
|Cyan
|28
|
*cyanwool
*cyancloth
|-
|Blue
|29
|
*bluewool
*bluecloth
|-
|Indigo
|30
|
*indigowool
*indigocloth
|-
|Violet
|31
|
*violetwool
*violetcloth
*lightpurple
*purple
*purplewool
*purplecloth
|-
|Magenta
|32
|
*fuchsia
*magentawool
*magentacloth
|-
|Pink
|33
|
*darkpink
*pinkwool
*pinkcloth
|-
|Black
|34
|
*darkgray
*darkgrey
|-
|Gray
|35
|
*grey
*lightgray
*lightgrey
|-
|White
|36
|
*cloth
*cotton
|-
|YellowFlower
|37
|
*yellow_flower
*flower
|-
|RedFlower
|38
|
*rose
*redrose
*red_flower
|-
|BrownMushroom
|39
|
*mushroom
*shroom
*brown_shroom
|-
|RedMushroom
|40
|
*red_shroom
|-
|Gold
|41
|
*goldblock
*goldsolid
*golden
*copper
*brass
|-
|Iron
|42
|
*ironblock
*steel
*metal
*silver
|-
|DoubleStair
|43
|
*slabs
*steps
*stairs
*doublestep
*double_step
*double_stair
*staircasefull
|-
|Stair
|44
|
*slab
*step
*halfstep
*halfblock
*staircasestep
|-
|Brick
|45
|
*bricks
|-
|TNT
|46
|
*explosive
*dynamite
|-
|Books
|47
|
*book
*shelf
*shelves
*bookcase
*bookshelf
*bookshelves
|-
|MossyRocks
|48
|
*moss
*mossy
*stonevine
*mossyrock
*mossystone
*mossystones
*greencobblestone
*mossycobblestone
*mossy_cobblestone
*blockthathasgreypixelsonitmostlybutsomeareactuallygreen
|-
|Obsidian
|49
|
|}

Blocks

2012-08-31T16:33:20Z

Hellenion: =WIP= List of all blocks and their aliases.

{| class=wikitable
!Block
!ID
!aliases
|-
|Undefined
|255
|
* none
|-
|Air
|0
|
BlockNames["a"] = Block.Air; // common typo
BlockNames["nothing"] = Block.Air;
BlockNames["empty"] = Block.Air;
BlockNames["delete"] = Block.Air;
BlockNames["erase"] = Block.Air;
BlockNames["blank"] = Block.Air;

|-
|Stone
|1
|
BlockNames["cement"] = Block.Stone;
BlockNames["concrete"] = Block.Stone;

|-
|Grass
|2
|
BlockNames["g"] = Block.Grass;
BlockNames["gras"] = Block.Grass; // common typo

|-
|Dirt
|3
|
|-
|Cobblestone
|4
|
|-
|Wood
|5
|
|-
|Plant
|6
|
|-
|Admincrete
|7
|
|-
|Water
|8
|
|-
|Stillwater
|9
|
|-
|Lava
|10
|
|-
|StillLava
|11
|
|-
|Sand
|12
|
|-
|Gravel
|13
|
|-
|GoldOre
|14
|
|-
|IronOre
|15
|
|-
|Coal
|16
|
|-
|Log
|17
|
|-
|Leaves
|18
|
|-
|Sponge
|19
|
|-
|Glass
|20
|
|-
|Red
|21
|
|-
|Orange
|22
|
|-
|Yellow
|23
|
|-
|Lime
|24
|
|-
|Green
|25
|
|-
|Teal
|26
|
|-
|Aqua
|27
|
|-
|Cyan
|28
|
|-
|Blue
|29
|
|-
|Indigo
|30
|
|-
|Violet
|31
|
|-
|Magenta
|32
|
|-
|Pink
|33
|
|-
|Black
|34
|
|-
|Gray
|35
|
|-
|White
|36
|
|-
|YellowFlower
|37
|
|-
|RedFlower
|38
|
|-
|BrownMushroom
|39
|
|-
|RedMushroom
|40
|
|-
|Gold
|41
|
|-
|Iron
|42
|
|-
|DoubleStair
|43
|
|-
|Stair
|44
|
|-
|Brick
|45
|
|-
|TNT
|46
|
|-
|Books
|47
|
|-
|MossyRocks
|48
|
|-
|Obsidian
|49
|
|}

BlockNames["soil"] = Block.Dirt;
BlockNames["stones"] = Block.Cobblestone;
BlockNames["rocks"] = Block.Cobblestone;
BlockNames["plank"] = Block.Wood;
BlockNames["planks"] = Block.Wood;
BlockNames["board"] = Block.Wood;
BlockNames["boards"] = Block.Wood;
BlockNames["tree"] = Block.Plant;
BlockNames["sappling"] = Block.Plant;
BlockNames["adminium"] = Block.Admincrete;
BlockNames["adminite"] = Block.Admincrete;
BlockNames["opcrete"] = Block.Admincrete;
BlockNames["hardrock"] = Block.Admincrete;
BlockNames["solid"] = Block.Admincrete;
BlockNames["bedrock"] = Block.Admincrete;
BlockNames["w"] = Block.Water;
BlockNames["l"] = Block.Lava;
BlockNames["magma"] = Block.Lava;
BlockNames["gold_ore"] = Block.GoldOre;
BlockNames["iron_ore"] = Block.IronOre;
BlockNames["copper"] = Block.IronOre;
BlockNames["copperore"] = Block.IronOre;
BlockNames["copper_ore"] = Block.IronOre;
BlockNames["ore"] = Block.IronOre;
BlockNames["coals"] = Block.Coal;
BlockNames["coalore"] = Block.Coal;
BlockNames["blackore"] = Block.Coal;

BlockNames["trunk"] = Block.Log;
BlockNames["stump"] = Block.Log;
BlockNames["treestump"] = Block.Log;
BlockNames["treetrunk"] = Block.Log;

BlockNames["leaf"] = Block.Leaves;
BlockNames["foliage"] = Block.Leaves;

BlockNames["cheese"] = Block.Sponge;

BlockNames["redcloth"] = Block.Red;
BlockNames["redwool"] = Block.Red;
BlockNames["orangecloth"] = Block.Orange;
BlockNames["orangewool"] = Block.Orange;
BlockNames["yellowcloth"] = Block.Yellow;
BlockNames["yellowwool"] = Block.Yellow;
BlockNames["limecloth"] = Block.Lime;
BlockNames["limewool"] = Block.Lime;
BlockNames["greenyellow"] = Block.Lime;
BlockNames["yellowgreen"] = Block.Lime;
BlockNames["lightgreen"] = Block.Lime;
BlockNames["lightgreencloth"] = Block.Lime;
BlockNames["lightgreenwool"] = Block.Lime;
BlockNames["greencloth"] = Block.Green;
BlockNames["greenwool"] = Block.Green;
BlockNames["springgreen"] = Block.Teal;
BlockNames["emerald"] = Block.Teal;
BlockNames["tealwool"] = Block.Teal;
BlockNames["tealcloth"] = Block.Teal;
BlockNames["aquawool"] = Block.Aqua;
BlockNames["aquacloth"] = Block.Aqua;
BlockNames["cyanwool"] = Block.Cyan;
BlockNames["cyancloth"] = Block.Cyan;
BlockNames["bluewool"] = Block.Blue;
BlockNames["bluecloth"] = Block.Blue;
BlockNames["indigowool"] = Block.Indigo;
BlockNames["indigocloth"] = Block.Indigo;
BlockNames["violetwool"] = Block.Violet;
BlockNames["violetcloth"] = Block.Violet;
BlockNames["lightpurple"] = Block.Violet;
BlockNames["purple"] = Block.Violet;
BlockNames["purplewool"] = Block.Violet;
BlockNames["purplecloth"] = Block.Violet;
BlockNames["fuchsia"] = Block.Magenta;
BlockNames["magentawool"] = Block.Magenta;
BlockNames["magentacloth"] = Block.Magenta;
BlockNames["darkpink"] = Block.Pink;
BlockNames["pinkwool"] = Block.Pink;
BlockNames["pinkcloth"] = Block.Pink;
BlockNames["cloth"] = Block.White;
BlockNames["cotton"] = Block.White;
BlockNames["grey"] = Block.Gray;
BlockNames["lightgray"] = Block.Gray;
BlockNames["lightgrey"] = Block.Gray;
BlockNames["darkgray"] = Block.Black;
BlockNames["darkgrey"] = Block.Black;

BlockNames["yellow_flower"] = Block.YellowFlower;
BlockNames["flower"] = Block.YellowFlower;
BlockNames["rose"] = Block.RedFlower;
BlockNames["redrose"] = Block.RedFlower;
BlockNames["red_flower"] = Block.RedFlower;

BlockNames["mushroom"] = Block.BrownMushroom;
BlockNames["shroom"] = Block.BrownMushroom;
BlockNames["brown_shroom"] = Block.BrownMushroom;
BlockNames["red_shroom"] = Block.RedMushroom;

BlockNames["goldblock"] = Block.Gold;
BlockNames["goldsolid"] = Block.Gold;
BlockNames["golden"] = Block.Gold;
BlockNames["copper"] = Block.Gold;
BlockNames["brass"] = Block.Gold;

BlockNames["ironblock"] = Block.Iron;
BlockNames["steel"] = Block.Iron;
BlockNames["metal"] = Block.Iron;
BlockNames["silver"] = Block.Iron;

BlockNames["slab"] = Block.Stair;
BlockNames["slabs"] = Block.DoubleStair;
BlockNames["steps"] = Block.DoubleStair;
BlockNames["stairs"] = Block.DoubleStair;
BlockNames["doublestep"] = Block.DoubleStair;
BlockNames["double_step"] = Block.DoubleStair;
BlockNames["double_stair"] = Block.DoubleStair;
BlockNames["staircasefull"] = Block.DoubleStair;
BlockNames["step"] = Block.Stair;
BlockNames["halfstep"] = Block.Stair;
BlockNames["halfblock"] = Block.Stair;
BlockNames["staircasestep"] = Block.Stair;

BlockNames["bricks"] = Block.Brick;
BlockNames["explosive"] = Block.TNT;
BlockNames["dynamite"] = Block.TNT;

BlockNames["book"] = Block.Books;
BlockNames["shelf"] = Block.Books;
BlockNames["shelves"] = Block.Books;
BlockNames["bookcase"] = Block.Books;
BlockNames["bookshelf"] = Block.Books;
BlockNames["bookshelves"] = Block.Books;

BlockNames["moss"] = Block.MossyRocks;
BlockNames["mossy"] = Block.MossyRocks;
BlockNames["stonevine"] = Block.MossyRocks;
BlockNames["mossyrock"] = Block.MossyRocks;
BlockNames["mossystone"] = Block.MossyRocks;
BlockNames["mossystones"] = Block.MossyRocks;
BlockNames["greencobblestone"] = Block.MossyRocks;
BlockNames["mossycobblestone"] = Block.MossyRocks;
BlockNames["mossy_cobblestone"] = Block.MossyRocks;
BlockNames["blockthathasgreypixelsonitmostlybutsomeareactuallygreen"] = Block.MossyRocks;

/Undo

2012-08-30T21:33:38Z

Hellenion: typo

{{CommandBox
|name=Undo
|purpose=Reverses last draw command.
|aliases=
|uses=/Undo
|cat=Building
|perm={{rperm|Draw}}
|console=No
|v=0.426
|}}

Reverses last draw command. {{cmd|Undo}} is able to effectively halt and revert a draw operation while it is running. Prior to fCraft 0.600, only the most-recently-used command could be undone. Since then, an option has been added to allow going back several commands.

Use {{cmd|Undo}} again to go back another step. Use {{cmd|Redo}} to go forwards a step.

==Customizing /Undo behavior==
*By default, {{cmd|Undo}} is limited to last '''5''' commands, under '''2,000,000''' blocks each. This can be changed in ConfigGUI (Advanced tab).

{{LastUpdated|1650}}

/Undo

2012-08-30T21:33:03Z

Hellenion: about running operations

{{CommandBox
|name=Undo
|purpose=Reverses last draw command.
|aliases=
|uses=/Undo
|cat=Building
|perm={{rperm|Draw}}
|console=No
|v=0.426
|}}

Reverses last draw command. {{cmd|Undo}} is able to efffectively halt and revert a draw operation while it is running. Prior to fCraft 0.600, only the most-recently-used command could be undone. Since then, an option has been added to allow going back several commands.

Use {{cmd|Undo}} again to go back another step. Use {{cmd|Redo}} to go forwards a step.

==Customizing /Undo behavior==
*By default, {{cmd|Undo}} is limited to last '''5''' commands, under '''2,000,000''' blocks each. This can be changed in ConfigGUI (Advanced tab).

{{LastUpdated|1650}}

Colors

2012-08-30T06:40:41Z

Hellenion: /* List */ Newline

{{CommandBox
|name=Colors
|purpose=Shows a list of colorcodes.
|aliases=/Colours
|uses=/Colors
|cat=Chat
|perm=
|console=Yes
|v=0.520
|}}

Shows a list of Minecraft chat color codes. Although any player can call [[/Colors]] to see this list, only players with {{perm|UseColorCodes}} permission can use them.

[[Image:chat_colors.png|left|frame|/colors output]]
<br style="clear:left" />
==List==
{{ColorBlack}} {{ColorNavy}} {{ColorGreen}} {{ColorTeal}} {{ColorMaroon}} {{ColorPurple}} {{ColorOlive}} {{ColorSilver}}

{{ColorGray}} {{ColorBlue}} {{ColorLime}} {{ColorAqua}} {{ColorRed}} {{ColorMagenta}} {{ColorYellow}} {{ColorWhite}}
===Newline===
In addition to colors, players with {{perm|UseColorCodes}} will be able to use the newline [[Constants|Constant]] <CODE>%N</CODE> to force a line break.

==System Colours==
:The following colour codes can be used in /Rules, announcements, and greeting files, as well as code. It is as of yet impossible to use them in-game.
:These are part of the [[Constants]] but the default values can be edited in the [[List_of_config_keys|configuration]].

:{| class="wikitable"
|-
!Code
!Default
!Description
|-
|<CODE>&S</CODE>
|{{ColorYellow}}
|Color of normal system messages (e.g. command feedback).
|-
|<CODE>&H</CODE>
|{{ColorLime}}
|Color of command usage examples in help.
|-
|<CODE>&Y</CODE>
|{{ColorGreen}}
|Color of messages produced by /Say command.
|-
|<CODE>&R</CODE>
|{{ColorGreen}}
|Color of announcements and rules. Default is dark-green. Note that this default color can be overridden by colorcodes in announcement and rule files.
|-
|<CODE>&P</CODE>
|{{ColorAqua}}
|Color of private and rank-wide messages.
|-
|<CODE>&M</CODE>
|{{ColorPurple}}
|Color of /Me command messages.
|-
|<CODE>&W</CODE>
|{{ColorRed}}
|Color of error and warning messages.
|-
|<CODE>&I</CODE>
|{{ColorPurple}}
|Color of IRC messages and event announcements, as seen on the server/in-game.
|}

==More information==
*[http://www.minecraftwiki.net/wiki/Classic_server_protocol#Color_Codes Color Codes] on the Minecraft wiki

{{LastUpdated|1201}}

/WLock

2012-08-29T13:55:34Z

Hellenion: Some information about halting draw operations.

{{CommandBox
|name=WLock
|purpose=Locks a world.
|aliases=Lock
|uses=/WLock

/WLock WorldName

/WLock *
|cat=World
|perm={{rperm|Lock}}
|console=Yes
|v=0.200
|}}
This command "locks" worlds - puts them into a locked, read-only mode. No one can place or delete blocks during lockdown. Use {{cmd|WUnlock}} to unlock worlds.
Any drawing operartions in progress are halted as well, though anything but the most massive draws often finish before the command can be sent. Often the server has already handled the operation and only needs to update the clients, {{cmd|WLock}} does not halt this updating. For a more reliable way of stopping and reverting updates, see {{cmd|Undo}}.

=={{cmd|WLock}}==
:Locks the world that you are currently on. Not usable from console.

=={{cmd|WLock|WorldName}}==
:Locks a given world. Usable from console.

=={{cmd|WLock|*}}==
:Locks all worlds on the list. Usable from console. A separate command named {{cmd|LockAll}} used to exist for this purpose before fCraft 0.600.

{{LastUpdated|1650}}

/Cancel

2012-08-29T13:29:41Z

Hellenion: changed page to use templates and note about /undo for stopping in-process operations

{{notice|Prior to fCraft 0.630, {{cmd|Nvm}} was only used for canceling messages, and {{cmd|Cancel}} was used only for canceling selections. Now they have been merged.}}
{{CommandBox
|name=Cancel
|purpose=Cancels a message or a selection.
|aliases=Nvm
|uses=/Cancel
|cat=Building
|perm=
|console=No
|v=0.200
|}}

This command does two things, depending on context:
*Cancels a partial message, if you were typing one.
*Cancels a selection, such as one started by {{cmd|Cuboid}}, {{cmd|Cut}}, or {{cmd|ZAdd}}. This is useful in case you mistyped the command or mis-clicked the first block. If you wish to stop a drawing in process, use {{cmd|Undo}} or {{cmd|WLock}} instead.

If you are in the middle of entering a partial message AND making selection at the same time, the message will be cancelled first, and {{cmd|Cancel}} can be used again to cancel the selection.

{{LastUpdated|1650}}

/WSet

2012-08-29T13:21:01Z

Hellenion: constants cannot be used

{{CommandBox
|name=WSet
|purpose=Changes world settings.
|aliases=
|uses=/WSet <WorldName> <Property> <Value>
|cat=World
|perm={{rperm|ManageWorlds}}
|console=Yes
|v=0.620
|}}
Allows changing some of worlds' settings. Allows hiding/unhiding worlds, setting/changing/removing the greeting message, and controlling backup settings. Unlike the greeting, announcements and {{cmd|Rules}} files, [[Constants]] cannot be used.

==<code>/WSet <WorldName> Hidden [True|False]</code>==
:Allows hiding worlds from the {{perm|Worlds}} list. Hidden worlds can still be [[/Join|joined]] normally. Set to <code>true</code> or <code>1</code> to hide, to <code>false</code> or <code>0</code> to unhide (default).
:Prior to fCraft 0.620, this functionality was available through two separate commands: <code>/WHide</code> and <code>/WUnhide</code>.

==<code>/WSet <WorldName> Greeting <Text></code>==
:Sets a greeting message. Message is shown whenever someone joins the map, and can also be viewed in {{cmd|WInfo}}. If no text is given, the greeting is removed.

==<code>/WSet <WorldName> Backups Default</code>==
:Sets the world to use default backup settings. [[List_of_config_keys#Saving_and_Backup|DefaultBackupInterval]] config key provides the defaults.

==<code>/WSet <WorldName> Backups Off</code>==
:Turns backups off on the given world, regardless of default settings.

==<code>/WSet <WorldName> Backups <Time></code>==
:Specifies a backup interval. Times should be given in the [[Time formatting|compact format]]. Note that backups are only done whenever the map is saved, so this value is constrained by the [[List_of_config_keys#Saving_and_Backup|SaveInterval]] config key.

{{LastUpdated|1650}}

Constants

2012-08-29T13:17:05Z

Hellenion: cannot be used in world greetings

The following string constants can be used in {{cmd|Rules}}, announcements, and greeting files. The constants cannot be used in-game, not even for world greetings.
==Text==
:*<code>{SERVER_NAME}</code>
:*<code>{MOTD}</code>
:*<code>{RANK}</code> - Player's rank; may include formatting (prefix and color)
:*<code>{PLAYER_NAME}</code> - player's own name; may include formatting (prefix and color), or may be replaced with DisplayedName
:*<code>{PLAYER_LIST}</code> - List of names of all online players that this player can see, including prefixes and colors (if applicable).
:*<code>{PLAYERS}</code> - Number of players online (excludes hidden ones)
:*<code>{WORLD}</code> - Name of the player's current world; may include formatting (prefix and color)
:*<code>{WORLDS}</code> - Total number of worlds (includes hidden/inaccessible ones)
:*<code>{TIME}</code> - Server's local time (depends on the server's timezone)
:*<CODE>{VERSION}</CODE> - fCraft version in use, only prints the version string.

==Colours==
:These colours can be used in code and mods as well, but as of yet not in-game.
:The default values can be edited in the [[List_of_config_keys|configuration]].

:{| class="wikitable"
|-
!Code
!Default
!Description
|-
|<CODE>&S</CODE>
|{{ColorYellow}}
|Color of normal system messages (e.g. command feedback).
|-
|<CODE>&H</CODE>
|{{ColorLime}}
|Color of command usage examples in help.
|-
|<CODE>&Y</CODE>
|{{ColorGreen}}
|Color of messages produced by /Say command.
|-
|<CODE>&R</CODE>
|{{ColorGreen}}
|Color of announcements and rules. Default is dark-green. Note that this default color can be overridden by colorcodes in announcement and rule files.
|-
|<CODE>&P</CODE>
|{{ColorAqua}}
|Color of private and rank-wide messages.
|-
|<CODE>&M</CODE>
|{{ColorPurple}}
|Color of /Me command messages.
|-
|<CODE>&W</CODE>
|{{ColorRed}}
|Color of error and warning messages.
|-
|<CODE>&I</CODE>
|{{ColorPurple}}
|Color of IRC messages and event announcements, as seen on the server/in-game.
|}

Constants

2012-08-28T22:54:30Z

Hellenion: /* Text */ Addded {VERSION} constant and restructured list

The following string constants can be used in {{cmd|Rules}}, announcements, and greeting files.
==Text==
:*<code>{SERVER_NAME}</code>
:*<code>{MOTD}</code>
:*<code>{RANK}</code> - Player's rank; may include formatting (prefix and color)
:*<code>{PLAYER_NAME}</code> - player's own name; may include formatting (prefix and color), or may be replaced with DisplayedName
:*<code>{PLAYER_LIST}</code> - List of names of all online players that this player can see, including prefixes and colors (if applicable).
:*<code>{PLAYERS}</code> - Number of players online (excludes hidden ones)
:*<code>{WORLD}</code> - Name of the player's current world; may include formatting (prefix and color)
:*<code>{WORLDS}</code> - Total number of worlds (includes hidden/inaccessible ones)
:*<code>{TIME}</code> - Server's local time (depends on the server's timezone)
:*<CODE>{VERSION}</CODE> - fCraft version in use, only prints the version string.

==Colours==
:These colours can be used in code and mods as well, but as of yet not in-game.
:The default values can be edited in the [[List_of_config_keys|configuration]].

:{| class="wikitable"
|-
!Code
!Default
!Description
|-
|<CODE>&S</CODE>
|{{ColorYellow}}
|Color of normal system messages (e.g. command feedback).
|-
|<CODE>&H</CODE>
|{{ColorLime}}
|Color of command usage examples in help.
|-
|<CODE>&Y</CODE>
|{{ColorGreen}}
|Color of messages produced by /Say command.
|-
|<CODE>&R</CODE>
|{{ColorGreen}}
|Color of announcements and rules. Default is dark-green. Note that this default color can be overridden by colorcodes in announcement and rule files.
|-
|<CODE>&P</CODE>
|{{ColorAqua}}
|Color of private and rank-wide messages.
|-
|<CODE>&M</CODE>
|{{ColorPurple}}
|Color of /Me command messages.
|-
|<CODE>&W</CODE>
|{{ColorRed}}
|Color of error and warning messages.
|-
|<CODE>&I</CODE>
|{{ColorPurple}}
|Color of IRC messages and event announcements, as seen on the server/in-game.
|}

Constants

2012-08-28T22:36:12Z

Hellenion: Information about the special colour codes used in the code.

The following string constants can be used in {{cmd|Rules}}, announcements, and greeting files.
==Text==
:*<code>{SERVER_NAME}</code>
:*<code>{MOTD}</code>
:*<code>{RANK}</code> - Player's rank; may include formatting (prefix and color)
:*<code>{PLAYER_NAME}</code> - player's own name; may include formatting (prefix and color), or may be replaced with DisplayedName
:*<code>{TIME}</code> - Server's local time (depends on the server's timezone)
:*<code>{WORLD}</code> - Name of the main/starting map; may include formatting (prefix and color)
:*<code>{PLAYERS}</code> - Number of players online (excludes hidden ones)
:*<code>{WORLDS}</code> - Total number of worlds (includes hidden/inaccessible ones)
:*<code>{PLAYER_LIST}</code> - List of names of all online players that this player can see, including prefixes and colors (if applicable).

==Colours==
:These colours can be used in code and mods as well, but as of yet not in-game.
:The default values can be edited in the [[List_of_config_keys|configuration]].

:{| class="wikitable"
|-
!Code
!Default
!Description
|-
|<CODE>&S</CODE>
|{{ColorYellow}}
|Color of normal system messages (e.g. command feedback).
|-
|<CODE>&H</CODE>
|{{ColorLime}}
|Color of command usage examples in help.
|-
|<CODE>&Y</CODE>
|{{ColorGreen}}
|Color of messages produced by /Say command.
|-
|<CODE>&R</CODE>
|{{ColorGreen}}
|Color of announcements and rules. Default is dark-green. Note that this default color can be overridden by colorcodes in announcement and rule files.
|-
|<CODE>&P</CODE>
|{{ColorAqua}}
|Color of private and rank-wide messages.
|-
|<CODE>&M</CODE>
|{{ColorPurple}}
|Color of /Me command messages.
|-
|<CODE>&W</CODE>
|{{ColorRed}}
|Color of error and warning messages.
|-
|<CODE>&I</CODE>
|{{ColorPurple}}
|Color of IRC messages and event announcements, as seen on the server/in-game.
|}

Colors

2012-08-28T22:30:36Z

Hellenion: Added system colour codes

{{CommandBox
|name=Colors
|purpose=Shows a list of colorcodes.
|aliases=/Colours
|uses=/Colors
|cat=Chat
|perm=
|console=Yes
|v=0.520
|}}

Shows a list of Minecraft chat color codes. Although any player can call [[/Colors]] to see this list, only players with {{perm|UseColorCodes}} permission can use them.

[[Image:chat_colors.png|left|frame|/colors output]]
<br style="clear:left" />
==List==
{{ColorBlack}} {{ColorNavy}} {{ColorGreen}} {{ColorTeal}} {{ColorMaroon}} {{ColorPurple}} {{ColorOlive}} {{ColorSilver}}

{{ColorGray}} {{ColorBlue}} {{ColorLime}} {{ColorAqua}} {{ColorRed}} {{ColorMagenta}} {{ColorYellow}} {{ColorWhite}}

==System Colours==
:The following colour codes can be used in /Rules, announcements, and greeting files, as well as code. It is as of yet impossible to use them in-game.
:These are part of the [[Constants]] but the default values can be edited in the [[List_of_config_keys|configuration]].

:{| class="wikitable"
|-
!Code
!Default
!Description
|-
|<CODE>&S</CODE>
|{{ColorYellow}}
|Color of normal system messages (e.g. command feedback).
|-
|<CODE>&H</CODE>
|{{ColorLime}}
|Color of command usage examples in help.
|-
|<CODE>&Y</CODE>
|{{ColorGreen}}
|Color of messages produced by /Say command.
|-
|<CODE>&R</CODE>
|{{ColorGreen}}
|Color of announcements and rules. Default is dark-green. Note that this default color can be overridden by colorcodes in announcement and rule files.
|-
|<CODE>&P</CODE>
|{{ColorAqua}}
|Color of private and rank-wide messages.
|-
|<CODE>&M</CODE>
|{{ColorPurple}}
|Color of /Me command messages.
|-
|<CODE>&W</CODE>
|{{ColorRed}}
|Color of error and warning messages.
|-
|<CODE>&I</CODE>
|{{ColorPurple}}
|Color of IRC messages and event announcements, as seen on the server/in-game.
|}

==More information==
*[http://www.minecraftwiki.net/wiki/Classic_server_protocol#Color_Codes Color Codes] on the Minecraft wiki

{{LastUpdated|1201}}

API: Shutdown

2012-08-26T18:36:16Z

Hellenion: /* Termination */ typo

When an fCraft server is being shut down, the following sequence of events takes place:

#Server.Shutdown
##Cancels any previous shutdown attempt.
##Verifies ShutdownParams
##Announces shutdown and starts the countdown.

After the timer elapses, Server.ShutdownNow (internal) is called on a separate thread:

#Server.ShutdownNow
##''Server.ShutdownBegan''
##Scheduler clears the list of tasks, and prevents future tasks from being added. Current task is allowed to finish.
##Stop listening for connections
##Kick all players, allow 1000ms to deliver the kick packet
##Disconnect IRC
##Save and unload all worlds
##Scheduler waits for current task to finish (if it is still running).
##Save and unload PlayerDB
##Save and unload IPBanList
##''Server.ShutdownEnded''

==Termination==
:ServerGUI does a clean shutdown on <CODE>TERM</CODE>. ServerCLI does not handle it at all.
:<CODE>.NET</CODE> does not provide a low-level way of handling signals/interrupts, but WinForms applications handle it internally, and call the Form.Closing event. Command-line applications just die.

[[Category:Dev]]

API: Shutdown

2012-08-26T18:35:20Z

Hellenion: Section about program termination.

When an fCraft server is being shut down, the following sequence of events takes place:

#Server.Shutdown
##Cancels any previous shutdown attempt.
##Verifies ShutdownParams
##Announces shutdown and starts the countdown.

After the timer elapses, Server.ShutdownNow (internal) is called on a separate thread:

#Server.ShutdownNow
##''Server.ShutdownBegan''
##Scheduler clears the list of tasks, and prevents future tasks from being added. Current task is allowed to finish.
##Stop listening for connections
##Kick all players, allow 1000ms to deliver the kick packet
##Disconnect IRC
##Save and unload all worlds
##Scheduler waits for current task to finish (if it is still running).
##Save and unload PlayerDB
##Save and unload IPBanList
##''Server.ShutdownEnded''

==Termination==
:ServerGUI does a clean shutdown on <CODE>TERM<CODE>. ServerCLI does not handle it at all.
:<CODE>.NET</CODE> does not provide a low-level way of handling signals/interrupts, but WinForms applications handle it internally, and call the Form.Closing event. Command-line applications just die.

[[Category:Dev]]

Architecture

2012-08-26T09:42:11Z

Hellenion: /* Project Directory Structure */ Added a section about removal of the GUI modules.

fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.exe).

=Project Directory Structure=
*'''AutoRankEditor''' - experimental
*'''bin'''
**'''Debug''' - binaries built in Debug, Debug_Events, Debug_IRC, and Debug_Scheduler configurations.
**'''Release''' - binaries built in Release configuration.
*'''ConfigCLI''' - experimental command-line config editor
*'''ConfigGUI''' - graphical config editor
*'''fCraft''' - shared components
**'''AutoRank''' - fCraft.AutoRank namespace; AutoRankManager, conditions, and criteria.
**'''Commands''' - fCraft, fCraft.Events namespaces; Command descriptors and handlers, Command/CommandDescriptor/CommandManager classes, CommandCategory enum.
**'''Drawing''' - fCraft.Drawing, fCraft.Events namespaces; DrawOperation base class and Brush-related interfaces; BrushManager; copy/paste- and undo-related classes; Axis enum.
***'''Brushes''' - fCraft.Drawing namespace; All brush implementations.
***'''DrawOps''' - fCraft.Drawing namespace; All DrawOperation implementations.
**'''MapConversion''' - fCraft.MapConversion namespace; MapUtility, class, MapFormat enum, IMapConverter implementations (importers and exporters), NBT and .INI utilities.
**'''Network''' - fCraft, fCraft.Events namespaces; Heartbeat, IP bans, IRC, low-level network utilities, networking component of the Player class.
**'''Player''' - fCraft, fCraft.Events namespaces; Permissions and ranks, player-related constants, PlayerDB and PlayerInfo, Player class, Chat.
**'''System''' - fCraft, fCraft.Events namespaces; Config, Server central class, Logger, Scheduler.
**'''Utils''' - fCraft, JetBrains.Annotations, System.IO.Compression namespaces; various utility classes, extension methods, Vector classes, code annotations.
**'''World''' - fCraft namespace; World and WorldManager classes, Block enum, BlockDB classes, map generation, Zones.
*'''fCraftGUI''' - fCraft.GUI namespace; graphical components shared by ServerGUI and ConfigGUI.
*'''ServerCLI''' - fCraft.ServerCLI namespace; Command-line server front end.
*'''ServerGUI''' - fCraft.ServerGUI namespace; Graphical server front end.
*'''UpdateInstaller''' - fCraft.UpdateInstaller namespace; Self-extracting updater.
*'''UpdateBuilder''' - fCraft.UpdateBuilder namespace; Zips files to include in the UpdateInstaller. Used only during the build process.

==Headless operation==
:Headless servers needn't keep ServerGUI, ConfigGUI nor fCraftGUI, they cannot be ran and are not required by the CLI variants. The upcoming [[MapRenderer]] <i>does</i> need fCraftGUI, even though it doesn't create such an interface.
:A server update does re-install the deleted binaries, but those can be removed though a command in the post-update script.

=Key Classes=
*'''fCraft.Command'''
:''fCraft/Commands/Command.cs''
:A text scanner that aids parsing chat commands and their arguments.

*'''fCraft.CommandDescriptor'''
:''fCraft/Commands/CommandDescriptor.cs'''
:Describes a chat command. Defines properties, permission requirements, and usage information. Specifies a handler method. Used to add regular commands.

*'''fCraft.Drawing.DrawOperation'''
:''fCraft/Drawing/DrawOperation.cs''
:Abstract class representing a drawing operation. Used to add draw commands.

*'''fCraft.Chat'''
:''fCraft/Player/Chat.cs''
: Helper class for handling and broadcasting player-generated chat.

*'''fCraft.Permission'''
:''fCraft/Player/Permission.cs''
:Enumeration of all permission types/categories. Every rank definition contains a combination of these.

*'''fCraft.Player'''
:''fCraft/Network/Player.Networking.cs'', ''fCraft/Player/Player.cs'', ''fCraft/Player/Player.Events.cs''
:Object representing volatile state ("session") of a connected player. For persistent state of a known player account, see PlayerInfo. Use "Info" property of the Player class to access the associated PlayerInfo record.

*'''fCraft.PlayerDB'''
:''fCraft/Player/PlayerDB.cs''
:Persistent database of player information. Can be used to look up online or offline players and to gather statistics.

*'''fCraft.PlayerInfo'''
:''fCraft/Player/PlayerInfo.Actions.cs'', ''fCraft/Player/PlayerInfo.cs'', ''fCraft/Player/PlayerInfo.Events.cs''
:Object representing persistent state ("record") of a player, online or offline. There is exactly one PlayerInfo object for each known Minecraft account. All data is stored in the PlayerDB.

*'''fCraft.Rank'''
:''fCraft/Player/Rank.cs''
:A rank that can be assigned to a player. Each player can only hold one rank at a time. Each rank has a name, a set of permissions, and a set of restrictions on those permissions.

*'''fCraft.ConfigKey'''
:''fCraft/System/ConfigKey.cs''
:Enumeration of available configuration keys. ''Config.cs'' contains extension methods for getting/setting keys, resetting key values, and getting key metadata.

*'''fCraft.Logger'''
:''fCraft/System/Logger.cs''
:Central logging class. Logs to file, relays messages to the frontend, submits crash reports.

*'''fCraft.Scheduler'''
:''fCraft/System/Scheduler.cs''
:A general-purpose task scheduler. Can be used to run tasks at certain times, once or periodically. Usable to offloading intensive tasks to the background.

*'''fCraft.Server'''
:''fCraft/System/Server.cs''
:Core of an fCraft server. Manages startup/shutdown, online player sessions, and global events and scheduled tasks.

*'''fCraft.Block'''
:''fCraft/World/Block.cs''
:Enumeration of all standard Minecraft Classic block types.

*'''fCraft.Map'''
:''fCraft/World/Map.cs''
:Represents a loaded map file. Provides methods to get/set blocks, metadata, and zones.

*'''fCraft.World'''
:''fCraft/World/World.cs'', 'fCraft/World/World.Events.cs''
:Represents an entry on the world list. May or may not have a map file loaded. Manages players, access/build security, various metadata, flushing, locking, saving and backups.

=Event Sequences=
*[[API: Startup]]
*[[API: Login]]
*[[API: Shutdown]]
[[Category:Dev]]

/PruneDB

2012-08-22T13:45:15Z

Hellenion: /* Removing other players */ Added a warning about editing PlayerDB manually.

{{CommandBox
|name=PruneDB
|purpose=Removes inactive players from the player database.
|uses=/PruneDB
|cat=Maintenance
|perm={{rperm|EditPlayerDB}}
|console=Yes
|v=0.510
|}}
{{cmd|PruneDB}} searches the server's player database for inactive players and asks to remove them. The command effectively removes players who only joined and left again shortly after. {{cmd|PruneDB}} does not compromise security as, for example, banned or frozen players are not pruned and also ensures legitimate players will not get reset no matter how long they've been inactive.

==Inactive Players==
:The command deems a player inactive if and only if all the following apply:
:* Is not and never was banned
:* Their last IP address is not banned
:* Is not frozen or muted
:* Was never kicked
:* Is the default rank or was never ranked
:* Has been online for less than half an hour
:* Has not been online the past thirty days
:* Has no active accounts on the same IP address

==Removing other players==
{{warning|Editing PlayerDB manually is a common cause of serious crashes, since a mistake is easily made, and is thus strongly advised against.
Damaged entries/info may get lost forever.}}
:The only way to remove other players for the database is to remove them by hand. The database can not be effectively edited while the server is running, as it may overwrite any changes you make. The database file is called PlayerDB.txt, wherein each player represents a line. To remove a player, search for their name on the beginning of the line—any names after that are used for "KickedBy" and the like—and remove that entire line. The database will adjust to your changes the next time the server is started.

==Related commands==
*{{cmd|SetInfo}}
*{{cmd|DumpStats}}

/PruneDB

2012-08-22T07:55:32Z

Hellenion: Needed to link here, didn't exist yet.

{{CommandBox
|name=PruneDB
|purpose=Removes inactive players from the player database.
|uses=/PruneDB
|cat=Maintenance
|perm=EditPlayerDB
|console=Yes
|v=0.510
|}}
{{cmd|PruneDB}} searches the server's player database for inactive players and asks to remove them. The command effectively removes players who only joined and left again shortly after. {{cmd|PruneDB}} does not compromise security as, for example, banned or frozen players are not pruned and also ensures legitimate players will not get reset no matter how long they've been inactive.

==Inactive Players==
:The command deems a player inactive if and only if all the following apply:
:* Is not and never was banned
:* Their last IP address is not banned
:* Is not frozen or muted
:* Was never kicked
:* Is the default rank or was never ranked
:* Has been online for less than half an hour
:* Has not been online the past thirty days
:* Has no active accounts on the same IP address

==Removing other players==
:The only way to remove other players for the database is to remove them by hand. The database can not be effectively edited while the server is running, as it may overwrite any changes you make. The database file is called PlayerDB.txt, wherein each player represents a line. To remove a player, search for their name on the beginning of the line—any names after that are used for "KickedBy" and the like—and remove that entire line. The database will adjust to your changes the next time the server is started.

==Related commands==
:* {{cmd|SetInfo}}
:* {{cmd|DumpStats}}

Help:Contents

2012-08-21T22:35:33Z

Hellenion: /* {{tl|warning}} */ Had alert listed twice

{{notice|'''Go to [http://forum.fcraft.net/viewforum.php?f{{=}}3 fCraft.net Forums] for all tech support, bug reports, and feature requests for fCraft software.'''}}
==Wiki Markup==
:For general information about Wiki formatting, see [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki.org Formatting guide]

==Templates==
==={{tl|perm}}===
:Permission link. Makes a link to [[Permissions]] page, and shows the permission name in italics.
:Example: <code><nowiki>{{perm|Build}}</nowiki></code> becomes {{perm|Build}}

==={{tl|rperm}}===
:Required permission link. Does the same thing as {{tl|perm}}, and adds the page to "Requires <PermissionName>" category.
:Example: <code><nowiki>{{rperm|Test}}</nowiki></code> becomes {{rperm|Test}} and adds this page to [[:Category:Requires Test]]

==={{tl|cmd}}===
:Links to a command, and formats the command name in monospaced font.
:Example: <code><nowiki>{{cmd|UndoPlayer}}</nowiki></code> becomes {{cmd|UndoPlayer}}
:Example: <code><nowiki>{{cmd|Info|@Rank}}</nowiki></code> becomes {{cmd|Info|@Rank}}

==={{tl|notice}}===
:Creates a notice message box.
:Example: <code><nowiki>{{notice|This is an example notice}}</nowiki></code> becomes: {{notice|This is an example notice}}

==={{tl|alert}}===
:Creates an alert message box.
:Example: <code><nowiki>{{alert|This is something important!}}</nowiki></code> becomes: {{alert|This is something important!}}

==={{tl|warning}}===
:Creates a warning message box. Use sparingly!
:Example: <code><nowiki>{{warning|This is something SERIOUS!}}</nowiki></code> becomes: {{warning|This is something SERIOUS!}}

===Color templates===
:There are templates for each Minecraft colorcode:
:<code><nowiki>{{ColorBlack}} {{ColorNavy}} {{ColorGreen}} {{ColorTeal}} {{ColorMaroon}} {{ColorPurple}} {{ColorOlive}} {{ColorSilver}}</nowiki></code>
:{{ColorBlack}} {{ColorNavy}} {{ColorGreen}} {{ColorTeal}} {{ColorMaroon}} {{ColorPurple}} {{ColorOlive}} {{ColorSilver}}

:<code><nowiki>{{ColorGray}} {{ColorBlue}} {{ColorLime}} {{ColorAqua}} {{ColorRed}} {{ColorMagenta}} {{ColorYellow}} {{ColorWhite}}</nowiki></code>
:{{ColorGray}} {{ColorBlue}} {{ColorLime}} {{ColorAqua}} {{ColorRed}} {{ColorMagenta}} {{ColorYellow}} {{ColorWhite}}

/Ranks

2012-08-21T22:33:50Z

Hellenion: /* Related commands */ Changed Ranks to RankInfo

{{CommandBox
|name=Ranks
|purpose=Display all ranks of the server.
|aliases=Classes
|uses=/Ranks
|cat=Info
|perm=
|console=Yes
|v=0.100
|}}

{{cmd|Ranks}} lists all Ranks on the server, which are visible to all players including players with restricted command access like frozen players. The ranks have a linear hierarchy, where the highest rank is listed at the top of the list and the lowest at the bottom. The list also supplies information about how many players have said rank, which may help indicate the rank's value. Further information about each rank can be viewed with {{cmd|RankInfo}}.

==Changing the list==
===Config===
:The ConfigGUI has a tab dedicated to editing ranks, many changes in this tab will be reflected in {{cmd|Ranks}} or else in {{cmd|RankInfo}}. Like in {{cmd|Ranks}} the Rank List is linear and has the highest rank at the top and the lowest rank at the bottom.
:There are separate buttons for adding, deleting, or moving a rank.
::Added ranks appear at the bottom of the list to prevent interference with permission checks.
::When deleting a rank, you will be prompted for a replacement rank, so as to not render all those players rankless.
::When moving a rank around in the list all players with that rank will assume that new place in the hierarchy.

===In-Game===
:Dispite there being an {{cmd|Import|Ranks}}, this will not change the ranks list. It will merely import the players. There is currently no way to change the rank listing in-game, though hints have been made about adding such functionality.

==Related commands==
*{{cmd|RankInfo}} — shows a list of rank's permissions and limits.
*{{cmd|Rank}} — changes a player's rank (promotes or demotes).

==History==
:The {{cmd|Ranks}} command changed little over time, most likely due to it's simplicity and how fCraft's ranking system has stayed much the same, too.
:Ranks used to be called classes, hence the alias. This was changed in fCraft version 0.480 for consistency with other servers. Several commands were renamed to reflect that.
:Even earlier, <CODE>/Classes</CODE> was merged with what now is {{cmd|Ranks}}.

/Ranks

2012-08-21T22:32:24Z

Hellenion: Added listing of related commands.

{{CommandBox
|name=Ranks
|purpose=Display all ranks of the server.
|aliases=Classes
|uses=/Ranks
|cat=Info
|perm=
|console=Yes
|v=0.100
|}}

{{cmd|Ranks}} lists all Ranks on the server, which are visible to all players including players with restricted command access like frozen players. The ranks have a linear hierarchy, where the highest rank is listed at the top of the list and the lowest at the bottom. The list also supplies information about how many players have said rank, which may help indicate the rank's value. Further information about each rank can be viewed with {{cmd|RankInfo}}.

==Changing the list==
===Config===
:The ConfigGUI has a tab dedicated to editing ranks, many changes in this tab will be reflected in {{cmd|Ranks}} or else in {{cmd|RankInfo}}. Like in {{cmd|Ranks}} the Rank List is linear and has the highest rank at the top and the lowest rank at the bottom.
:There are separate buttons for adding, deleting, or moving a rank.
::Added ranks appear at the bottom of the list to prevent interference with permission checks.
::When deleting a rank, you will be prompted for a replacement rank, so as to not render all those players rankless.
::When moving a rank around in the list all players with that rank will assume that new place in the hierarchy.

===In-Game===
:Dispite there being an {{cmd|Import|Ranks}}, this will not change the ranks list. It will merely import the players. There is currently no way to change the rank listing in-game, though hints have been made about adding such functionality.

==Related commands==
*{{cmd|Ranks}} — shows a list of all ranks.
*{{cmd|Rank}} — changes a player's rank (promotes or demotes).

==History==
:The {{cmd|Ranks}} command changed little over time, most likely due to it's simplicity and how fCraft's ranking system has stayed much the same, too.
:Ranks used to be called classes, hence the alias. This was changed in fCraft version 0.480 for consistency with other servers. Several commands were renamed to reflect that.
:Even earlier, <CODE>/Classes</CODE> was merged with what now is {{cmd|Ranks}}.

/RankInfo

2012-08-21T22:27:13Z

Hellenion: Added more information

{{CommandBox
|name=RankInfo
|purpose=Shows rank information
|aliases=RInfo
|uses=/RankInfo

/RankInfo RankName
|cat=Info
|perm=
|console=Yes
|v=0.200
|}}
{{cmd|RankInfo}} shows a list of permissions granted to a rank, effectively listing a rank's permissions and limitations. The general permissions are listed in alphabetical order, if applicable, a separate line shows the draw limit and the amount of copyslots below the first list. For a full list of ranks, use {{cmd|Ranks}}.
Any rank can use {{cmd|RankInfo}}, even players with restricted command access such as those frozen may use this command.

==Uses==
==={{cmd|RankInfo}}===
::Shows the permissions for your current rank.
==={{cmd|RankInfo|RankName}}===
::Shows the permissions for the specified rank.

==Editing permissions==
===Config===
::The ConfigGUI has a tab specifically for editing ranks and their permissions. The checkbox list on the right indicate which permissions the selected rank will receive. The middle allows for editing permission limits such as the promotion limit or the draw limit, as well as some more general rank options like RankName and color.
::Nearly all changes made here show up in {{cmd|RankInfo}} or else in {{cmd|Ranks}}.
===In-Game===
::There is currently no way to edit permissions in-game or from console, although this suggestion has not been rejected.

==Related commands==
*{{cmd|Ranks}} — shows a list of all ranks.
*{{cmd|Rank}} — changes a player's rank (promotes or demotes).

==History==
:{{cmd|RankInfo}} was split from what now is {{cmd|Ranks}} and was originally named <CODE>/Class</CODE>. Aliases from this period have not been preserved.
:The command has gone through some changes where more permissions were added to be shown, but never changed much.

{{LastUpdated|1650}}

/Ranks

2012-08-21T22:19:43Z

Hellenion: Now using templates.

{{CommandBox
|name=Ranks
|purpose=Display all ranks of the server.
|aliases=Classes
|uses=/Ranks
|cat=Info
|perm=
|console=Yes
|v=0.100
|}}

{{cmd|Ranks}} lists all Ranks on the server, which are visible to all players including players with restricted command access like frozen players. The ranks have a linear hierarchy, where the highest rank is listed at the top of the list and the lowest at the bottom. The list also supplies information about how many players have said rank, which may help indicate the rank's value. Further information about each rank can be viewed with {{cmd|RankInfo}}.

==Changing the list==
===Config===
:The ConfigGUI has a tab dedicated to editing ranks, many changes in this tab will be reflected in {{cmd|Ranks}} or else in {{cmd|RankInfo}}. Like in {{cmd|Ranks}} the Rank List is linear and has the highest rank at the top and the lowest rank at the bottom.
:There are separate buttons for adding, deleting, or moving a rank.
::Added ranks appear at the bottom of the list to prevent interference with permission checks.
::When deleting a rank, you will be prompted for a replacement rank, so as to not render all those players rankless.
::When moving a rank around in the list all players with that rank will assume that new place in the hierarchy.

===In-Game===
:Dispite there being an {{cmd|Import|Ranks}}, this will not change the ranks list. It will merely import the players. There is currently no way to change the rank listing in-game, though hints have been made about adding such functionality.

==History==
:The {{cmd|Ranks}} command changed little over time, most likely due to it's simplicity and how fCraft's ranking system has stayed much the same, too.
:Ranks used to be called classes, hence the alias. This was changed in fCraft version 0.480 for consistency with other servers. Several commands were renamed to reflect that.
:Even earlier, <CODE>/Classes</CODE> was merged with what now is {{cmd|Ranks}}.

/Ranks

2012-08-21T21:04:28Z

Hellenion: Complete rewrite of page to be more informative and discard outdated/ambiguous infotmation

{{CommandBox
|name=Ranks
|purpose=Display all ranks of the server.
|aliases=Classes
|uses=/Ranks
|cat=Info
|perm=
|console=Yes
|v=0.100
|}}

Lists all Ranks on the server, which are visible to all players including players with restricted command access like frozen players. The ranks have a linear hierarchy, where the highest rank is listed at the top of the list and the lowest at the bottom. The list also supplies information about how many players have said rank, which may help indicate the rank's value. Further information about each rank can be viewed with <CODE>[[/RankInfo]]</CODE>.

==Changing the list==
===Config===
:The ConfigGUI has a tab dedicated to editing ranks, many changes in this tab will be reflected in <CODE>/Ranks</CODE> or else in <CODE>[[/RankInfo]]</CODE>. Like in <CODE>/Ranks</CODE> the Rank List is linear and has the highest rank at the top and the lowest rank at the bottom.
:There are separate buttons for adding, deleting, or moving a rank.
::Added ranks appear at the bottom of the list to prevent interference with permission checks.
::When deleting a rank, you will be prompted for a replacement rank, so as to not render all those players rankless.
::When moving a rank around in the list all players with that rank will assume that new place in the hierarchy.

===In-Game===
:Dispite there being an <CODE>[[/Import]] Ranks</CODE>, this will not change the ranks list. It will merely import the players. There is currently no way to change the rank listing in-game, though hints have been made about adding such functionality.

==History==
:The <CODE>/Ranks</CODE> command changed little over time, most likely due to it's simplicity and how fCraft's ranking system has stayed much the same, too.
:Ranks used to be called classes, hence the alias. This was changed in fCraft version 0.480 for consistency with other servers. Several commands were renamed to reflect that.
:Even earlier, <CODE>/Classes</CODE> was merged with what now is <CODE>[[/RankInfo]]</CODE>.

/Ranks

2012-08-21T20:15:46Z

Hellenion:

{{CommandBox
|name=Ranks
|purpose=Display all ranks of the server.
|aliases=Classes
|uses=/Ranks
|cat=Info
|perm=
|console=Yes
|v=0.100
|}}

Lists all Ranks on the server, which are visible to all players. The ranks have a linear hierarchy, where the highest rank is listed at the top of the list and the lowest at the bottom. The list also supplies information about how many players have said rank, which may help indicate the rank's value. Further information about each rank can be viewed with [[/RankInfo]]

===Changing the list===
:todo

/DumpStats

2012-08-20T07:39:38Z

Hellenion: /* /DumpStats FileName.txt */ explicitly stated the need to end in .txt

{{CommandBox
|name=DumpStats
|purpose=Computes some PlayerDB statistics.
|aliases=
|uses=/DumpStats FileName.txt
|cat=Maintenance
|perm={{perm|EditPlayerDB}}
|console=Yes
|v=0.490
|}}

==<code>/DumpStats FileName.txt</code>==
Computes and saves a number of statistics about the server to a given text file. Statistics include average blocks built/deleted, average time spent, average messages written, etc. Statistics are broken down by rank. Only active, non-banned players are counted. Note that for security reasons, the target file must be in the fCraft folder and must end in <code>.txt</code>.

{{LastUpdated|605}}

/CuboidW

2012-08-20T07:01:20Z

Hellenion: Okay this is getting embarrasing

{{CommandBox
|name=CuboidW
|purpose=Draws a wireframe outline of a box.
|aliases=/BFB, /CW
|uses=/CuboidW

/CuboidW Block
|cat=Building
|perm=Draw
|console=No
|v=0.494
|}}

Draws a wireframe outline of a box, optionally filling the inside with another block type. After entering the command you need to mark 2 opposing corners of the area. You can do that either by clicking the blocks (building or deleting works), or using the [[/Mark]] command. The results of [[/CuboidW]] can be undone using [[/Undo]].

==<code>/CuboidW</code>==
:Draws the box made of whatever block player is holding. The inside is left untouched.

==<code>/CuboidW FrameBlock</code>==
:Draws the box made of a given block type. The inside is left untouched.

==Customizing /CuboidW behavior==
*The volume of blocks that can be drawn at once can be limited per-rank. See "Draw limit" field on ConfigTool's Ranks tab. Alternatively, set the "drawLimit" attribute on the <Rank> tag (if you are editing config.xml manually).
*Being able to undo a command requires storing a backup an area of the map. This may take up significant amounts of memory. By default, fCraft limits [[/Undo]] to the first 2,000,000 blocks that are drawn. You can change this (or remove the limit entirely) via [[List_of_config_keys#Advanced|MaxUndo]] config key.

{{LastUpdated|605}}

/CuboidW

2012-08-20T07:00:44Z

Hellenion: Forgot the CommandBox

{{CommandBox
|name=CuboidW
|purpose=Draws a wireframe outline of a box.
|aliases=/BFB, /CW
|uses=/CuboidW

/CuboidW Block

/CuboidW Frame
|cat=Building
|perm=Draw
|console=No
|v=0.494
|}}

Draws a wireframe outline of a box, optionally filling the inside with another block type. After entering the command you need to mark 2 opposing corners of the area. You can do that either by clicking the blocks (building or deleting works), or using the [[/Mark]] command. The results of [[/CuboidW]] can be undone using [[/Undo]].

==<code>/CuboidW</code>==
:Draws the box made of whatever block player is holding. The inside is left untouched.

==<code>/CuboidW FrameBlock</code>==
:Draws the box made of a given block type. The inside is left untouched.

==Customizing /CuboidW behavior==
*The volume of blocks that can be drawn at once can be limited per-rank. See "Draw limit" field on ConfigTool's Ranks tab. Alternatively, set the "drawLimit" attribute on the <Rank> tag (if you are editing config.xml manually).
*Being able to undo a command requires storing a backup an area of the map. This may take up significant amounts of memory. By default, fCraft limits [[/Undo]] to the first 2,000,000 blocks that are drawn. You can change this (or remove the limit entirely) via [[List_of_config_keys#Advanced|MaxUndo]] config key.

{{LastUpdated|605}}

/CuboidW

2012-08-20T06:59:09Z

Hellenion: There is no fillingblock feature in /CuboidW

{{CommandBox
|name=CuboidW
|purpose=Draws a wireframe outline of a box.
|aliases=/BFB, /CW
|uses=/CuboidW

/CuboidW Block

/CuboidW Frame Filling
|cat=Building
|perm=Draw
|console=No
|v=0.494
|}}

Draws a wireframe outline of a box, optionally filling the inside with another block type. After entering the command you need to mark 2 opposing corners of the area. You can do that either by clicking the blocks (building or deleting works), or using the [[/Mark]] command. The results of [[/CuboidW]] can be undone using [[/Undo]].

==<code>/CuboidW</code>==
:Draws the box made of whatever block player is holding. The inside is left untouched.

==<code>/CuboidW FrameBlock</code>==
:Draws the box made of a given block type. The inside is left untouched.

==Customizing /CuboidW behavior==
*The volume of blocks that can be drawn at once can be limited per-rank. See "Draw limit" field on ConfigTool's Ranks tab. Alternatively, set the "drawLimit" attribute on the <Rank> tag (if you are editing config.xml manually).
*Being able to undo a command requires storing a backup an area of the map. This may take up significant amounts of memory. By default, fCraft limits [[/Undo]] to the first 2,000,000 blocks that are drawn. You can change this (or remove the limit entirely) via [[List_of_config_keys#Advanced|MaxUndo]] config key.

{{LastUpdated|605}}

/WRename

2012-08-20T06:32:30Z

Hellenion: replaced /WDelete with the canonical /WUnload

{{CommandBox
|name=WRename
|purpose=Renames a world.
|uses=/WRename <OldName> <NewName>
|cat=World
|aliases=
|perm=ManageWorlds
|console=Yes
|v=0.410
|}}

==<code>/WRename <OldName> <NewName></code>==
:Renames a given world. The map file and BlockDB data will be moved as well. /WRename will ask for a confirmation if moving the mapfile will result in overwriting an existing file.

==Deleting files==
:As a side effect of its operations, this command allows remote admins to permanently remove <code>.fcm</code> files by overwriting them, where <code>/WUnload</code> does not. Note that the corresponding world needs to be deleted from the list before overwriting is possible.

{{LastUpdated|1400}}