From 47e8d3b3eeed1b17a5c8256dc479fcf88b50164a Mon Sep 17 00:00:00 2001 From: Poleric Date: Sat, 6 Jun 2026 23:09:18 +0800 Subject: [PATCH] docs: README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4490b9f --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +Inventory Wars +============== + +A GUI application for hosting the Inventory Wars event in our guild +in Blue Protocol: Star Resonance. + +Rounds are separated into easy and hard rounds. + +- Easy rounds: First one to guess get 1 point. +- Hard rounds: First one to guess get 1 point. The first highest amount get 1 point before end. + +## Running + +The easiest way is to run it as root to give it the permission to +read processes and listen to sockets. + +```shell +sudo -E uv run inventory-wars +``` \ No newline at end of file