docs: README.md

2026-06-06 23:09:18 +08:00
parent ce9dee9946
commit 47e8d3b3ee
1 changed files with 19 additions and 0 deletions
@@ -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
 ```