diff --git a/README.md b/README.md index 6cca47f..99e6f15 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # sfs-mc -More than a web server that dynamically show the status of a Minecraft server (formerly known as bukkit-server-status) \ No newline at end of file +More than a web server that dynamically show the status of a Minecraft server (formerly known as bukkit-server-status) + +# Goals +- [ ] A cli (using [`clap`](https://crates.io/crates/clap)) that enables to + - [ ] Start the Minecraft server and give control over its terminal (using [`screen`](https://www.gnu.org/software/screen)) + - [ ] Start and control the webserver + - [ ] Turn on/off remote starting of the Minecraft server +- [ ] A webserver that show the current status of the Minecraft server (using [`actix-web`](https://crates.io/crates/actix-web), [`tokio`](https://crates.io/crates/tokio), and [`async-minecraft-ping`](https://crates.io/crates/async-minecraft-ping)) + - [ ] Server online + - [ ] Players online + - [ ] MOTD + - [ ] Start the Minecraft server if offline +- [ ] Config loading (using [`toml`](https://crates.io/crates/toml)) +- [ ] Config profiles +- [ ] Running in the background (using [`screen`](https://www.gnu.org/software/screen)) \ No newline at end of file