1
0
Fork 0
Personal fork of Cuberite
Go to file
Jeffrey 59dbb37c9a
fix(docs): Correction of typos in project documentation (#5206)
2021-04-22 20:58:57 +00:00
.circleci Enable some more clang-tidy linter checks (#4738) 2020-05-14 22:15:35 +00:00
.github Update issue templates (#4960) 2020-10-01 23:20:10 +00:00
CMake Make Windows go brrrr, not tick. tick. tick. (#5201) 2021-04-21 16:07:48 +01:00
Server More cProtocol cleanup 2021-04-12 22:35:07 +01:00
Tools cIsThread cleanup 2021-03-29 23:36:15 +01:00
android Fix Android builds (#4998) 2020-10-15 09:35:44 +00:00
dev-docs dev-docs/Plugin API.md: fix url 2020-01-12 11:31:01 +00:00
lib Update the minimodules 2021-04-12 14:09:18 +01:00
src keeping the server from crashing (#5203) 2021-04-22 11:31:49 +00:00
tests Update entity sizes 2021-04-12 22:35:07 +01:00
.clang-format Enable some more clang-tidy linter checks (#4738) 2020-05-14 22:15:35 +00:00
.clang-tidy Enable some more clang-tidy linter checks (#4738) 2020-05-14 22:15:35 +00:00
.editorconfig .editorconfig fixes (#4113) 2017-12-26 21:14:37 +00:00
.gitattributes Added unit test for parsing HTTP request. 2016-03-01 16:19:57 +01:00
.gitignore Some emplace_back replacements (#5149) 2021-03-07 16:31:43 +00:00
.gitmodules Update the minimodules 2021-04-12 14:09:18 +01:00
.travis.yml Clang 7? 2021-02-11 01:24:50 +00:00
BACKERS Remove BountySource from funding sources 2020-08-10 20:16:02 +01:00
CMakeLists.txt Fix march=native not being enabled 2021-02-11 01:24:50 +00:00
COMPILING.md fix(docs): Correction of typos in project documentation (#5206) 2021-04-22 20:58:57 +00:00
CONTRIBUTING.md Upgrade to C++17 [CI] (#4716) 2020-05-09 13:56:39 +00:00
CONTRIBUTORS Thrown potions/enderpearls: cleanup 2021-04-12 22:35:07 +01:00
CheckLua.cmake Use system Lua, if available, to generate bindings. 2016-07-18 22:11:41 +02:00
Doxyfile Stop cFunctionRef constructor from disabling default copy constructor. (#4173) 2018-07-24 22:30:05 +01:00
GETTING-STARTED.md Upgrade to C++17 [CI] (#4716) 2020-05-09 13:56:39 +00:00
LICENSE Update Copyright year (#5165) 2021-03-26 20:29:23 +00:00
README.md Remove BountySource from funding sources 2020-08-10 20:16:02 +01:00
SetFlags.cmake Fix march=native not being enabled 2021-02-11 01:24:50 +00:00
TESTING.md fix(docs): Correction of typos in project documentation (#5206) 2021-04-22 20:58:57 +00:00
app.yml Update app.yml 2015-08-15 20:26:22 +02:00
appveyor.yml Fix AppVeyor IA32 builds (#5096) 2020-12-31 19:43:02 +00:00
clang-tidy.sh More CMake cleanup 2020-07-12 22:00:07 +01:00
cloc-exclude.txt cloc: Updated list of ignored files. (#4280) 2018-08-03 18:41:03 +01:00
compile.sh Fixed windows hack in Compile.sh (#4834) 2020-08-26 10:42:51 +00:00
easyinstall.sh Re-enable darwin download from easyinstall.sh script 2020-04-09 21:41:16 +01:00
jenkinsbuild.sh More tar incompatibility changes 2020-08-20 21:09:54 +00:00
stats.cmd Marked stats.cmd as executable so it can be run on linux 2013-12-21 11:04:21 +00:00
travisbuild.sh More CMake cleanup 2020-07-12 22:00:07 +01:00

README.md

Cuberite

Build Status Circle CI Build Status AppVeyor 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 Java Edition Minecraft client.

Cuberite runs on Windows, *nix and Android operating systems. This includes Android phones and tablets as well as Raspberry Pis.

Currently we support Release 1.8 - 1.12.2 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 website.
  • You can use the EasyInstall script for Linux and macOS, which automatically downloads the correct binary. The script is described below.

The EasyInstall script

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

curl -sSfL https://download.cuberite.org | sh

Compiling

  • You can compile automatically for Linux, macOS and FreeBSD 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.

Using curl:

sh -c "$(curl -sSfL -o - https://compile.cuberite.org)"

Or using wget:

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 plugin repository or 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 the Cuberite development team on Liberapay