1
0
Fork 0
Personal fork of Cuberite
Go to file
Tiger Wang b9609c3b76 Documented steps for compilation
As requested by @madmaxoft.
2016-12-12 14:32:32 +00:00
.github Added Server OS section pr template (#3254) 2016-07-06 23:37:49 +03:00
Install Added BACKERS to list of files in Windows build 2016-02-19 18:11:30 +02:00
Server Fix meta mirror (#3470) 2016-12-09 12:29:04 +01:00
Tools NoiseSpeedTest: use a single templatized function. 2016-11-15 22:52:03 +01:00
android Documented steps for compilation 2016-12-12 14:32:32 +00:00
docs added Grown visualizer to the Generator documentation 2016-06-24 13:36:25 +02:00
lib Use CMake's Android generators to crosscompile 2016-12-12 14:32:32 +00:00
src Use CMake's Android generators to crosscompile 2016-12-12 14:32:32 +00:00
tests Added strict static_cast to void * in printf. 2016-11-13 17:26:58 +01:00
.gitattributes Added unit test for parsing HTTP request. 2016-03-01 16:19:57 +01:00
.gitignore Added API export for LuaCheck. 2016-11-22 18:25:49 +01:00
.gitmodules Added ignore=dirty to new submodules 2015-11-05 19:35:42 +01:00
.travis.yml Use .travis.yml to whitelist coverity_scan for push builds. 2015-11-08 21:20:55 +00:00
CIbuild.sh CI: API test defaults to failure, unless explicitly succeeded. 2016-10-25 18:49:58 +02:00
CMakeLists.txt Use CMake's Android generators to crosscompile 2016-12-12 14:32:32 +00:00
COMPILING.md Documented steps for compilation 2016-12-12 14:32:32 +00:00
CONTRIBUTING.md Added more information about contributing to Cuberite 2016-02-26 21:18:13 +01:00
CONTRIBUTORS Added support for the Minecraft 1.10 protocol(#210) (#3348) 2016-09-02 20:22:06 +03:00
CheckLua.cmake Use system Lua, if available, to generate bindings. 2016-07-18 22:11:41 +02:00
CoverityModel.cpp Update CoverityModel.cpp 2014-04-27 13:03:34 -07:00
Doxyfile Minor update 2016-02-02 23:16:44 +02:00
GETTING-STARTED.md Added testing instructions 2016-02-19 15:41:24 +02:00
LICENSE Minor update 2016-02-02 23:16:44 +02:00
README.md Canonical tag (#3300) 2016-08-07 09:06:44 +02:00
SetFlags.cmake Documented steps for compilation 2016-12-12 14:32:32 +00:00
TESTING.md Added testing instructions 2016-02-19 15:41:24 +02:00
app.yml Update app.yml 2015-08-15 20:26:22 +02:00
appveyor.yml Revert "Redstone fixes" 2016-07-29 07:56:50 +02:00
circle.yml CircleCI: Check for missing Bindings dependencies 2016-07-02 00:30:22 +02:00
cloc-exclude.txt Update cloc-exclude.txt 2013-12-21 10:01:05 +00:00
compile.sh compile.sh rewrite. Commandline arguments and more. (#3255) 2016-08-04 18:37:47 +03:00
easyinstall.sh Added compile.sh folder check warnings 2016-08-04 18:51:12 +03:00
stats.cmd Marked stats.cmd as executable so it can be run on linux 2013-12-21 11:04:21 +00:00
uploadCoverage.sh Renamed output directory to Server 2015-09-05 22:01:21 +02:00

README.md

Cuberite Build Status Coverity Scan Build Status

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.8 and 1.9 Minecraft protocol versions.

Subscribe to the newsletter for important updates and project news.

Installation

There are several ways to obtain Cuberite.

Binaries

  • The easiest method is downloading for Windows or Linux from the Project site.
  • You can use the EasyInstall script for Linux, which automatically downloads the correct binary. The script is described below.
  • You can also obtain a binary from the buildserver archive.
The EasyInstall script

This Linux script will download the correct binary from the project site.

sh -c "$(wget -O - https://download.cuberite.org)"

Compiling

  • You can compile automatically for Linux / *nix with the compile.sh script. The script is described below.
  • You can also compile manually. See COMPILING.md.

Compiling may provide better performance (1.5-3x as fast) and it supports more operating systems.

The compile.sh script

This script downloads the source code and compiles it. The script is smart enough to notify you of missing dependencies and instructing you on how to install them. The script doesn't work for Windows.

sh -c "$(wget -O - https://compile.cuberite.org)"

Hosted services

  • Hosted Cuberite is available via Gamocosm.

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.

Cuberite is developed in C++ and Lua. To contribute code, please check out GETTING-STARTED.md and CONTRIBUTING.md for more details.

Plugins are written in Lua. You can contribute by developing plugins and submitting them to the forum. Please check out our plugin introduction guide for more info.

If you are not a programmer, you can help by testing Cuberite and reporting bugs. See TESTING.md for details.

You can also help with documentation by contributing to the User's Manual.

Other Stuff

For other stuff, check out the homepage, the Users' Manual, the forums, and the Plugin API.

Support Us on Bountysource

Travis CI: travis build status shield