cuberite-2a/README.md

Cuberite [![Build Status](http://img.shields.io/travis/cuberite/cuberite/master.svg?style=flat)](https://travis-ci.org/cuberite/cuberite) [![Coverity Scan Build Status](https://img.shields.io/coverity/scan/1930.svg)](https://scan.coverity.com/projects/1930)
========

Cuberite is a Minecraft-compatible multiplayer game server that is written in C++ and designed to be efficient with memory and CPU, as well as having a flexible Lua Plugin API. Cuberite is compatible with the vanilla Minecraft client.

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

Subscribe to [the newsletter](http://newsletter.cuberite.org/subscribe.htm) for important updates and project news.

Installation
------------
Hosted Cuberite is available DIY on DigitalOcean: [![Install on DigitalOcean](http://doinstall.bearbin.net/button.svg)](http://doinstall.bearbin.net/install?url=https://github.com/cuberite/cuberite) and [Gamocosm](https://gamocosm.com) also offers Cuberite support.

For Linux there is an easy installation method, just run this in your terminal:

    curl -s https://raw.githubusercontent.com/cuberite/cuberite/master/easyinstall.sh | sh

For Windows, you just need to download a file and extract it:

 - [Windows 32 bit](http://builds.cuberite.org/job/Cuberite%20Windows%20x86%20Master/lastSuccessfulBuild/artifact/Install/Cuberite.zip)
 - [Windows 64 bit](http://builds.cuberite.org/job/Cuberite%20Windows%20x64%20Master/lastSuccessfulBuild/artifact/Install/Cuberite.zip)

For other operating systems you need to download and compile yourself. This can be done either manually, or with this automatic script:

    bash -c "$(wget -O - https://raw.githubusercontent.com/cuberite/cuberite/master/compile.sh)"

There is also an archive of binary builds on the buildserver: http://builds.cuberite.org

Compiling the server yourself has other benefits: you may get better performance performance (1.5-3x as fast) and it supports more operating systems. See the [COMPILING.md](https://github.com/cuberite/cuberite/blob/master/COMPILING.md) file for more details.

Contributing
------------

Cuberite 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/cuberite/cuberite/blob/master/CONTRIBUTING.md) file for more details.

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

For other stuff, including plugins and discussion, check out the [forums](http://forum.mc-server.org) and [Plugin API](http://api-docs.cuberite.org).

[Support Us on Bountysource](https://bountysource.com/teams/cuberite)

Travis CI: [![travis build status shield](http://img.shields.io/travis/cuberite/cuberite.svg)](https://travis-ci.org/cuberite/cuberite)
Removed mentions of Gratipay, replaced with Bountysource. 2015-11-01 15:18:51 +00:00			`Cuberite [![Build Status](http://img.shields.io/travis/cuberite/cuberite/master.svg?style=flat)](https://travis-ci.org/cuberite/cuberite) [![Coverity Scan Build Status](https://img.shields.io/coverity/scan/1930.svg)](https://scan.coverity.com/projects/1930)`
Added README 2013-07-27 11:01:12 +00:00			`========`

Name change updates. 2015-06-11 16:32:49 +00:00			`Cuberite is a Minecraft-compatible multiplayer game server that is written in C++ and designed to be efficient with memory and CPU, as well as having a flexible Lua Plugin API. Cuberite is compatible with the vanilla Minecraft client.`
Added README 2013-07-27 11:01:12 +00:00
Name change updates. 2015-06-11 16:32:49 +00:00			`Cuberite can run on Windows, *nix and Android operating systems. This includes Android phones and tablets as well as Raspberry Pis.`
Added README 2013-07-27 11:01:12 +00:00
Fixes. 2014-10-11 16:17:22 +00:00			`We currently support Release 1.7 and 1.8 (not beta) Minecraft protocol versions.`
Updated the installation instructions in the README. 2014-05-25 09:03:53 +00:00
Newsletter, content tweak. 2015-05-15 18:01:13 +00:00			`Subscribe to [the newsletter](http://newsletter.cuberite.org/subscribe.htm) for important updates and project news.`

Added README 2013-07-27 11:01:12 +00:00			`Installation`
			`------------`
Fixed typos in the readme. 2015-06-30 06:00:10 +00:00			`Hosted Cuberite is available DIY on DigitalOcean: [![Install on DigitalOcean](http://doinstall.bearbin.net/button.svg)](http://doinstall.bearbin.net/install?url=https://github.com/cuberite/cuberite) and [Gamocosm](https://gamocosm.com) also offers Cuberite support.`
Added DO easy-install 2014-11-01 16:00:44 +00:00
Update README.md 2014-10-11 20:54:24 +00:00			`For Linux there is an easy installation method, just run this in your terminal:`
Added README 2013-07-27 11:01:12 +00:00
Name change updates. 2015-06-11 16:32:49 +00:00			`curl -s https://raw.githubusercontent.com/cuberite/cuberite/master/easyinstall.sh \| sh`
Added README 2013-07-27 11:01:12 +00:00
Added a guide to the easy install method. 2014-10-11 20:40:32 +00:00			`For Windows, you just need to download a file and extract it:`

Name change updates. 2015-06-11 16:32:49 +00:00			`- [Windows 32 bit](http://builds.cuberite.org/job/Cuberite%20Windows%20x86%20Master/lastSuccessfulBuild/artifact/Install/Cuberite.zip)`
			`- [Windows 64 bit](http://builds.cuberite.org/job/Cuberite%20Windows%20x64%20Master/lastSuccessfulBuild/artifact/Install/Cuberite.zip)`
Added a guide to the easy install method. 2014-10-11 20:40:32 +00:00
Easy compile script 2015-05-24 09:30:22 +00:00			`For other operating systems you need to download and compile yourself. This can be done either manually, or with this automatic script:`

Name change updates. 2015-06-11 16:32:49 +00:00			`bash -c "$(wget -O - https://raw.githubusercontent.com/cuberite/cuberite/master/compile.sh)"`
Easy compile script 2015-05-24 09:30:22 +00:00
			`There is also an archive of binary builds on the buildserver: http://builds.cuberite.org`
Added a guide to the easy install method. 2014-10-11 20:40:32 +00:00
Name change updates. 2015-06-11 16:32:49 +00:00			`Compiling the server yourself has other benefits: you may get better performance performance (1.5-3x as fast) and it supports more operating systems. See the [COMPILING.md](https://github.com/cuberite/cuberite/blob/master/COMPILING.md) file for more details.`
Added README 2013-07-27 11:01:12 +00:00
			`Contributing`
			`------------`

Name change updates. 2015-06-11 16:32:49 +00:00			`Cuberite 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.`
Added README 2013-07-27 11:01:12 +00:00
Name change updates. 2015-06-11 16:32:49 +00:00			`Check out the [CONTRIBUTING.md](https://github.com/cuberite/cuberite/blob/master/CONTRIBUTING.md) file for more details.`
Update README.md 2014-05-25 09:21:58 +00:00
Add README, fixes #1 2013-07-27 13:22:55 +00:00			`Other Stuff`
			`-----------`

Name change updates. 2015-06-11 16:32:49 +00:00			`For other stuff, including plugins and discussion, check out the [forums](http://forum.mc-server.org) and [Plugin API](http://api-docs.cuberite.org).`
update readme with travis info 2013-12-19 20:35:45 +00:00
Removed mentions of Gratipay, replaced with Bountysource. 2015-11-01 15:18:51 +00:00			`[Support Us on Bountysource](https://bountysource.com/teams/cuberite)`
Update README.md 2014-05-24 20:48:12 +00:00
Name change updates. 2015-06-11 16:32:49 +00:00			`Travis CI: [![travis build status shield](http://img.shields.io/travis/cuberite/cuberite.svg)](https://travis-ci.org/cuberite/cuberite)`
Add a Bitdeli badge to README 2014-01-04 11:27:16 +00:00