sfsmc/README.md

20 lines
1.4 KiB
Markdown
Raw Normal View History

2020-07-17 20:26:59 +02:00
# sfs-mc
2020-07-17 21:30:53 +02:00
More than a web server that dynamically show the status of a Minecraft server (formerly known as bukkit-server-status)
# Goals
2020-08-04 16:41:56 +02:00
- [ ] 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/))
2020-07-17 21:30:53 +02:00
- [ ] Start and control the webserver
- [ ] Turn on/off remote starting of the Minecraft server
2020-08-04 16:41:56 +02:00
- [ ] 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/))
2020-07-17 21:30:53 +02:00
- [ ] Server online
- [ ] Players online
- [ ] MOTD
- [ ] Start the Minecraft server if offline
2020-08-04 16:41:56 +02:00
- [ ] Config loading (using [`toml`](https://crates.io/crates/toml/))
2020-07-17 21:30:53 +02:00
- [ ] Config profiles
- [ ] Running in the background (using [`screen`](https://www.gnu.org/software/screen/))
# Decisions made along the way
## 4th August 2020
For the server and "client" to be able to communicate with eachother, I'll be using [DBus](https://www.freedesktop.org/wiki/Software/dbus/) and the [`dbus`-crate](https://crates.io/crates/dbus/). Also, it will probably be better to split the server and client/daemon and control utility in two separate projects (using Cargo's [workspaces](https://doc.rust-lang.org/cargo/reference/workspaces.html)).