voxel/kubi
1
1
Fork 0
mirror of https://github.com/griffi-gh/kubi.git synced 2024-11-13 19:08:41 -06:00
Code Issues Packages Projects Releases Wiki Activity
Voxel engine written in Rust (backup/mirror)
593 commits 2 branches 4 tags 13 MiB
Rust 98.3%
WGSL 1.1%
Nix 0.6%
Find a file
griffi-gh ca74c7799c move cursor to center on unlock
2024-05-02 02:07:36 +02:00
.cargo change stuff :3 (will break android builds) 2023-11-20 23:21:50 +01:00
.github/workflows fix ci, hopefully 2023-11-25 16:22:44 +01:00
.readme Add touch controls, switch to tinymap for keyboard input 2023-06-04 18:39:55 +02:00
.vscode disable lint 2023-03-08 01:47:46 +01:00
assets add trans rendering and crosshair 2024-05-02 00:32:43 +02:00
kubi move cursor to center on unlock 2024-05-02 02:07:36 +02:00
kubi-logging use cyan for debug/trace 2023-11-22 14:38:02 +01:00
kubi-pool . 2023-11-20 19:51:16 +01:00
kubi-server add logging to blk queue 2024-04-25 19:14:56 +02:00
kubi-shared refactor transparency descriptor 2024-05-02 01:21:17 +02:00
.gitignore . 2023-11-21 19:39:21 +01:00
Cargo.lock upgrade deps 2024-04-25 18:29:34 +02:00
Cargo.toml separate kubi-ui as hui 2024-02-17 23:14:04 +01:00
LICENSE Create LICENSE 2024-04-21 19:31:29 +02:00
README.md separate kubi-ui as hui 2024-02-17 23:14:04 +01:00
rust-toolchain.toml change stuff :3 (will break android builds) 2023-11-20 23:21:50 +01:00
Server.toml Finish upgrading server to uflow 2023-03-09 03:30:37 +01:00

README.md

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
  • multiplayer support [1]
  • block placement system
  • basic gui[5]
  • cross platform: windows, linux, osx [2], android [3]
  • universal input system: supports keyboard, mouse, gamepad and touch input [4]
[1] - multiplayer is work-in-progress
[2] - not tested on macos
[3] - android support is experimental
[4] - mouse/gamepad input is not supported on android
[5] - currently only used on the loading screen

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, NDK, command line tools, platform-tools, latest JDK
(make sure that your PATH, ANDROID_HOME and ANDROID_NDK_ROOT variables are configured properly)

Setup:

latest unpublished (git) version of cargo-apk is required

cargo install --git https://github.com/rust-mobile/cargo-apk cargo-apk
rustup 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 --lib --no-default-features

Run on device (using adb):

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

touch 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

"In-house" libraries

  • hui: semi-imm.mode backend-agnostic ui system
    mostly ready to use, it has already replaced the Kubi legacy ui
  • kubi-ui-glium Glium-based backend for kubi-ui
  • kubi-pool: very early work-in-progress work-stealing threadpool system
    aiming to replace rayon threadpool that's currently used inside the kubi client (for more control over task priority)
  • kubi-logging fancy-ass custom formatter for env-logger

deprecated:

kubi-udp was a huge pita to work with and eventually got replaced by uflow (https://github.com/lowquark/uflow) in #5

~ uwu