diff --git a/.readme/game.gif b/.readme/game.gif new file mode 100644 index 0000000..0be52d9 Binary files /dev/null and b/.readme/game.gif differ diff --git a/README.md b/README.md index 3431e0e..b48acac 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,67 @@

Kubi

-work in progress +

+ Minecraft clone written in Rust +

+
+ +
+

features

+

+

+

+ +

building

+ +build/run + +```sh +cargo build -p kubi +cargo run -p kubi +``` + +build with nightly features + +```sh +RUSTFLAGS="-C target-cpu=native" cargo +nightly build -p kubi -r --features nightly -- +``` + +

mutiplayer

+ +to join a multiplayer server, just pass the ip address as an argument + +```sh +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
diff --git a/kubi-server/Cargo.toml b/kubi-server/Cargo.toml index 22fc5bf..def9455 100644 --- a/kubi-server/Cargo.toml +++ b/kubi-server/Cargo.toml @@ -25,4 +25,4 @@ lz4_flex = { version = "0.10", default-features = false, features = ["std", "che [features] default = [] safe_lz4 = ["lz4_flex/safe-encode", "lz4_flex/safe-decode"] -nightly = ["hashbrown/nightly", "rand/nightly", "rand/simd_support", "serde/unstable", "glam/core-simd", "kubi-shared/nightly"] +nightly = ["hashbrown/nightly", "rand/nightly", "rand/simd_support", "glam/core-simd", "kubi-shared/nightly"] diff --git a/kubi-shared/Cargo.toml b/kubi-shared/Cargo.toml index 0d393d8..eea1180 100644 --- a/kubi-shared/Cargo.toml +++ b/kubi-shared/Cargo.toml @@ -19,4 +19,4 @@ rand_xoshiro = "0.6" [features] default = [] -nightly = ["rand/nightly", "rand/simd_support", "serde/unstable", "glam/core-simd"] +nightly = ["rand/nightly", "rand/simd_support", "glam/core-simd"] diff --git a/kubi/Cargo.toml b/kubi/Cargo.toml index 0f2c28b..4ab9574 100644 --- a/kubi/Cargo.toml +++ b/kubi/Cargo.toml @@ -32,4 +32,4 @@ default = [] generate_visualizer_data = ["serde_json", "shipyard/serde1"] safe_lz4 = ["lz4_flex/safe-encode", "lz4_flex/safe-decode"] parallel = ["shipyard/parallel"] -nightly = ["glium/unstable", "hashbrown/nightly", "glam/core-simd", "kubi-shared/nightly"] +nightly = ["hashbrown/nightly", "glam/core-simd", "kubi-shared/nightly"]