fCraft Wiki - User contributions [en]

Mod Examples

2012-03-27T17:53:32Z

75.70.55.0:

This page demonstrates examples of modifying and extending fCraft.

==Hooking up custom code==
{{warning|This method of modding fCraft's code directly will be obsoleted when the plugin system is done}}
Until the proper Plugin API is finished, I recommend minimizing edits to fCraft's existing files, and trying to contain all custom code in your own namespace/files. You will need to make at least one change to Server.cs though, to add your code to run on startup. Use that very first call to subscribe to various events. For detailed information about the startup procedure, see [[API: Startup]].
<syntaxhighlight lang="csharp">
// Add this to beginning of Server.InitServer
ClassWithMyMods.Init();

// Meanwhile, in ClassWithMyMods:
// Use this to hook up events. Dont do anything else quite yet.
public static void Init(){
Server.Initialized += MyServerInitializedHandler;
Server.Started += MyServerStartedHandler;
// etc events
}

// This is where you can go ahead and register custom commands, brushes, etc
// Server.Initialized is invoked after everything else in Server.InitServer() is done
static void MyServerInitializedHandler( object sender, EventArgs e ){
CommandManager.RegisterCustomCommand( CdMyCommandStuff );
}

// This is where you can start timers, open up ports, manipulate world list, etc
// Server.Started is invoked just after server fully finished its startup routine
static void MyServerStartedHandler( object sender, EventArgs e ){
Scheduler.NewTask( MyTask ).RunForever( myTaskInterval );
}
</syntaxhighlight>

==Calling custom code at regular intervals==
The following example will call '''BleepTask''' method every 10 seconds.
<syntaxhighlight lang="csharp">
// Interval at which your callback is called
TimeSpan bleepInterval = TimeSpan.FromSeconds( 10 );

// Adding your callback
Scheduler.NewTask( BleepTask ).RunForever( bleepInterval );

// Your callback. Implements SchedulerCallback delegate.
void BleepTask( SchedulerTask task ){
Chat.Say( Player.Console, "bleep" );
}</syntaxhighlight>
Besides '''RunForever(TimeSpan)''', SchedulerTask has many '''Run*''' methods for running a task once, several times, or forever - with different delays and at different intervals.

==Checking incoming players==
There are many events fired while the player is connecting. For a full explanation, see [[API: Login]]. For example '''Player.Connected''' event is fired after fCraft looks player up in the database/verifies name/checks bans, but just before a handshake reply is sent to the player. This event allows addition more checks before player is allowed into the server.
Here we're using '''Player.Ready''' event, which is fired when a player is fully connected, and just after they join the main map. This is where all announcement code should go.
<syntaxhighlight lang="csharp">
// Subscribing to the event
Player.Ready += OnPlayerReady;

// Event handler
void OnPlayerReady( object sender, PlayerEventArgs e ) {
// if connecting player is of highest rank (presumably owner)
if( e.Player.Info.Rank == RankManager.HighestRank ) {
// Get a list of players who can see them join
// (to avoid accidentally revealing hidden owners)
var playersToMsg = Server.Players.CanSee( e.Player );
// Spam them (use &Y colorcode, which maps to SayColor)
playersToMsg.Message( "&YOMG THE OWNER IS HERE! EVERYONE SAY \"HEY {0}\"",
e.Player.Name );

// or, if player's name contains the word "grief"
} else if( e.Player.Name.Contains( "grief", StringComparison.OrdinalIgnoreCase ) ) {
// Spam everyone some more!
Server.Message( "&YLOOK OUT! GRIEFERS ARE COMING!" );
}
}
</syntaxhighlight>

==Adding a new command==
New commands can be added by calling '''CommandManager.RegisterCustomCommand'''. You need to provide a '''CommandDescriptor''' object. If there is any conflict between your command and existing ones, or if some aspect of your command's descriptor is unacceptible, a '''CommandRegistrationException''' will be thrown.
<syntaxhighlight lang="csharp">
// Command descriptor
CommandDescriptor CdBleep = new CommandDescriptor {
Name = "bleep",
Aliases = new[] { "bloop" },
Category = CommandCategory.Chat,
Permissions = new[] { Permission.Chat },
Help = "Prints a number of bleeps in chat.",
Usage = "/bleep [Times]",
Handler = BleepHandler
};

// Command handler - must implement CommandHandler delegate
void BleepHandler( Player player, Command cmd ) {
int numberOfBleeps = 10;

// if a param is given
if( cmd.HasNext ) {
// try to parse it as a number, and save to numberOfBleeps
if( !cmd.NextInt( out numberOfBleeps ) ) {
// if that fails (not a number), print usage
CdBleep.PrintUsage( player );
return;
}
}

// check the range
if( numberOfBleeps < 1 || numberOfBleeps > 32 ) {
player.Message( "Specify between 1 and 32 bleeps." );
return;
}

for( int i = 0; i < numberOfBleeps; i++ ) {
Chat.SendGlobal( player, "bleep" );
}
}

// Registering your command with the server
CommandManager.RegisterCustomCommand( CdBleep );
</syntaxhighlight>

==Reacting to server shutdown==
There are two events associated with shutdown: '''Server.ShutdownBegan''' and '''Server.ShutdownEnded'''. Both supply a '''ShutdownEventArgs''' object that provides information about the shutdown parameters. For more information about how server shutdown works, see [[API: Shutdown]].
<syntaxhighlight lang="csharp">
// Subscribing to the event
Server.ShutdownBegan += OnShutdownBegan;

// Event handler
void OnShutdownBegan( object sender, ShutdownEventArgs e ){
Console.Write( "The end is near!" );
if( e.Restart ){
Console.Write( "But we will be back shortly." );
}
}
</syntaxhighlight>
[[Category:Dev]]

Installation instructions

2011-10-31T00:09:03Z

75.70.55.0: /* I made changed to the config/world list, but changes didn't apply */

{{alert|When first starting fCraft, type this in the console of your running server:

<code>/promote YourUserName DesiredClassName</code>

to promote yourself.}}

=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>ConfigTool.exe</code> before starting the server and carefully configure the options. Your configuration will be stored in <code>config.xml</code>.
# After configuring the server, you can run either <code>fCraftUI.exe</code> (GUI version) OR <code>fCraftConsole.exe</code> (command-line version) to start the server. Do not run both at the same time.

=Linux, Unix, MacOS X (Mono)=
# Download a current copy of fCraft here: {{LatestVersion}}. Use <code>gunzip</code> to extract it.
# fCraft requires Mono 2.6.4 (minumum) or Mono 2.10.2 (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 <code>yum</code> or <code>apt-get</code>).
#: To be able to use graphical fCraft components (ServerGUI and ConfigGUI) you will also need GDI+ library (libgdiplus).
# 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>ConfigTool.exe</code> to configure your server, and then either <code>fCraftUI.exe</code> OR <code>fCraftConsole.exe</code> to start the server.
#: If you want to run console-only on a headless server, the ConfigTool GUI probably won't work for you to configure things. You can run ConfigTool on your local machine and upload edited config.xml/worlds.xml. Alternatively, edit <code>config.xml</code> manually with your favorite text editor. Detailed information about config.xml keys can be found [[Config|here]].

=Troubleshooting=
===Port Forwarding===
If you have a router, you will need to [http://portforward.com/ forward the port] to allow external players to connect. '''Default port is 25565'''. ConfigTool includes a little tool for checking whether the port is forwarded properly - click the [Check] button next to port number setting, on "General" tab.

===I made changed to the config/world list, but changes didn't apply===
* fCraft can read most changes on the fly using [[/Reload]] command. However, some things require a full restart:
** Ranks
** Worlds
** IRC settings
** Enabling/disabling BlockDB
* Make sure that ServerCLI and ServerGUI are NOT running while you run ConfigGUI. fCraft may overwrite your changes if it's still running.
* Changes are not saved until you hit "OK" or "Apply" in ConfigGUI.
* Make sure that ConfigGUI is in the same folder as the rest of the server files.

===Other players cannot connect from LAN===
Minecraft client has a lot of trouble working on LAN. You probably will not be able to connect via the public URL. Fortunately, there is a workaround:
# Enable "Allow connections from LAN without verification" checkbox in ConfigTool (<[[AllowUnverifiedLAN]]> in config.xml).
# Find your local IP address.
#* In Windows XP+, go to Start -> type "cmd" to open a terminal -> type "ipconfig". The address you need is labeled "IPv4 Address" under "Local Area Connection".
#* In Unix/Linux, use "ifconfig" utility.
# Connect to [http://www.minecraft.net/classic/play?ip=_____&port=_____ http://www.minecraft.net/classic/play?ip=_____&port=_____] (fill in blanks with your server's IP address and port).

===How do I promote myself to the highest rank/class?===
Type the following in console (either fCraftConsole or fCraftUI): <code>/promote YourName DesiredClass</code>

===System.DllNotFoundException: libMonoPosixHelper.so===
Install <code>libmono-posix2.0-cil</code> package, if available.
This is also a known issue with compiling Mono from source on CentOS. Update to 2.10+ (recommended), or try [http://go-mono.com/forums/#nabble-td1537921 this workaround].

===Memory usage keeps going up under Mono===
If you are using Mono 2.6.x or earlier, you are out of luck. If you are running 2.8+, try running mono with "--gc=sgen" switch, like this: <code>mono --gc=sgen ServerGUI.exe</code>.
If you've tried everything and cannot get Mono memory usage under control, try setting the [[RestartInterval]] config key to make the server restart itself every once in a while.

===CentOS problems===
'''fCraft is not officially supported on CentOS due to numerous reported problems.''' If you still want to continue, try these solutions:
* [http://www.go-mono.com/mono-downloads/download.html Use the official package from the Mono website]. The version available via yum may be outdated.
* You may have to add mono directory (<code>/opt/novell/mono/</code>) to your paths. Adding something like this to your startup script should do it:
#echo export PKG_CONFIG_PATH=/opt/novell/mono/lib/pkgconfig:$PKG_CONFIG_PATH>>~/.bash_profile
#echo export PATH=/opt/novell/mono/bin:$PATH>>~/.bash_profile
#source ~/.bash_profile

Installation instructions

2011-10-31T00:06:41Z

75.70.55.0: /* Troubleshooting */

{{alert|When first starting fCraft, type this in the console of your running server:

<code>/promote YourUserName DesiredClassName</code>

to promote yourself.}}

=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>ConfigTool.exe</code> before starting the server and carefully configure the options. Your configuration will be stored in <code>config.xml</code>.
# After configuring the server, you can run either <code>fCraftUI.exe</code> (GUI version) OR <code>fCraftConsole.exe</code> (command-line version) to start the server. Do not run both at the same time.

=Linux, Unix, MacOS X (Mono)=
# Download a current copy of fCraft here: {{LatestVersion}}. Use <code>gunzip</code> to extract it.
# fCraft requires Mono 2.6.4 (minumum) or Mono 2.10.2 (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 <code>yum</code> or <code>apt-get</code>).
#: To be able to use graphical fCraft components (ServerGUI and ConfigGUI) you will also need GDI+ library (libgdiplus).
# 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>ConfigTool.exe</code> to configure your server, and then either <code>fCraftUI.exe</code> OR <code>fCraftConsole.exe</code> to start the server.
#: If you want to run console-only on a headless server, the ConfigTool GUI probably won't work for you to configure things. You can run ConfigTool on your local machine and upload edited config.xml/worlds.xml. Alternatively, edit <code>config.xml</code> manually with your favorite text editor. Detailed information about config.xml keys can be found [[Config|here]].

=Troubleshooting=
===Port Forwarding===
If you have a router, you will need to [http://portforward.com/ forward the port] to allow external players to connect. '''Default port is 25565'''. ConfigTool includes a little tool for checking whether the port is forwarded properly - click the [Check] button next to port number setting, on "General" tab.

===I made changed to the config/world list, but changes didn't apply===
* Make sure that fCraftConsole and fCraftUI are NOT running while you run ConfigTool. fCraft may overwrite your changes if it's still running.
* Changes are not saved until you hit "OK" or "Apply" in ConfigTool.
* Make sure that ConfigTool is in the same folder as the rest of the server files. If you compiled fCraft from source, copy binaries from separate project folders.

===Other players cannot connect from LAN===
Minecraft client has a lot of trouble working on LAN. You probably will not be able to connect via the public URL. Fortunately, there is a workaround:
# Enable "Allow connections from LAN without verification" checkbox in ConfigTool (<[[AllowUnverifiedLAN]]> in config.xml).
# Find your local IP address.
#* In Windows XP+, go to Start -> type "cmd" to open a terminal -> type "ipconfig". The address you need is labeled "IPv4 Address" under "Local Area Connection".
#* In Unix/Linux, use "ifconfig" utility.
# Connect to [http://www.minecraft.net/classic/play?ip=_____&port=_____ http://www.minecraft.net/classic/play?ip=_____&port=_____] (fill in blanks with your server's IP address and port).

===How do I promote myself to the highest rank/class?===
Type the following in console (either fCraftConsole or fCraftUI): <code>/promote YourName DesiredClass</code>

===System.DllNotFoundException: libMonoPosixHelper.so===
Install <code>libmono-posix2.0-cil</code> package, if available.
This is also a known issue with compiling Mono from source on CentOS. Update to 2.10+ (recommended), or try [http://go-mono.com/forums/#nabble-td1537921 this workaround].

===Memory usage keeps going up under Mono===
If you are using Mono 2.6.x or earlier, you are out of luck. If you are running 2.8+, try running mono with "--gc=sgen" switch, like this: <code>mono --gc=sgen ServerGUI.exe</code>.
If you've tried everything and cannot get Mono memory usage under control, try setting the [[RestartInterval]] config key to make the server restart itself every once in a while.

===CentOS problems===
'''fCraft is not officially supported on CentOS due to numerous reported problems.''' If you still want to continue, try these solutions:
* [http://www.go-mono.com/mono-downloads/download.html Use the official package from the Mono website]. The version available via yum may be outdated.
* You may have to add mono directory (<code>/opt/novell/mono/</code>) to your paths. Adding something like this to your startup script should do it:
#echo export PKG_CONFIG_PATH=/opt/novell/mono/lib/pkgconfig:$PKG_CONFIG_PATH>>~/.bash_profile
#echo export PATH=/opt/novell/mono/bin:$PATH>>~/.bash_profile
#source ~/.bash_profile

/WLoad

2011-05-21T03:42:03Z

75.70.55.0:

{{CommandBox
|name=wload
|purpose=Loads maps and creates new worlds.
|uses=/wload FileName
/wload FileName WorldName
/wload SourceWorld TargetWorld
|cat=World
|aliases=wadd
|perm=ManageWorlds
|console=Yes
|}}
Load map from file into a world. Can be used to create new worlds. Asks for confirmation in case anything is about to be overwritten.

==<code>/wload FileName</code>==
:Replaces the current world's map with contents of the given map file. The current map is lost. Cannot be used from console.

==<code>/wload FileName WorldName</code>==
:If a world with the given name exists, its map is replaced. Otherwise, a new world is created using this name and map.

==<code>/wload SourceWorld TargetWorld</code>==
:Copies map from SourceWorld to TargetWorld, or creates a new world using this name and the map from SourceWorld. Since maps are named after their worlds, this is essentially same as loading SourceWorld.fcm

==Supported map formats==
* fCraft (.fcm) - format versions 2 and 3
* MCSharp, MCZall, and MCLawl (.lvl)
* D3 (.map)
* Default/vanilla server (.dat)
* MinerCPP, and LuaCraft (.dat)
* JTE's (.gz)
* Indev (.mclevel) - finite maps only
* Myne, MyneCraft, Hyvebuild, and iCraft (directory)
* Opticraft (.save)
* XMap (.xmap)
{{LastUpdated|458}}

/WLoad

2011-03-14T21:30:17Z

75.70.55.0:

[[Category:Commands]]{{LastUpdated|370}}
Load map from file into a world. Can be used to create new worlds. Asks for confirmation in case anything is about to be overwritten.

==<code>/wload FileName</code>==
:Replaces the current world's map with contents of the given map file. The current map is lost. Cannot be used from console.

==<code>/wload FileName WorldName</code>==
:If a world with the given name exists, its map is replaced. Otherwise, a new world is created using this name and map.

==<code>/wload SourceWorld TargetWorld</code>==
:Copies map from SourceWorld to TargetWorld, or creates a new world using this name and the map from SourceWorld. Since maps are named after their worlds, this is essentially same as loading SourceWorld.fcm

==Supported map formats==
* fCraft (.fcm) - format versions 2 and 3
* MCSharp, MCZall, and MCLawl (.lvl)
* D3 (.map)
* Default/vanilla server (.dat)
* MinerCPP, and LuaCraft (.dat)
* JTE's (.gz)
* Indev (.mclevel) - finite maps only
* Myne, MyneCraft, Hyvebuild, and iCraft (directory)