voxel-simulation/README.md

# voxel-simulation

![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eliasstepanik/voxel-simulation?utm_source=oss&utm_medium=github&utm_campaign=eliasstepanik%2Fvoxel-simulation&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)


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.

## Features

- Load/Save System
- 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`
- **F5** – Toggle sphere editing mode
- **Escape** – Quit the application

## Running

Execute the following command from the repository root to compile and
launch the demo:

```bash
cargo run --release -p voxel-simulation
```

## License

Licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

See [CONTRIBUTING.md](CONTRIBUTING.md).