diff --git a/README.md b/README.md index abbd50f..7e7dbef 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ -This project, written in Rust and using [Bevy], aims to re-create the functionality of Minecraft "Classic" (2009) for the sake of creating a game that could be considered finished while developing code and experience that can be used in future projects that have greater ambitions. +# bevy-bloxel-classic + +This project, written in Rust and using [Bevy], aims to re-create the functionality of Minecraft "Classic" from 2009, for the sake of creating a game that could be considered finished (because I've been struggling with that), while developing code and experience that can be used in future projects that have greater ambitions. + +[Bevy]: https://bevy.org/ ## Goals -- ☐ Creative mode editing +- ☐ Creative mode building - ☐ Basic player physics - ☐ Limited world size (configurable) - ☐ Block definitions loaded at startup - ☐ Custom block models (and textures) - ☐ Simple cellular automaton interactions - ☑ Multiplayer (server-authoritative) +- ☐ Dedicated (headless) server - ☑ Runs in browser -## Non-goals +### Non-goals - Non-player entities (animals, falling blocks, block entities) - Modding API (other than loading block definitions) @@ -22,30 +27,37 @@ This project, written in Rust and using [Bevy], aims to re-create the functional Since the game is still way too early in development, there are no releases yet. -To compile and run it yourself, other than setting up Rust (through `rustup` for example), I recommend using [Bevy CLI]. It simplifies some tasks, such as building and testing on web. But if you don't want to use it, just replace `bevy run` with `cargo run` for the following commands. +### Native + +To compile and run it yourself, just set up Rust like usual, through `rustup` for example. ```sh # Run the game locally. -bevy run -bevy run -- local # same as above -bevy run --release -- local # with release optimizations +cargo run +cargo run -- local # same as above +cargo run --release -- local # with release optimizations # Host a server for the game and play on it. # When starting up, will print the "certificate digest". -bevy run -- host [PORT] +cargo run -- host [PORT] # Connect to an existing server. -bevy run -- connect