Admin cli for OpenRCT2

We had the problem that we maintained many linux servers and we could not remotely execute commands to becomse admin. So we created a CLI to maintain servers for OpenRCT2 with the minimum effort.

Prerequisites

You can use this application when you install the openrct2-remote-control plugin in the plugins directory on your server.

For the installation procedure please read the readme file of that project.

Usage

Help command

To run this image remember you will need the host network settings so to run this you can execute:

docker run -it ghcr.io/brammittendorff/openrct2-admin-cli:latest cli.js --help

This will result in:

cli.js [command]

Commands:
  cli.js details  This will get the details of your park
  cli.js users    This will get the users of your park
  cli.js groups   This will get the groups of your park
  cli.js run      This will run the command you enter

Options:
      --version   Show version number                                  [boolean]
  -n, --hostname  A hostname to overrule 127.0.0.1                      [string]
  -h, --help      Show help                                            [boolean]

View users

To view the users you can run:

docker run -it --network host ghcr.io/brammittendorff/openrct2-admin-cli:latest cli.js users

This could result in:

[
  { id: 0, group: 0, name: 'bram', ping: 0, hash: '', ip: '' },
  {
    id: 1,
    group: 0,
    name: 'bram #2',
    ping: 50,
    hash: '1337hashoftheuser',
    ip: '1.3.3.7'
  }
]

View groups

To view the groups you can run:

docker run -it --network host openrct2-admin-cli:latest cli.js groups

This could result in:

[
  { id: 0, name: 'Admin' },
  { id: 1, name: 'Spectator' },
  { id: 2, name: 'User' }
]

Give the user admin permission

Remember in the view groups section the admin group id was 0 so with the hash of the user and the admin id you can execute the following command:

docker run -it --network host openrct2-admin-cli:latest cli.js run -c "update player 1337hashoftheuser 0"

This could result in:

Command sent succesfully: "update player 1337hashoftheuser 0"

Docker

• Server is running with the image name openrct2-admin-cli
• We run the cli also by docker with url ghcr.io/brammittendorff/openrct2-admin-cli:main

To run this in docker and if you run the openrct2-admin-cli also in docker you can use the pushed docker image:

 docker run -it ghcr.io/brammittendorff/openrct2-admin-cli:main cli.js -n $(docker inspect --format '{{ .NetworkSettings.IPAddress }}' $(docker ps | grep openrct2-cli | awk '{print $1}')) run -c 'say hi'