The ShowPlayers and Broadcast commands prefer to use the REST API when it is enabled for player logging.

[MusclePr]

RCON cannot handle multibyte strings, so the ShowPlayers and Broadcast commands prefer to use the REST API when it is enabled.

Context

Work around bug with multibyte strings in RCON.

The multibyte strings are now displayed correctly.

Choices

This is because it takes time to fix bugs in RCON.

Test instructions

1. create docker-compose.override.yml

services:
  palworld:
    image: thijsvanloef/palworld-server-docker:debug
    ports:
      - 8212:8212/tcp  # add REST API port
    environment:
      REST_API_ENABLED: true
      REST_API_PORT: 8212
      SERVER_PASSWORD: "" # [override] no password for debug

2. build docker image for debug

docker build -t thijsvanloef/palworld-server-docker:debug .

3. run docker container

docker compose up

4. connect from client (PalWorld) and make new character with multibyte string name.
   example name:

まっする

5. show docker logs.

[2024-04-19 20:49:37] [LOG] REST accessed endpoint /v1/api/players OK
muscle,3657AB7D000000000000000000000000,76561198847285114 has joined
[2024-04-19 20:49:37] [LOG] まっする joined the server. (User id: steam_76561198847285114)
[2024-04-19 20:49:37] [LOG] REST accessed endpoint /v1/api/announce OK
OK[2024-04-19 20:49:42] [LOG] REST accessed endpoint /v1/api/players OK
muscle,3657AB7D000000000000000000000000,76561198847285114 has left
[2024-04-19 20:49:42] [LOG] REST accessed endpoint /v1/api/announce OK
OKまっする,3657AB7D000000000000000000000000,76561198847285114 has joined
[2024-04-19 20:49:42] [LOG] REST accessed endpoint /v1/api/announce OK
OK[2024-04-19 20:49:47] [LOG] REST accessed endpoint /v1/api/players OK

Checklist before requesting a review

• I have performed a self-review/test of my code
• I've added documentation about this change to the docs.
• I've not introduced breaking changes.
• My changes do not violate linting rules.

[thijsvanloef]

Thank you for taking the time to create the PR, I have not had the time yet to review, but will do so soon!

[thijsvanloef]

Just confirmed that your latest changes also fix the player logging bug! Thanks so much for doing the extra work.
I did notice one thing (which is an oversight on my part) if the REST_API_PORT is not defined in docker-compose.yml through env variables. The following error shows:

palworld-server  | REST API started on port 8212
palworld-server  | Waiting for REST API() port to open to show player logging...
palworld-server  | invalid port  : No such file or directory
palworld-server  | Waiting for REST API() port to open to show player logging...
palworld-server  | invalid port  : No such file or directory

Just pushed a fix that sets it to 8212 by default in the dockerfile :)

Love the work you've done, PR approved ❤️