From 3a974d9d58e4df47ad6fcaff228500b276ab9154 Mon Sep 17 00:00:00 2001 From: Elias Stepanik <40958815+eliasstepanik@users.noreply.github.com> Date: Mon, 9 Jun 2025 22:34:00 +0200 Subject: [PATCH 1/2] docs: expand README with running instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index a4427c3..9dc839d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ # voxel-simulation +Voxel Simulation is an experimental 3D world built with the +[Bevy](https://bevyengine.org/) game engine. The project showcases +streaming voxel terrain, high precision coordinates via the +[big_space](https://crates.io/crates/big_space) crate and various debug +tools. +![Demo screenshot](images/voxel-simulation-demo.png) + +## Running + +Execute the following command from the repository root to compile and +launch the demo: + +```bash +cargo run --release -p voxel-simulation +``` ## License From a419cab0e2b1ccb0dfd500c4d14c453cfc11fc56 Mon Sep 17 00:00:00 2001 From: Elias Stepanik <40958815+eliasstepanik@users.noreply.github.com> Date: Mon, 9 Jun 2025 22:54:48 +0200 Subject: [PATCH 2/2] Expand README with features and controls --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 9dc839d..ee28719 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,28 @@ streaming voxel terrain, high precision coordinates via the [big_space](https://crates.io/crates/big_space) crate and various debug tools. +## Features + +- Streaming voxel terrain with adjustable level of detail +- High precision world coordinates using [`big_space`](https://crates.io/crates/big_space) +- Planet generation using noise based deformation +- Flight-style camera and basic UI +- Debug helpers for wireframes, world grid and voxel editing + ![Demo screenshot](images/voxel-simulation-demo.png) +## Controls + +- **WASD** – Move horizontally +- **Space / Shift** – Ascend/descend +- **Mouse** – Look around (press **L** to toggle mouse capture) +- **Mouse wheel** – Adjust movement speed +- **F2** – Toggle octree wireframe +- **F3** – Toggle world grid +- **Q** – Insert a red voxel at the crosshair +- **F4** – Save the current octree to `octree.bin` +- **Escape** – Quit the application + ## Running Execute the following command from the repository root to compile and