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