Giter Club home page Giter Club logo

cuberite.github.io'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

cuberite.github.io's People

Contributors

12xx12 avatar archshift avatar bearbin avatar madmaxoft avatar mathias-gh avatar mathiascode avatar nilspace avatar qaisjp avatar safwathalaby avatar tigerw avatar wbrbr avatar williamhatcher avatar worktycho avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cuberite.github.io's Issues

Newsletter system

How does the newsletter system work? Are newletters sent out automatically each week, or are they manually written? I registered my email address on October 27, but I haven't received any emails apart from the confirmation email.

Mirroring news

I think that every news announcement should be mirrored at the forum announcement section to encourage discussion. A link from the cuberite website to the relevant forum announcement would be nice.

Brighter color scheme

The site looks way too dark after I corrected the contrast of my screen (you can't even see the hover effect on buttons well), and others have requested a change as well.

I suggested a green color scheme in this thread (because green is fresh, other server projects don't use the color, and Cuberite's colored icon contains green :P): http://forum.mc-server.org/showthread.php?tid=2049&pid=23155

We'll keep the dark color scheme.

Moving the manual to this repository

I suggest moving the user's manual to this repository, because

  • It's easy to integrate it with the website design
  • Better-looking URL on the main domain (http://cuberite.org/manual/)
  • GitHub Pages CDN
  • Markdown support

With the help of Jekyll, we can keep the file structure quite similar to the current user's manual: https://github.com/mathias-github/cuberite-redesign-final/tree/gh-pages/manual

The final site looks something like this: http://final.cuberite.ga/manual/ (it's unfinished, there is no specific CSS for the user's manual yet) (we could also enable multiple pages instead of one)

Important content below the fold.

selection_001

There is more than enough space on my 1080p screen to have the benefits and bottom bar above the fold, and having them below is bad for user experience.

Download button hovering problems

Something is wrong with the download buttons.
When hovering over a download button, a menu appears with 32/64 bit choices.
When moving the mouse down to click one of those choices, the menu disappers.

This does not always happen, it happens when you move past a certain speed. My hypothesis there's a "dead area" between e.g. the "Linux" button and the "32 bit" button, and hovering over that dead area hides the menu, but moving the mouse fast enough skips that dead area.

HTTPS on API docs

Currently we have HTTPS activated on all of our domains except for the API docs. We should activate HTTPS on there at some point.

Add a banner to advertise the meetup

Okay, by the looks of it, the meeting will happen at the end of February from the 19th to the 21th. "Registrations" to the meetup are just for statistics, so that I can see how many of you will come: http://doodle.com/poll/ywaucxvcyzstt36z

The location is mentioned in the Doodle poll. It's a local hackerspace.

โ€“ taken from the forum

Link to GitHub not obvious enough.

There is not enough emphasis placed on the link through to our github repo. This is important to attract new contributors so we should make it more prominent.

Get rid of long welcome text

We should really focus on the core features of Cuberite.

Performant. Configurable. Extensible.

or

Performant. Configurable. Extensible. Free.

Remove "1.7" from the homepage

I think we should keep support for 1.7 for now, but don't tell new visitors that we support it. Cuberite is very unstable in 1.7 at this point (new 1.8 mobs cause client crashes on first join, right clicking/placing blocks doesn't work etc.).

Mention RaspberryPi

Many people are here for the Raspberry. Beginners reaching the homepage don't know that the proper raspberryPi download is "ARMv6". I think that the text should be modified to. ARMv6 (Including Raspberry Pis), or something similar.

Status of donations

There has been some discussion about Gratipay being broken. Is there another place to make donations at currently, should the donation references be removed completely, or something else?

Keep IRC link or not

Should we keep promoting the IRC channel in the website footer? Every now and then a new user asks a question there, but doesn't receive an answer since devs don't use IRC very often.

Remove old font formats

I think we can remove a few old font formats, such as .eot and .svg, since they aren't needed in modern browsers.

  • .eot is only required by IE 8 and below, which is very old
  • .svg was used many years ago by old mobile browsers such as Safari 4.1

By removing these, we will reduce the amount of files and code.

Button arrangement

In my humble opinion, in order to maximize UX, the following buttons should be:

  • Literally 1 click away.
  • Visible without scrolling to footer.

The buttons are:

  • Forum
  • Manual
  • Plugins
  • The download buttons
  • Contribute
  • Compile

Currently, Forum and Manual do not meet the above criteria. I think this can be achieved by making the following changes:

Top bar:
Home, Forum, Manual, Plugins, Support, contribute (Removed Discuss, blog, added forum, manual)

Just below the Windows download buttons:
Compile Cuberite, Github Repo (Unchanged)

Footer: (These don't have to meet the above criteria since they are less important)
Donate, IRC, Newsletter, Api Docs, License (added IRC)

Summary

  • Removed discuss and blog, creating two empty slots at the top bar.
  • Moved forum and manual to the top bar, reoccupying the freed slots.
  • Added IRC to the footer.
  • Blog is unused anyways, its removal is fine.
  • Discuss would become redundant once IRC is added to footer, its removal is fine.

Tell me what you think.

Edit: Mostly typos.
Edit2: Removed blog.

Better navigation on small screen

Currently, we have two "hamburger" menus; one on the top of the page and one on the bottom. Hiding all the links in a menu isn't very good UX.

I thought about this solution instead: A floating bar at the bottom of the page, with icons and small text under the icons. This bar will show the most important links - the links in the navigation bar. To the far right of the bar, there is a "More" button, which will display the footer links when clicked on.

With this navigation method, we

  • Can show the most important links. We don't have to hide everything
  • Make it easier for visitors to navigate by placing links at the bottom of the screen

Mac builds no longer exist.

They should be removed from the homepage as the last build is ~6 months old. The mac buildserver went down.

https?

I was wondering if it would be possible to convert cuberite.org into https.
I know there's a technical difficulty since the site is actually hosted on Github and a cert would cause trouble. But it can be resolved:

  • Have an nginx server serving the cuberite.org site, encrypt it with letsencrypt
  • The server would proxy requests upstream to cuberite.github.io.
  • The server has a ~5 minute page cache.

Add FreeBSD builds

I think at this point we have to overthink the website design. The main page will be totally cluttered if we add another two of those huge buttons. What about a download section instead?

Create a privacy policy

We should create a (simple) privacy policy that tells the user exactly what we do with the analytics information we collect and what we use cookies for. We could also insert a link to opt-out of Piwik's tracking (alternatively configure Piwik to respect the do-not-track feature in browsers). A link to this privacy policy could be placed in the footer.

Something similar to this perhaps? https://elementary.io/privacy-policy

Small color correction

Could you remove the transparency from the dropdowns, but keep the darker grey?
I find the transparency kinda distractive.
bildschirmfoto von 2016-02-04 19-29-06
its #C3C3C3

Add "getting started" tips after downloading Cuberite

When a new visitor downloads Cuberite, there should be an obvious link to a "Getting started" guide (the manual).

I plan on adding an on-page popup, that appears when a visitor clicks on a download link. This popup will contain a link to the manual, and some text which explains that downloads on the front page update quite often.

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.