Skip to content

Commit 968b43d

Browse files
committed
Update README
1 parent 42069c3 commit 968b43d

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,21 @@ Broadcast messages that someone joined/left the game.
44

55
![game screen that shows log of joined:Tsuzu](./docs/example.png)
66

7+
## Installation
8+
### Docker(Recommended)
9+
```
10+
docker pull ghcr.io/miscord-dev/palog:v0.0.3
11+
```
12+
13+
### Download binary
14+
* Download binary from [releases](https://github.com/miscord-dev/palog/releases/latest)
15+
716
## Environment Variables
817
* RCON_ENDPOINT: Endpoint of RCON (IP:Port)
918
* RCON_PASSWORD: Password of RCON
1019
* INTERVAL: Interval to check current players (default: 5s)
1120
* TIMEOUT: Timeout of RCON calls (default: 1s)
21+
* UCONV_LATIN: Set `false` to disable escape string with `uconv -x latin`
1222

1323
## Known issues
1424
* If the message is split via whitespaces, `Broadcast` sends only the first segment

0 commit comments

Comments
 (0)