kubi/README.md

1.9 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

building

build/run

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

build with nightly features

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

build for android

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

prerequisites: Android SDK, NDK, platform-tools, latest JDK (all should be in $PATH)

cargo install cargo-apk  
cargo target add aarch64-linux-android  
cargo apk build -p kubi
cargo apk run -p kubi

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