From 968b43d1e2e1887aaf959f1deeccd84cc2134b2f Mon Sep 17 00:00:00 2001 From: Tsuzu <8574909+tsuzu@users.noreply.github.com> Date: Thu, 25 Jan 2024 01:03:55 +0900 Subject: [PATCH] Update README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e58a292..9836b68 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,21 @@ Broadcast messages that someone joined/left the game. ![game screen that shows log of joined:Tsuzu](./docs/example.png) +## Installation +### Docker(Recommended) +``` +docker pull ghcr.io/miscord-dev/palog:v0.0.3 +``` + +### Download binary +* Download binary from [releases](https://github.com/miscord-dev/palog/releases/latest) + ## Environment Variables * RCON_ENDPOINT: Endpoint of RCON (IP:Port) * RCON_PASSWORD: Password of RCON * INTERVAL: Interval to check current players (default: 5s) * TIMEOUT: Timeout of RCON calls (default: 1s) +* UCONV_LATIN: Set `false` to disable escape string with `uconv -x latin` ## Known issues * If the message is split via whitespaces, `Broadcast` sends only the first segment