A Minecraft Server wrapper for POSIX compatible operating systems (OSX, Linux, BSD, etc). This enables a Minecraft server admin to easily start and stop their server, send commands and also do safe, automatic world data backups.
I'm MC Wrapper and I'm here to say that I wanna wrap up minecraft so everything'll be okay.
Getting up and running with mcwrapper is easier than ever. Provided you have git installed:
- cd into the directory with minecraft_server.jar in it.
- git clone git://github.com/spikegrobstein/mcwrapper.git
- cd mcwrapper
- ./mcwrapper start
If you don't have git:
- download a zip or tarball of the latest version of mcwrapper from https://github.com/spikegrobstein/mcwrapper
- unzip/untar it
- rename resulting directory to 'mcwrapper'
- copy resulting 'mcwrapper' directory into the same directory as minecraft_server.jar.
- cd into the 'mcwrapper' directory
- ./mcwrapper start
The above will start up a Minecraft server instance using default settings. All support files related to mcwrapper will be stored in this new mcwrapper directory. Updating to the latest version is as easy as cd'ing into the mcwrapper directory and typing git pull
Basic usage is:
./mcwrapper <action> [ <action_params> ]
Use the help action to see a full breakdown of usage:
./mcwrapper help
See the Configuration section below for instructions on modifying the default configuration.
As seen above, you can start the server by running the following:
./mcwrapper start
The Minecraft server will be started in the background. You can then execute arbitrary commands to the server using the command action. The command action is also aliased as cmd:
./mcwrapper cmd op spizzike
./mcwrapper cmd say hi
./mcwrapper cmd save-all
./mcwrapper cmd save-off
./mcwrapper cmd save-on
If you'd like to stop the server, issue the following command:
./mcwrapper stop
You can also find out whether the server is running:
./mcwrapper status
The status action will return 0 if the server is running or 1 if it's stopped.
There is also support for reading information about the running configuration for cases where an external script may want to interact with Minecraft or mcwrapper. Example:
./mcwrapper config serverpath
The above will output the path to the minecraft_server.jar file that it will wrap. All config commands can be run whether mcwrapper is running a server or not. A bug currently exists where if mcwrapper cannot locate the minecraft_server.jar, no commands will work.
mcwrapper comes with a set of convenience scripts for the commandline-impared user. These scripts can be run by double-clicking them in OSX or Linux and will execute the specified command. The scripts should not be moved outside of that directory or they will not work.
Although mcwrapper has a built-in default configuration, there are times when you may want to have it operate slightly differently. mcwrapper is bundled with an example mcwrapper.conf example file called mcwrapper.conf-example. See that file for full configuration documentation.
When running, mcwrapper uses 2 files:
- mcwrapper.pid -- the pid of the currently running process. This is used by
mcwrapperfor sanity checks but can also be used by 3rd party scripts to see if minecraft_server is running. - command_input -- the FIFO used for communicating with the server.
The names and locations of the above files are both configurable in mcwrapper.conf.
You can run arbitrary commands either through the mcwrapper script as seen in the Quickstart or you can output commands directly to the command_input FIFO. This is handy if you write re-usable Minecraft scripts.
Examples of working directly with the FIFO:
echo "tell spizzike you are awesome" > command_input
If you have a file called "gimmie_diamond.mcs" containing the following text:
give spizzike 264
give spizzike 264
give spizzike 264
give spizzike 264
give spizzike 264
give spizzike 264
You can run that all through the Minecraft server with the following command:
command_input < gimmie_diamond.mcs
Since it's not safe to back up the world data while the server is running, you need to force a save, then disable writing world data to disk during a backup.
mcwrapper contains a backup action for just this purpose. To back up your current world data directory, run the following command:
./mcwrapper backup
mcwrapper will read your server.properties file to learn the location of your world data and, after flushing anything in memory, creates a timestamped directory in the minecraft server directory and creates a symlink to the latest backup called latest.
By default, the backup action will simply copy your world data and server configuration (white lists, server.properties, ban lists, etc) into the backups directory, but it can be configured to zip or tgz the backup data. See mcwrapper.conf-example for information on this.
Assuming your mcwrapper lives in /usr/local/minecraft/mcwrapper, backup will do the following:
- create
/usr/local/minecraft/backups/YYYYMMDDHHMMSSwhere YYYYMMDDHHMMSS is the current timestamp - copy
/usr/local/minecraft/worldand any other configuration data in/usr/local/minecraftinto the above directory - create a symlink to the latest backup at
/usr/local/minecraft/backups/latest - delete old backups. Defaults to keeping the latest 5.
The name of the latest backup can be configured by editing that setting in mcbackup. You can also configure how many previous backups are kept. Again, see mcwrapper.conf-example for information on doing this.
In the future I aim to create sysV init scripts for Linux (Ubuntu flavoured) and OSX launchd configs. I also plan on including Minecraft backup support to SnapBackup, my backup script (http://github.com/spikegrobstein/snapbackup).
I also hope to create a configuration wizard for the most common configuration options as well as build a robust installer script to get you started.
Also need to come up with a way to restore a backup of a minecraft world.
mcwrapper is written by Spike Grobstein [email protected]
http://sadistech.com
http://spike.grobste.in
http://github.com/spikegrobstein