1
0
cuberite-2a/README.md

49 lines
2.9 KiB
Markdown
Raw Normal View History

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)
2013-07-27 07:01:12 -04:00
========
2015-06-11 12:32:49 -04: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.
2013-07-27 07:01:12 -04:00
2015-06-11 12:32:49 -04:00
Cuberite can run on Windows, *nix and Android operating systems. This includes Android phones and tablets as well as Raspberry Pis.
2013-07-27 07:01:12 -04:00
2014-10-11 12:17:22 -04:00
We currently support Release 1.7 and 1.8 (not beta) Minecraft protocol versions.
2015-05-15 14:01:13 -04:00
Subscribe to [the newsletter](http://newsletter.cuberite.org/subscribe.htm) for important updates and project news.
2013-07-27 07:01:12 -04:00
Installation
------------
2015-06-30 02:00:10 -04: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.
2014-11-01 12:00:44 -04:00
2014-10-11 16:54:24 -04:00
For Linux there is an easy installation method, just run this in your terminal:
2013-07-27 07:01:12 -04:00
2015-06-11 12:32:49 -04:00
curl -s https://raw.githubusercontent.com/cuberite/cuberite/master/easyinstall.sh | sh
2013-07-27 07:01:12 -04:00
For Windows, you just need to download a file and extract it:
2015-06-11 12:32:49 -04: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)
2015-05-24 05:30:22 -04:00
For other operating systems you need to download and compile yourself. This can be done either manually, or with this automatic script:
2015-06-11 12:32:49 -04:00
bash -c "$(wget -O - https://raw.githubusercontent.com/cuberite/cuberite/master/compile.sh)"
2015-05-24 05:30:22 -04:00
There is also an archive of binary builds on the buildserver: http://builds.cuberite.org
2015-06-11 12:32:49 -04: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.
2013-07-27 07:01:12 -04:00
Contributing
------------
2015-06-11 12:32:49 -04: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.
2013-07-27 07:01:12 -04:00
2015-06-11 12:32:49 -04:00
Check out the [CONTRIBUTING.md](https://github.com/cuberite/cuberite/blob/master/CONTRIBUTING.md) file for more details.
2014-05-25 05:21:58 -04:00
2013-07-27 09:22:55 -04:00
Other Stuff
-----------
2015-06-11 12:32:49 -04: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).
2013-12-19 15:35:45 -05:00
[Support Us on Bountysource](https://bountysource.com/teams/cuberite)
2014-05-24 16:48:12 -04:00
2015-06-11 12:32:49 -04:00
Travis CI: [![travis build status shield](http://img.shields.io/travis/cuberite/cuberite.svg)](https://travis-ci.org/cuberite/cuberite)
2014-01-04 06:27:16 -05:00