msm/README.markdown

# Minecraft Server Manager [![Build Status](https://secure.travis-ci.org/marcuswhybrow/minecraft-server-manager.png?branch=master)](http://travis-ci.org/marcuswhybrow/minecraft-server-manager)

A single init script which makes running multiple Minecraft/Bukkit servers easier for us admins.

See the [installation page][wiki-install] to get started, or [visit the wiki][wiki] for the full list of resources.

[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=marcuswhybrow&url=https://github.com/marcuswhybrow/minecraft-server-manager&title=Minecraft%20Server%20Manager&language=en_GB&tags=github,minecraft,bukkit,init,init.d,linux,ubunut&category=software) 

## Features

As well as starting, stopping and restarting MSM has the following features:

* One script handles multiple servers, run two or more servers on one machine.
* Can create and start new servers with a single command, downloads the jars for you.
* Periodically makes [WorldEdit snapshot][we-snapshot] compatible backups of your worlds.
* Backup the entire server directory for complete protection.
* Load world's into RAM for faster access (reduces lag).
* Easily configurable global defaults, with per server overrides if needed.
* Apply server commands to one, multiple, or all servers in one go (useful for whitelisting a player on all servers.)
* Tab completion for all commands, makes everything faster and getting started a breeze.
* Keep server logs organsied by periodically "rolling" them.
* Organises jar files into groups (such as minecraft and craftbukkit) and links each server to a single jar. Includes automated download of new versions.
* Plethora of in-game commands (whitelist, blacklist, operator, gamemode, kick, say, time, toggledownfall, save)
* Send commands straight to the server via the command line.


## Upcomming features

* **QuickBackup:** If you store your backups non-locally (maybe on a NAS), QuickBackup optionally creates a backup locally for speed, and then moves it after your players are building again! My initial testing shows a 54 second network backup confaltes to 23 seconds of in-game time.
* **Restore:** Roll-back to an old world or whole server backup automatically.


## Versioning

MSM uses semantic version numbers to better describe what code one might have installed, and indicate backwards incompatible changes.

Releases will be numbered with the follow format:

`<major>.<minor>.<patch>`

And constructed with the following guidelines:

* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.


## Acknowledgements

This code grew out of an old version of [Ahtenus' Minecraft Init Script][ahtenus-minecraft-init].

[we-snapshot]: http://wiki.sk89q.com/wiki/WorldEdit/Snapshots
[ahtenus-minecraft-init]: https://github.com/Ahtenus/minecraft-init
[wiki]: https://github.com/marcuswhybrow/minecraft-server-manager/wiki
[wiki-install]: https://github.com/marcuswhybrow/minecraft-server-manager/wiki/Installation
Added Travis CI build status image to the README. 2012-06-06 00:50:29 +00:00			`# Minecraft Server Manager [![Build Status](https://secure.travis-ci.org/marcuswhybrow/minecraft-server-manager.png?branch=master)](http://travis-ci.org/marcuswhybrow/minecraft-server-manager)`
Updated the read me to reflect the Minecraft Server Manager approach. 2012-05-22 15:12:57 +00:00
			`A single init script which makes running multiple Minecraft/Bukkit servers easier for us admins.`
Initial (not tested, and most likely not working) files. Before this initial commit, I worked on the code in a github gist. The code in this commit comes from this gist commit: https://gist.github.com/2725916/ce58be848998aa93572f99e62f2e39e06db9463a 2012-05-19 16:50:22 +00:00
Updated the readme to reflect recent changes. 2012-05-31 10:50:54 +00:00			`See the [installation page][wiki-install] to get started, or [visit the wiki][wiki] for the full list of resources.`
Added a link to the github wiki, in the readme. 2012-05-29 06:05:10 +00:00
Added a Flattr button to the README. 2012-06-06 02:53:26 +00:00			`[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=marcuswhybrow&url=https://github.com/marcuswhybrow/minecraft-server-manager&title=Minecraft%20Server%20Manager&language=en_GB&tags=github,minecraft,bukkit,init,init.d,linux,ubunut&category=software)`

Initial (not tested, and most likely not working) files. Before this initial commit, I worked on the code in a github gist. The code in this commit comes from this gist commit: https://gist.github.com/2725916/ce58be848998aa93572f99e62f2e39e06db9463a 2012-05-19 16:50:22 +00:00			`## Features`

Updated the readme to reflect recent changes. 2012-05-31 10:50:54 +00:00			`As well as starting, stopping and restarting MSM has the following features:`

Updated the read me to reflect the Minecraft Server Manager approach. 2012-05-22 15:12:57 +00:00			`* One script handles multiple servers, run two or more servers on one machine.`
			`* Can create and start new servers with a single command, downloads the jars for you.`
			`* Periodically makes [WorldEdit snapshot][we-snapshot] compatible backups of your worlds.`
Updated the readme to reflect recent changes. 2012-05-31 10:50:54 +00:00			`* Backup the entire server directory for complete protection.`
Updated the read me to reflect the Minecraft Server Manager approach. 2012-05-22 15:12:57 +00:00			`* Load world's into RAM for faster access (reduces lag).`
Updated the readme to reflect recent changes. 2012-05-31 10:50:54 +00:00			`* Easily configurable global defaults, with per server overrides if needed.`
Updated the read me to reflect the Minecraft Server Manager approach. 2012-05-22 15:12:57 +00:00			`* Apply server commands to one, multiple, or all servers in one go (useful for whitelisting a player on all servers.)`
Updated the readme to reflect recent changes. 2012-05-31 10:50:54 +00:00			`* Tab completion for all commands, makes everything faster and getting started a breeze.`
			`* Keep server logs organsied by periodically "rolling" them.`
			`* Organises jar files into groups (such as minecraft and craftbukkit) and links each server to a single jar. Includes automated download of new versions.`
			`* Plethora of in-game commands (whitelist, blacklist, operator, gamemode, kick, say, time, toggledownfall, save)`
			`* Send commands straight to the server via the command line.`
Initial (not tested, and most likely not working) files. Before this initial commit, I worked on the code in a github gist. The code in this commit comes from this gist commit: https://gist.github.com/2725916/ce58be848998aa93572f99e62f2e39e06db9463a 2012-05-19 16:50:22 +00:00
Added versioning information to the readme. 2012-06-27 17:23:01 +00:00
Initial (not tested, and most likely not working) files. Before this initial commit, I worked on the code in a github gist. The code in this commit comes from this gist commit: https://gist.github.com/2725916/ce58be848998aa93572f99e62f2e39e06db9463a 2012-05-19 16:50:22 +00:00			`## Upcomming features`

Spelling mistake in README. 2012-05-31 09:27:07 +00:00			`* QuickBackup: If you store your backups non-locally (maybe on a NAS), QuickBackup optionally creates a backup locally for speed, and then moves it after your players are building again! My initial testing shows a 54 second network backup confaltes to 23 seconds of in-game time.`
Updated the readme to reflect recent changes. 2012-05-31 10:50:54 +00:00			`* Restore: Roll-back to an old world or whole server backup automatically.`
Initial (not tested, and most likely not working) files. Before this initial commit, I worked on the code in a github gist. The code in this commit comes from this gist commit: https://gist.github.com/2725916/ce58be848998aa93572f99e62f2e39e06db9463a 2012-05-19 16:50:22 +00:00
Added versioning information to the readme. 2012-06-27 17:23:01 +00:00
			`## Versioning`

			`MSM uses semantic version numbers to better describe what code one might have installed, and indicate backwards incompatible changes.`

			`Releases will be numbered with the follow format:`

			`<major>.<minor>.<patch>`

			`And constructed with the following guidelines:`

			`* Breaking backward compatibility bumps the major (and resets the minor and patch)`
			`* New additions without breaking backward compatibility bumps the minor (and resets the patch)`
			`* Bug fixes and misc changes bumps the patch`

			`For more information on SemVer, please visit http://semver.org/.`


Initial (not tested, and most likely not working) files. Before this initial commit, I worked on the code in a github gist. The code in this commit comes from this gist commit: https://gist.github.com/2725916/ce58be848998aa93572f99e62f2e39e06db9463a 2012-05-19 16:50:22 +00:00			`## Acknowledgements`

			`This code grew out of an old version of [Ahtenus' Minecraft Init Script][ahtenus-minecraft-init].`

Added a link to the github wiki, in the readme. 2012-05-29 06:05:10 +00:00			`[we-snapshot]: http://wiki.sk89q.com/wiki/WorldEdit/Snapshots`
			`[ahtenus-minecraft-init]: https://github.com/Ahtenus/minecraft-init`
Updated the readme to reflect recent changes. 2012-05-31 10:50:54 +00:00			`[wiki]: https://github.com/marcuswhybrow/minecraft-server-manager/wiki`
			`[wiki-install]: https://github.com/marcuswhybrow/minecraft-server-manager/wiki/Installation`