summaryrefslogblamecommitdiffstats
path: root/README.md
blob: 5847cdd17fbb808286d9a51940efbe66629eede3 (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) [![Support via Gittip](http://img.shields.io/gittip/mcs_team.svg)](https://www.gittip.com/on/github/mc-server/) [![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 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
------------

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

 * [Linux and Raspberry Pi](http://ci.bearbin.net) (Bearbin's CI Server)
 * [Windows](http://mc-server.xoft.cz) (xoft's nightly build service)

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

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