diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 15 insertions, 14 deletions
@@ -1,38 +1,39 @@ -MCServer +MCServer [](https://travis-ci.org/mc-server/MCServer) [](https://www.gittip.com/on/github/mc-server/) [](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 is a Minecraft server that is written in C++ and designed to be efficient with memory and CPU, as well as having a flexible Lua Plugin API. MCServer can run on PCs, Macs, and *nix. This includes android phones and tablets as well as Raspberry Pis. +We currently support the protocol from Minecraft 1.2 all the way up to Minecraft 1.7.9. + 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`. +Normally, you will want to download a pre-compiled version of MCServer from one of the buildservers: -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. + * [Linux and Raspberry Pi](http://ci.bearbin.net) (Bearbin's CI Server) + * [Windows](http://mc-server.xoft.cz) (xoft's nightly build service) -Compilation instructions are available in the COMPILING file. +You simply need to download and extract these files before you can use the server. -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. +If you're a more advanced user, you may want to compile the server yourself for more performance. See the [COMPILING.md](https://github.com/mc-server/MCServer/blob/master/COMPILING.md) file for more details. 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. +Check out the [CONTRIBUTING.md](https://github.com/mc-server/MCServer/blob/master/CONTRIBUTING.md) file for more infos. + Other Stuff ----------- -For other stuff, including plugins and discussion, check the [forums](http://forum.mc-server.org) and [wiki](http://wiki.mc-server.org/). +For other stuff, including plugins and discussion, check the [forums](http://forum.mc-server.org) and [Plugin API](http://mc-server.xoft.cz/LuaAPI/). Earn bitcoins for commits or donate to reward the MCServer developers: [](http://tip4commit.com/projects/74) -Travis CI: [](https://travis-ci.org/mc-server/MCServer) +Support Via Gittip: [](https://www.gittip.com/on/github/mc-server/) + +Travis CI: [](https://travis-ci.org/mc-server/MCServer) |