Code Monkey home page Code Monkey logo

users-manual's Introduction

Cuberite

Jenkins 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; support for small embedded devices is experimental.

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

users-manual's People

Contributors

12xx12 avatar bearbin avatar bond-009 avatar madmaxoft avatar mathiascode avatar nichwall avatar nilspace avatar pdericson avatar safwathalaby avatar seadragon91 avatar tigerw avatar tooangel avatar williamhatcher avatar worktycho avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

users-manual's Issues

Downloadable book

I think the book should have a "download" button. It can be a simple zip with the web assets. (preferably with the analytics stripped out of the html page).

Css is returning 404

http://book.cuberite.org/css/main.css

You have requested a page or object that was not found on the server. This may be the result of a typo or broken link.

Please contact the site administrator for assistance.

If you are the site administrator:

    Make sure the requested file exists.
    Remember that our filesystem is case-sensitive.
    Enable and check the site's error log for more information.

What makes section 1.2 special?

My file browser insists on not detecting that section 1.2 is an html file. Why would that happen?

It has the same permissions and the same .html format as the others.

1

H3 and H4

We use <h3> and <h4> inconsistently. Which one should we pick?

Go to top.

Perhaps there should be a small "go to top" button beside each section. It makes it easy to go back to the #toc. It should be invisible in print.

Translation

Are there any plans to translate this book (after its completed)?

"Generated On"

The "Generated On" seems to always indicate the current date. I recall the book fetches git every 24 hours and so the date always updates, even when there are no new updates.

Add More Sections

  • Setting Up MCServer
  • Running MCServer
  • Configuring MCServer
    • World Settings
    • Other Settings
  • Plugins
    • Installing Plugins
    • Writing Plugins

Explain how permissions work

Currently it is only explained how you can give a player a rank. It isn't explained how to create ranks, and groups though. This should also be explained properly.

Document or link to explanation of world generation parameters

I've been setting up a cuberite server today and looked through the generator part of the world.ini file, which is mentioned but not at all explained in the manual.

Looking around in the cubrite repository I've been able to find a generator document which to me seems more like a detailed explantion of the system than an overview of what I can do there and which parameter effects what in game.

For example I'm looking for information on which parameters affect the size of biomes.

Best regards
Sascha

Repo merge rights

Can I have repo merge rights? It'll allow me to bother you less with every minor typo PRs. I'll not merge my own PRs for major changes.

Multiworlds

Basic setup of Cuberite does not involve Multiworlds, therefore #2.3 should not be in section 2. That part should be expanded and migrated into its own section, which should include both Bungeecord and non-Bungeecord methods of multiworld travel. I'll do that once my forum questions are answered.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.