summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 255d9d46730f1fbbdd0459b118c7503183f7abfa (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
30
31
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.

After you've cloned the repository, you probably want 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`.

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/).

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)