1
0
cuberite-2a/README.md

49 lines
3.1 KiB
Markdown
Raw Normal View History

2015-06-11 12:03:53 -04:00
MCServer [![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) [![weekly tips](http://img.shields.io/gratipay/cuberite_team.svg?style=flat)](http://gratipay.com/cuberite_team)
2013-07-27 07:01:12 -04:00
========
2015-05-15 14:01:13 -04:00
MCServer 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. MCServer is compatible with the vanilla Minecraft client.
2013-07-27 07:01:12 -04:00
2014-10-11 12:17:22 -04:00
MCServer 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-01-24 10:48:30 -05:00
Hosted MCServer is available DIY on DigitalOcean: [![Install on DigitalOcean](http://doinstall.bearbin.net/button.svg)](http://doinstall.bearbin.net/install?url=https://github.com/mc-server/MCServer) and [Gamososm](https://gamocosm.com) also offers MCServer 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
2014-10-31 09:43:15 -04:00
curl -s https://raw.githubusercontent.com/mc-server/MCServer/master/easyinstall.sh | sh
2013-07-27 07:01:12 -04:00
For Windows, you just need to download a file and extract it:
- [Windows 32 bit](http://builds.cuberite.org/job/MCServer%20Windows%20x86/lastSuccessfulBuild/artifact/Install/MCServer.zip)
- [Windows 64 bit](http://builds.cuberite.org/job/MCServer%20Windows%20x64/lastSuccessfulBuild/artifact/Install/MCServer.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:
bash -c "$(wget -O - https://raw.githubusercontent.com/mc-server/MCServer/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/mc-server/MCServer/blob/master/COMPILING.md) file for more details.
2013-07-27 07:01:12 -04:00
Contributing
------------
2014-10-11 12:19:08 -04:00
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.
2013-07-27 07:01:12 -04:00
2014-05-26 07:29:45 -04:00
Check out the [CONTRIBUTING.md](https://github.com/mc-server/MCServer/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
-----------
For other stuff, including plugins and discussion, check out the [forums](http://forum.mc-server.org) and [Plugin API](http://mc-server.xoft.cz/LuaAPI/).
2013-12-19 15:35:45 -05:00
2014-10-05 14:46:53 -04:00
Support Us on Gratipay: [![Support via Gratipay](http://img.shields.io/gittip/cuberite_team.svg)](https://www.gratipay.com/cuberite_team)
2014-05-24 16:48:12 -04:00
2014-05-24 17:03:31 -04:00
Travis CI: [![Build Status](http://img.shields.io/travis/mc-server/MCServer.svg)](https://travis-ci.org/mc-server/MCServer)
2014-01-04 06:27:16 -05:00