Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tsuzu committed Jan 24, 2024
1 parent 42069c3 commit 968b43d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 968b43d

Please sign in to comment.