~comcloudway/little_town

de323908045cd1347c4f677a46f4981771a5a4a1 — Jakob Meier 1 year, 8 months ago d83c9b8 v0.1.0
Updated ReadMe
1 files changed, 29 insertions(+), 4 deletions(-)

M README.md
M README.md => README.md +29 -4
@@ 18,22 18,47 @@ NOTE: There are plans to add multi-world support,
at that point this guide has to be updated, 
because the file will also be moved.

## Roadmap
- [x] Placing & Removing blocks
- [x] Basic Welcome Screen
- [ ] Inventory
  - [x] Basic block list
  - [ ] Inventory categories
- [x] p2p local multiplayer (using mdns discovery)
- [ ] world selection & better storage
- [ ] (Maybe) campaign mode (build & expand a city with limited ressources)
- [ ] Touch control
- [ ] Settings menu (i.e for Keybindings)
- [ ] Game music?

## Building
We are currently building binaries
for some distros using the Sourcehut CI.
[![builds.sr.ht status](https://builds.sr.ht/~comcloudway/little_town/commits/main/.build.yml.svg)](https://builds.sr.ht/~comcloudway/little_town/commits/main/.build.yml?)

If your setup is not supported,
or you don't want to use the default features,
you can follow this guide to build the binary yourself.

### Dependencies
- [rustup](https://www.rust-lang.org/tools/install)
- [rustup](https://www.rust-lang.org/tools/install), `cargo` and `rust` nightly
- `alsa-lib-dev` (or `libasound` depending on your distro) on linux
- `protoc` on linux, with `multiplayer` feature enabled
### Steps
1.  Clone this repo:
1. Clone this repo:
    ```bash
    git clone https://codeberg.org/comcloudway/little_town
    cd little_town
    ```
2.  Build the binary using cargo:
2. Download the assets using the provided script:
   ``` bash
   ./fetch-assets.sh
    ```
3. Build the binary using cargo:
    ```bash
    cargo build --release
    ```
3.  The output binary can be found in the `target` folder.
4. The output binary can be found in the `target` folder.

## Credits
The Assets were created by [Kenney](https://kenney.nl/)