kubi/README.md

2.5 KiB

Kubi

Voxel engine written in Rust

features

  • multithreaded procedural world generation
  • procedural structures
  • multithreaded mesh generation
  • cubic chunks (32x32x32)
  • low-level OpenGL renderer, targetting OpenGL ES 3.0
  • frustum culling
  • work-in-progress multiplayer support
  • block placement system
  • partial gamepad input support
  • (experimental) android support

download

Latest nightly release

build for windows/linux

build/run

cargo build --bin kubi
cargo run --bin kubi

build in release mode, with nightly optimizations

cargo +nightly build --bin kubi --features nightly --release

build for android

please note that android support is highly experimental!
gamepad, mouse input is currently borked, and proper touch controls are not available.
srgb and blending are broken too, which leads to many rendering issues

prerequisites: Android SDK, command line tools, NDK, platform-tools, latest JDK
(make sure that your $PATH variable is configured properly)

Setup:

cargo install cargo-apk
cargo target add aarch64-linux-android

Build:

--no-default-features is required for keyboard input!
(prefer-raw-events feature must be disabled on android)

Mouse input is not implemented, touch only!

cargo apk build -p kubi --no-default-features

Run:

cargo apk run -p kubi --no-default-features

android controls

touch control scheme
  • Left side: Movement
  • Rigth side: Camera controls
  • Bottom right corner:
    • B (e.g. place blocks)
    • A (e.g. break, attack)

mutiplayer

to join a multiplayer server, just pass the ip address as an argument

cargo run -p kubi -- 127.0.0.1:1234

server configuration

[server]
address = "0.0.0.0:12345"     # ip address to bind to
max_clients = 32              # max amount of connected clients
timeout_ms = 10000            # client timeout in ms

[world]
seed = 0xfeb_face_dead_cafe   # worldgen seed to use

[query]
name = "Kubi Server"          # server name
~ uwu