Skip to content

Commit f76b137

Browse files
committed
Update README.md
1 parent 02a9836 commit f76b137

1 file changed

Lines changed: 35 additions & 2 deletions

File tree

README.md

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

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

7+
## Usage
8+
### Enable RCON of PalWorld server
9+
* Open `~/Steam/steamapps/common/PalServer/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini`
10+
* Set `RCONEnabled="True"`
11+
* Set `AdminPassword="your_random_password"`
12+
* Restart the PalWorld server
13+
14+
* Ref: https://tech.palworldgame.com/optimize-game-balance
15+
16+
### Docker
17+
```
18+
docker run --name palog -e RCON_ENDPOINT={PalWorldServerIP}:25575 -e RCON_PASSWORD={AdminPassword you set above} ghcr.io/miscord-dev/palog:v0.0.5
19+
```
20+
21+
### Binary installation
22+
#### Install palog
23+
* Use the following guide of installation
24+
* (optional) Install `uconv`
25+
* Non-ascii characters are converted via `uconv -x latin`
26+
* On Debian/Ubuntu; `apt-get install -y icu-devtools`
27+
28+
#### Set environment variables
29+
* RCON_ENDPOINT
30+
* If you run palog on the same server as the PalWorld server, the value is `127.0.0.1:25575`
31+
* RCON_PASSWORD
32+
* The password you set in the earlier step
33+
* For other options, please check the [Environemnt Variables](#environment-variables) section
34+
35+
#### Launch palog
36+
```
37+
$ ./palog
38+
```
39+
740
## Installation
841
### Docker(Recommended)
942
```
10-
docker pull ghcr.io/miscord-dev/palog:v0.0.3
43+
docker pull ghcr.io/miscord-dev/palog:v0.0.5 # or main
1144
```
1245

1346
### Download binary
@@ -22,5 +55,5 @@ docker pull ghcr.io/miscord-dev/palog:v0.0.3
2255

2356
## Known issues
2457
* If the message is split via whitespaces, `Broadcast` sends only the first segment
25-
* CKJ characters are corrupted
58+
* Non-ascii are corrupted
2659
* https://github.com/miscord-dev/palog/issues/6

0 commit comments

Comments
 (0)