cuberite-2a/README.md

MCServer [![Build Status](http://img.shields.io/travis/mc-server/MCServer.svg)](https://travis-ci.org/mc-server/MCServer) [![Support via Gittip](http://img.shields.io/gittip/on%2Fgithub%2Fmc-server.svg)](https://www.gittip.com/on/github/mc-server/) [![tip for next commit](http://tip4commit.com/projects/74.svg)](http://tip4commit.com/projects/74)
========

**Current Protocol Supported:** Minecraft v1.2 -> v1.7

MCServer is a performant C++ Minecraft server designed for use in memory and cpu-limited places, or just to make regular server perform better.

MCServer can run on PCs, Macs, and *nix. This includes android phones and tablets as well as Raspberry Pis. 

Installation
------------

To install MCServer, you can either download the repository and compile it, or download a pre-compiled version.

If you've cloned the repository using Git, you need to pull down the submodules (core plugins, some dependencies). This can be achieved with `git submodule init` and then on a regular basis (to keep up to date) `git submodule update`.

If you downloaded a ZIP file of the sources instead, you will need to download PolarSSL, too, from https://github.com/polarssl/polarssl , and unpack it into the `lib/polarssl` folder. You will also need to manually download all the plugins that you want included.

Compilation instructions are available in the COMPILING file.

Linux builds can be downloaded from [Bearbin's CI Service](http://ci.bearbin.net) and Windows builds from xoft's [nightly build service](http://mc-server.xoft.cz).

After you've extracted the files, simply run the MCServer executable.

Contributing
------------

MCServer is licensed under the Apache license V2, and we welcome anybody to fork and submit a Pull Request back with their changes, and if you want to join as a permanent member we can add you to the team.

Other Stuff
-----------

For other stuff, including plugins and discussion, check the [forums](http://forum.mc-server.org) and [wiki](http://wiki.mc-server.org/).

Earn bitcoins for commits or donate to reward the MCServer developers: [![tip for next commit](http://tip4commit.com/projects/74.svg)](http://tip4commit.com/projects/74)

Support Via Gittip: [![Support via Gittip](http://img.shields.io/gittip/on%2Fgithub%2Fmc-server.svg)](https://www.gittip.com/on/github/mc-server/)

Travis CI: [![Build Status](http://img.shields.io/travis/mc-server/MCServer.svg)](https://travis-ci.org/mc-server/MCServer)
Update README.md 2014-05-24 21:04:15 +00:00			`MCServer [![Build Status](http://img.shields.io/travis/mc-server/MCServer.svg)](https://travis-ci.org/mc-server/MCServer) [![Support via Gittip](http://img.shields.io/gittip/on%2Fgithub%2Fmc-server.svg)](https://www.gittip.com/on/github/mc-server/) [![tip for next commit](http://tip4commit.com/projects/74.svg)](http://tip4commit.com/projects/74)`
Added README 2013-07-27 11:01:12 +00:00			`========`

added supported protocol 2014-01-04 17:34:45 +00:00			`Current Protocol Supported: Minecraft v1.2 -> v1.7`

Added README 2013-07-27 11:01:12 +00:00			`MCServer is a performant C++ Minecraft server designed for use in memory and cpu-limited places, or just to make regular server perform better.`

			`MCServer can run on PCs, Macs, and *nix. This includes android phones and tablets as well as Raspberry Pis.`

			`Installation`
			`------------`

			`To install MCServer, you can either download the repository and compile it, or download a pre-compiled version.`

Added instructions for ZIP source downloads. The ZIP file doesn't contain git submodules, people complained about not being able to compile from it. 2014-01-29 18:10:59 +00:00			If you've cloned the repository using Git, you need to pull down the submodules (core plugins, some dependencies). This can be achieved with `git submodule init` and then on a regular basis (to keep up to date) `git submodule update`.

			If you downloaded a ZIP file of the sources instead, you will need to download PolarSSL, too, from https://github.com/polarssl/polarssl , and unpack it into the `lib/polarssl` folder. You will also need to manually download all the plugins that you want included.
Changed README so it knows about submodules 2013-08-16 11:43:56 +00:00
Added README 2013-07-27 11:01:12 +00:00			`Compilation instructions are available in the COMPILING file.`

Update README.md 2013-12-21 14:16:33 +00:00			`Linux builds can be downloaded from [Bearbin's CI Service](http://ci.bearbin.net) and Windows builds from xoft's [nightly build service](http://mc-server.xoft.cz).`
Added README 2013-07-27 11:01:12 +00:00
			`After you've extracted the files, simply run the MCServer executable.`

			`Contributing`
			`------------`

			`MCServer is licensed under the Apache license V2, and we welcome anybody to fork and submit a Pull Request back with their changes, and if you want to join as a permanent member we can add you to the team.`

Add README, fixes #1 2013-07-27 13:22:55 +00:00			`Other Stuff`
			`-----------`

Fix #506 2014-01-05 08:27:59 +00:00			`For other stuff, including plugins and discussion, check the [forums](http://forum.mc-server.org) and [wiki](http://wiki.mc-server.org/).`
Update READme a bit more 2013-11-02 21:10:54 +00:00
Updated README.md since MCServer development will continue even if people don't donate. 2013-11-02 21:22:30 +00:00			`Earn bitcoins for commits or donate to reward the MCServer developers: [![tip for next commit](http://tip4commit.com/projects/74.svg)](http://tip4commit.com/projects/74)`
update readme with travis info 2013-12-19 20:35:45 +00:00
Update README.md 2014-05-24 20:55:55 +00:00			`Support Via Gittip: [![Support via Gittip](http://img.shields.io/gittip/on%2Fgithub%2Fmc-server.svg)](https://www.gittip.com/on/github/mc-server/)`
Update README.md 2014-05-24 20:48:12 +00:00
Update README.md 2014-05-24 21:03:31 +00:00			`Travis CI: [![Build Status](http://img.shields.io/travis/mc-server/MCServer.svg)](https://travis-ci.org/mc-server/MCServer)`
Add a Bitdeli badge to README 2014-01-04 11:27:16 +00:00