From 1558169c7df2666d6780650200db1e5a18c62900 Mon Sep 17 00:00:00 2001
From: griffi-gh
Date: Fri, 3 May 2024 20:27:39 +0200
Subject: [PATCH] remove outdated info from readme
---
README.md | 42 +++++++++++++++++-------------------------
1 file changed, 17 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index 59faaca..aaacbef 100644
--- a/README.md
+++ b/README.md
@@ -11,23 +11,22 @@
- multithreaded procedural world generation
- - procedural structures
+ - procedural structures and block queue
- 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]
+ - multiplayer networking
+ - immediate ui system
[1]
+ - cross platform: windows, linux, osx, android
[2]
+ - universal input system: supports keyboard, mouse, gamepad and touch input
[3]
+ - support for semi-transparet blocks
[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
+ [1]
- developed out-of-tree here since 2024
+ [2]
- android support is experimental
+ [3]
- mouse and gamepad input is not supported on android
+ [4]
- work in progress, may cause issues
@@ -36,24 +35,17 @@
build for windows/linux
-**build/run**
-
```bash
-cargo build --bin kubi
-cargo run --bin kubi
-```
-
-**build in release mode, with nightly optimizations**
-
-```bash
-cargo +nightly build --bin kubi --features nightly --release
+cargo build -p kubi
+cargo run -p kubi
+#or, build with release mode optimizations:
+cargo run -p kubi --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
+gamepad, mouse input is currently borked, as well as srgb, which leads to dark textures.
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)
@@ -95,7 +87,7 @@ cargo apk run -p kubi --lib --no-default-features
mutiplayer
-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
cargo run -p kubi -- 127.0.0.1:1234
@@ -119,7 +111,7 @@ name = "Kubi Server" # server name
"In-house" libraries
- [`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: