summaryrefslogblamecommitdiffstats
path: root/README.md
blob: 0b1a6c443ef896e19429fd9d1bc88a07aa119d6e (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                                                                                                                                                                                                                                                                                                                        

        
                                                                                                                                                    
 
                                                                                                                                    
 
                                                                                
 


            
                                                                                                    
 

                                                  
 
                                                                                   
 
                                                                                                                                                                                                               





                                                                                                                                                                                                             
                                                                                                                         
 


           
                                                                                                                                                     
 
                                                                                                                                                                         
 
                                                                                                                                         
 
                                                                                                                           
 
MCServer [![Build Status](http://img.shields.io/travis/mc-server/MCServer.svg)](https://travis-ci.org/mc-server/MCServer) [![Coverity Scan Build Status](https://scan.coverity.com/projects/1930/badge.svg)](https://scan.coverity.com/projects/1930) [![tip for next commit](http://tip4commit.com/projects/74.svg)](http://tip4commit.com/projects/74)
========

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 Windows, *nix and Android operating systems. This includes Android phones and tablets as well as Raspberry Pis. 

We currently support Release 1.7 and 1.8 (not beta) Minecraft protocol versions.

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

Normally, you will want to download a pre-compiled version of MCServer from one of the buildservers:

 * [Windows and Linux](http://builds.cuberite.org)
 * [Raspberry Pi](http://builds.cuberite.org)

You simply need to download and extract these files before you can use the server. 

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 details.

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

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: [![tip for next commit](http://tip4commit.com/projects/74.svg)](http://tip4commit.com/projects/74)

Support Us on Gratipay: [![Support via Gratipay](http://img.shields.io/gittip/cuberite_team.svg)](https://www.gratipay.com/cuberite_team)

Travis CI: [![Build Status](http://img.shields.io/travis/mc-server/MCServer.svg)](https://travis-ci.org/mc-server/MCServer)