AstralTransRocketries/Cubyz
1
0
Fork 0
mirror of https://github.com/PixelGuys/Cubyz.git synced 2025-08-03 11:17:05 -04:00
Code Issues Packages Projects Releases Wiki Activity
Cubyz/README.md
m-m-0-m 5a2c3936e5
Update README.md (#196) 
* Update README.md

I fixed grammar, capitalization, formality and I altered the YouTube link at the end, so that it skips the intro (not the video will start at the 11 second mark).

* Update README.md

Changed "(AKA a Minecraft clone)" to "(inspired by Minecraft)," as this is more fitting.
2023-11-26 21:23:12 +01:00

3.1 KiB
Raw Permalink Blame History

Cubyz

Cubyz is a 3D voxel sandbox game (inspired by Minecraft).

Cubyz has a bunch of interesting/unique features such as:

  • Level of Detail (→ This enables far view distances.)
  • 3D Chunks (→ There is no height or depth limit.)
  • Procedural Crafting (→ You can craft anything you want, and the game will figure out what kind of tool you tried to make.)

About

Cubyz is written in Zig, a rather small language with some cool features and a focus on readability.

Windows and Linux are supported. Mac is not supported, as it does not have OpenGL 4.3.

Check out the Discord server for more information and announcements.

There are also some devlogs on YouTube.

History

Until recently (the Zig rewrite was started in August 2022) Cubyz was written in Java. You can still see the code over on the cubyz-java branch and play it using the Java Launcher. // TODO: Move this over to a separate repository

Originally Cubyz was created on August 22, 2018 by zenith391 and ZaUserA. Back then, it was called "Cubz".

However, both of them lost interest at some point, and now Cubyz is maintained by IntegratedQuantum.

Run Cubyz

Sorry, the zig version isn't there yet. You can test the old Java version or ask on the Discord server and I may compile a test release for you.

Otherwise, you can do the following:

Compile Cubyz from Source

  1. Install Git
  2. Clone this repository git clone https://github.com/pixelguys/Cubyz
  3. Run run_release.sh (Linux) or run_release.bat (Windows)

Note for Linux Users:

I also had to install a few -dev packages for the compilation to work:

sudo apt install libgl-dev libasound2-dev libx11-dev libxcursor-dev libxrandr-dev libxinerama-dev libxext-dev libxi-dev

Contributing

Code

Try to follow the style of the existing code. // TODO: Add a style guide
If you have any more questions, you can ask them over on Discord.

Textures

If you want to add new textures, make sure they fit the style of the game. If any of the following points are ignored, your texture will be rejected:

  1. The size of block and item textures must be 16×16 Pixels.
  2. There must be at most 16 different colors in the entire texture.
  3. Textures should be shaded with hue shifting, rather than with darkening only.
    If you are not sure how to use hue shifting, here is a video that explains it well.