voxel/kubi
1
1
Fork 0
mirror of https://github.com/griffi-gh/kubi.git synced 2024-11-21 22:38:41 -06:00
Code Issues Packages Projects Releases Wiki Activity

remove outdated info from readme

Browse source
This commit is contained in:
griffi-gh 2024-05-03 20:27:39 +02:00
parent e3692bca94
commit 94fa5268fa
1 changed files with 17 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -11,23 +11,22 @@
<p> <p>
<ul> <ul>
<li>multithreaded procedural world generation</li> <li>multithreaded procedural world generation</li>
<li>procedural structures</li> <li>procedural structures and block queue</li>
<li>multithreaded mesh generation</li> <li>multithreaded mesh generation</li>
<li>cubic chunks (32x32x32)</li> <li>cubic chunks (32x32x32)</li>
<li>low-level OpenGL renderer, targetting OpenGL ES 3.0</li> <li>low-level OpenGL renderer, targetting OpenGL ES 3.0</li>
<li>frustum culling</li> <li>frustum culling</li>
<li>multiplayer support <sup><code>[1]</code></sup></li> <li>multiplayer networking</li>
<li>block placement system</li> <li>immediate ui system <sup><code>[1]</code></sup></li>
<li>basic gui<sup><code>[5]</code></sup></li> <li>cross platform: windows, linux, osx, android <sup><code>[2]</code></sup></li>
<li>cross platform: windows, linux, osx <sup><code>[2]</code></sup>, android <sup><code>[3]</code></sup></li> <li>universal input system: supports keyboard, mouse, gamepad and touch input <sup><code>[3]</code></sup></li>
<li>universal input system: supports keyboard, mouse, gamepad and touch input <sup><code>[4]</code></sup></li> <li>support for semi-transparet blocks<sup><code>[4]</code></sup></li>
</ul> </ul>
<h6> <h6>
<code>[1]</code> - multiplayer is work-in-progress<br> <code>[1]</code> - developed out-of-tree <a href="https://github.com/griffi-gh/hUI">here</a> since 2024<br>
<code>[2]</code> - not tested on macos<br> <code>[2]</code> - android support is experimental<br>
<code>[3]</code> - android support is experimental<br> <code>[3]</code> - mouse and gamepad input is not supported on android<br>
<code>[4]</code> - mouse/gamepad input is not supported on android<br> <code>[4]</code> - work in progress, may cause issues<br>
<code>[5]</code> - currently only used on the loading screen
</h6> </h6>
</p> </p>
@ -36,24 +35,17 @@
<h2>build for windows/linux</h2> <h2>build for windows/linux</h2>
**build/run**
```bash ```bash
cargo build --bin kubi cargo build -p kubi
cargo run --bin kubi cargo run -p kubi
``` #or, build with release mode optimizations:
cargo run -p kubi --release
**build in release mode, with nightly optimizations**
```bash
cargo +nightly build --bin kubi --features nightly --release
``` ```
<h2>build for android</h2> <h2>build for android</h2>
please note that android support is highly experimental!\ please note that android support is highly experimental!\
gamepad, mouse input is currently borked, and proper touch controls are not available.\ gamepad, mouse input is currently borked, as well as srgb, which leads to dark textures.
srgb and blending are broken too, which leads to many rendering issues
prerequisites: Android SDK, NDK, command line tools, platform-tools, latest JDK\ 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) (make sure that your `PATH`, `ANDROID_HOME` and `ANDROID_NDK_ROOT` variables are configured properly)
@ -95,7 +87,7 @@ cargo apk run -p kubi --lib --no-default-features
<h2>mutiplayer</h2> <h2>mutiplayer</h2>
to join a multiplayer server, just pass the ip address as an argument to join a multiplayer server, just pass the ip address as the first argument
```sh ```sh
cargo run -p kubi -- 127.0.0.1:1234 cargo run -p kubi -- 127.0.0.1:1234
@ -119,7 +111,7 @@ name = "Kubi Server" # server name
<h2>"In-house" libraries</h2> <h2>"In-house" libraries</h2>
- [`hui`, `hui-glium`, `hui-winit`](https://github.com/griffi-gh/hui): semi-imm.mode backend-agnostic ui system\ - [`hui`, `hui-glium`, `hui-winit`](https://github.com/griffi-gh/hui): semi-imm.mode backend-agnostic ui system\
- [`kubi-logging`](kubi-logging) fancy-ass custom formatter for `env-logger` - [`kubi-logging`](kubi-logging) fancy custom formatter for `env-logger`
deprecated: deprecated: