mirror of
https://github.com/eliasstepanik/voxel-simulation.git
synced 2026-01-11 05:48:29 +00:00
Expand README with features and controls
This commit is contained in:
parent
3a974d9d58
commit
a419cab0e2
20
README.md
20
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
|
||||
|
||||

|
||||
|
||||
## 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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user