Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rYuuk committed Sep 21, 2024
1 parent 67b8e0c commit e649816
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,29 @@

https://github.com/user-attachments/assets/0c2e8eb1-9d6a-4b55-acb2-641740cac15d

AstroGen is a procedural asteroid generator built with Bevy, offering fine-grained control over the asteroid's shape. Customize features like the number of craters, the formation of ridges, and more to create unique asteroid models. The project is inspired by Sebastian Lague's tutorial, which you can check out [here](https://www.youtube.com/watch?v=lctXaT9pxA0&t=618s).
AstroGen is a procedural asteroid generator built with Bevy, it gives control over the asteroid's shape by UI sliders. It lets you customize the number of craters, the formation of ridges, and overall structure to create unique asteroid shapes.

## Executable
You can download the Windows build from the [releases page](https://github.com/rYuuk/AstroGen/releases/).

## Building from Source

#### Prerequisites
- [Rust](https://www.rust-lang.org/tools/install) (version 1.74 or later)
- [Git](https://git-scm.com/downloads)

#### Steps
1. Clone the repository:
```bash
git clone https://github.com/ryuuk/AstroGen.git
cd AstroGen
```

2. Build and run the project:
```bash
cargo run --release --no-default-features
```


## Acknowledgements
This project is inspired by Sebastian Lague's tutorial on procedural planet generation, which can be check out [here](https://www.youtube.com/watch?v=lctXaT9pxA0).
Binary file removed assets/fonts/monofonto_rg.otf
Binary file not shown.
Binary file removed assets/textures/Craters.jpg
Binary file not shown.
Binary file removed assets/textures/MoonNoise.jpg
Binary file not shown.
Binary file removed assets/textures/Rock2.jpg
Binary file not shown.

0 comments on commit e649816

Please sign in to comment.