1
0
Fork 0
Personal fork of Cuberite
Go to file
Zaoqi ab82bf07c8 dev-docs/Plugin API.md: fix url 2020-01-12 11:31:01 +00:00
.circleci Circle 2.0: Use workspace instead of cache (#4291) 2018-08-25 12:40:10 +01:00
.github Add sponsor button 2019-11-28 13:24:20 +01:00
Server Added temporary block type mapping for 1.13+ protocols. 2020-01-07 06:53:17 +01:00
Tools BlockTypePalette: Load from TSV or original reports' JSON. 2019-12-28 22:43:35 +01:00
android Bump Android API to min supported 2020-01-03 02:40:26 +02:00
dev-docs dev-docs/Plugin API.md: fix url 2020-01-12 11:31:01 +00:00
lib Updated Lua submodules 2019-12-30 15:20:39 +01:00
src Added temporary block type mapping for 1.13+ protocols. 2020-01-07 06:53:17 +01:00
tests BlockTypePalette: Load from TSV or original reports' JSON. 2019-12-28 22:43:35 +01:00
.clang-tidy Use clang-tidy to check more code conventions (#4214) 2018-05-06 18:07:34 +01: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 Improved CMake generator (#4365) 2019-08-10 13:15:51 +02:00
.gitmodules Add ProtocolBlockTypePalette (#4391) 2019-09-22 22:57:54 +02:00
.travis.yml Output the binaries into a per-configuration Server subfolder. (#4440) 2019-12-28 12:53:37 +01:00
BACKERS Output the binaries into a per-configuration Server subfolder. (#4440) 2019-12-28 12:53:37 +01:00
CIbuild.sh Output the binaries into a per-configuration Server subfolder. (#4440) 2019-12-28 12:53:37 +01:00
CMakeLists.txt Updated LibEvent to release 2.1.11-stable. (#4383) 2019-09-04 22:34:54 +01:00
COMPILING.md Fix Travis build (#4101) 2017-12-22 18:25:46 +00:00
CONTRIBUTING.md Clarify spaces vs unary operator 2019-09-17 17:33:11 +01:00
CONTRIBUTORS Support swap item between main hand and offhand by press key "F" (#4241) 2018-06-24 10:24:10 +01: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 Stop cFunctionRef constructor from disabling default copy constructor. (#4173) 2018-07-24 22:30:05 +01:00
GETTING-STARTED.md Minor changes (#3909) 2017-08-24 11:19:40 +02:00
LICENSE WebAdmin improvements (#4433) 2019-12-28 02:15:12 +02:00
README.md Removed old buildserver from README 2020-01-04 14:21:58 +00:00
SetFlags.cmake Support clang 10.0 (appleclang) and higher (#4302) 2018-10-15 17:56:23 +01:00
TESTING.md Minor changes (#3909) 2017-08-24 11:19:40 +02:00
app.yml Update app.yml 2015-08-15 20:26:22 +02:00
appveyor.yml Skip release builds outside master (#4447) 2019-12-31 09:40:45 +02:00
clang-tidy.sh Move to CircleCI-2.0 (#4225) 2018-08-25 11:25:21 +01:00
cloc-exclude.txt cloc: Updated list of ignored files. (#4280) 2018-08-03 18:41:03 +01:00
compile.sh Update submodule's url in compile (#4204) 2018-04-02 18:44:17 +01:00
easyinstall.sh Improved easyinstall.sh to support macOS and FreeBSD (#3557) 2017-02-13 21:36:23 +01: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 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 Us on Liberapay or Bountysource