Jump to content

Installation instructions: Difference between revisions

From fCraft Wiki
Undo revision 169 by 188.138.101.244 (talk)
 
(34 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{alert|When first starting fCraft, type this in the console of your running server:
=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].
<code>/promote YourUserName DesiredClassName</code>
# 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).
to promote yourself.}}
# 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.
That's not just the best answer. It's the beesstt answer!


=Linux, Unix, MacOS X (Mono)=
=Linux, Unix, MacOS X (Mono)=
* fCraft has been tested/compiled on:
{{notice|fCraft has only been officially tested on
** ''Debian Squeeze w/ Mono 2.4.4'' - <code>deb http://debian.meebey.net/pkg-mono</code>
*Ubuntu 10/12
** ''Debian Lenny w/ Mono 2.4.2.3'' - <code>deb http://www.backports.org/debian lenny-backports main | mono-devel package</code> (Thanks to Fighter for testing)
*Debian 6
** ''Mac OS X 10.6.4 w/ Mono 2.6.4'' (Thanks to Panda for testing)
*MacOS X 10.6
** ''CentOS 4 w/ Mono 2.6.4'' (requires a [[#System.DllNotFoundException:_libMonoPosixHelper.so|workaround]], thanks to iKJames for testing)
If you are using a different distribution, use at your own risk.}}
* The first and most important step here is to ensure you have the [http://mono-project.com/Obtaining_Mono Mono runtime] installed.
# Download a current copy of fCraft here: {{LatestVersion}}. Use ''gunzip'' to extract it. Read the README file.
* The next step is to download the [https://sourceforge.net/projects/fcraft/files/ latest binaries]
## Putting the <code>PlayerDB.txt</code> on an NTFS partition can reduce chance of corruption on unsafe shutdown/power loss.
** fCraft can be compiled from source using Mono (using [http://monodevelop.com/ MonoDevelop IDE] is the easiest way) if you wish to keep up with the latest experimental versions on the [https://fcraft.svn.sourceforge.net/svnroot/fcraft SVN]. Visit #fCraft on [irc://irc.esper.net:5555 irc.esper.net] if you need more info.
# fCraft requires Mono 2.8+ (minimum) or Mono 3.0+ (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).
* From here on out is roughly the same as on Windows. You can run <code>mono ConfigTool.exe</code> to configure your server, and then either <code>mono fCraftUI.exe</code> OR <code>mono fCraftConsole.exe</code> to start the server.
# 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.
** 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 favourite text editor. Detailed information about config.xml keys can be found [[Config Keys|here]].
# 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:
=Troubleshooting=
#: Mono 2.8+: <code>mono --gc=sgen SomeFile.exe</code>
===I made changed to the config/world list, but changes didn't apply===
#: Mono 3.0+: <code>mono SomeFile.exe</code>
* Make sure that fCraftConsole and fCraftUI are NOT running while you run ConfigTool. fCraft may overwrite your changes if it's still running.
{{notice|'''Consider using [[fcraftd]] script, made by Hellenion, to manage your *nix server!}}
* Changes are not saved until you hit "OK" or "Apply" in ConfigTool.
# 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.
* 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.
#: 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]].
 
===How do I promote myself to the highest rank/class?===
:Type the following in console (either fCraftConsole or fCraftUI): <code>/promote YourName DesiredClass</code>
 
===CentOS problems===
:There have been a lot of problems reported with getting Mono working on CentOS.
:* [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
 
====System.DllNotFoundException: libMonoPosixHelper.so====
:Install <code>libmono-posix2.0-cil</code> package.
:This is also a known issue with compiling Mono from source on CentOS. Update to 2.8+ (recommended), or try [http://go-mono.com/forums/#nabble-td1537921 this workaround].


===Memory usage keeps going up under Mono===
=[[Troubleshooting]]=
:Try running mono with "--gc=sgen" switch, like this: <code>mono -gc=sgen fCraftConsole.exe</code> (thanks to wootalyzer for discovering).
==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.)

Latest revision as of 21:25, 2 August 2013

Windows

  1. fCraft requires Microsoft .NET Framework 3.5. Your system may already have it installed, and you can download it from microsoft.com.
  2. Download a current copy of fCraft here: 0.644
  3. Extract the zip file into the directory where you wish to keep all the server data (maps, logs, config, etc).
  4. Run ConfigGUI.exe 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.
  5. After configuring the server, you can run either ServerGUI.exe (GUI version) OR ServerCLI.exe (command-line version) to start the server. Do not run both at the same time.

Linux, Unix, MacOS X (Mono)

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.

  1. Download a current copy of fCraft here: 0.644. Use gunzip to extract it. Read the README file.
    1. Putting the PlayerDB.txt on an NTFS partition can reduce chance of corruption on unsafe shutdown/power loss.
  2. fCraft requires Mono 2.8+ (minimum) or Mono 3.0+ (recommended) runtime. You can 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 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).
  3. 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 mozroots --import --ask-remove as the fCraft user on your system.
  4. 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.
  5. To run ".exe" files with Mono, use the following syntax:
    Mono 2.8+: mono --gc=sgen SomeFile.exe
    Mono 3.0+: mono SomeFile.exe
Consider using fcraftd script, made by Hellenion, to manage your *nix server!
  1. From here on out is roughly the same as on Windows. You can run ConfigGUI.exe to configure your server, and then either ServerGUI.exe OR ServerCLI.exe 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 config.xml manually with your favorite text editor. Detailed information about config.xml keys can be found here.

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 mozroots --import --ask-remove 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 --machine but this is not the default for a reason.)