summaryrefslogtreecommitdiffstats
path: root/README.md
blob: e9b1f14e7bf8751a84e6960b9625cb1f86b1f2a3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
MCServer
========

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 are cloning the repository, you are required to recursively download the submodules also with `git clone -r`. When pulling, you should use `git pull --recurse-submodules`. You might want to set the base forms as aliases to these.

Compilation instructions are available in the COMPILING file.

Linux builds can be downloaded from [the Berboe CI server](http://ci.berboe.co.uk) and windows 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://mc-server.org/wiki/).