OPENRCT2-CLI(6)

💖 OPENRCT2-CLI 💖

okay bestie, so this is the Games Manual page for openrct2-cli — that's the whole manual name, OPENRCT2-CLI(6), section 6, games. sit down, hydrate, we're running a game server with no screen and it's gonna be iconic 🎀

✨ NAME ✨

openrct2-cli — headless server mode for OpenRCT2, aka running the whole game like a little console gremlin with zero UI 💅

🌈 SYNOPSIS 🌈

openrct2-cli [-h | --help] [-v | --version] [--verbose]

openrct2-cli host uri [--address address] [--port port]
             [--password password]

🦋 DESCRIPTION 🦋

So OpenRCT2 has a headless mode where the game just runs as a console application, no UI, nothing, just vibes and stdout. it's literally made for running dedicated game servers. main character energy but the main character is a terminal 🫶

there's a bunch of objects chillin' in OpenRCT2's scripting interface that you can poke at from the CLI:

• cheats — turn various cheats on and off, no judgment
• climate — mess with the climate and the weather 🌦️
• console — options for talking to the stdout console
• context — the core API, for plugins
• date — get or set the in-game date
• map — manipulate the map
• network — manage the server or interact with clients
• park — APIs for the park and managing it
• scenario — info about the current scenario
• titleSequenceManager — create and edit title sequences (only available to clients that are not running in headless mode, so not you, sorry bestie 😭)
• ui — APIs for controlling the user interface (only available to clients that are not running in headless mode either, same deal 🙈)

if you want the deeper lore about OpenRCT2, its options and what it can do, go read the openrct2(6) manpage, it's right there 📖

👑 OPTIONS 👑

• -h | --help — print a summary of all options to stdout and then exit. bye ✌️
• -v | --version — show version information and exit.
• -n | --no-install — do not install the scenario if passed.
• -a | --all — show help for all commands. the full lore drop.
• --about — show information about openrct2-cli.
• --verbose — print diagnostic information to stdout. it's giving yapper, and honestly we love that for it 🗣️
• --port port — port to use for hosting or joining a server. if you don't specify it, the default port of 11753 gets used 💅
• --address address — address to bind to when hosting a server.
• --password password — password needed to join the server. keep it secret, keep it safe 🔐
• --user-data-path path — path to the user data directory (the one containing config.ini)
• --openrct2-data-path path — path to the OpenRCT2 data directory (the one containing languages)
• --rct1-data-path path — path to the RollerCoaster Tycoon 1 data directory (the one containing data/csg1.dat)
• --rct2-data-path path — path to the RollerCoaster Tycoon 2 data directory (the one containing data/g1.dat)

🌸 NOTES 🌸

with multiplayer you might run into some bugs that do not occur in single player mode. not to be dramatic but. yeah. if that happens, please report it on GitHub if the issue hasn't already been reported, and please say if the bug only occurs on multiplayer games. we need the deets bestie 🙏

for the server to successfully accept clients, the port must be open for the server's own firewall and any router's firewall the computer is behind. also, if the server is behind a router with NAT enabled, the router has to be configured to have the port forwarded to the server's local address. networking is the villain of this story fr fr 💀

💜 EXAMPLES 💜

openrct2-cli host ./my_park.sv6 --port 11753

run a headless server for a saved park. slay.

$ network.players[1].group = 0

from the CLI for a multiplayer server, set the first user to join as an admin 👑

$ cheats["disableAllBreakdowns"] = true

from the CLI, enable the cheat to disable all ride breakdowns. no more breakdown jumpscares 🎢✨

⭐ SEE ALSO ⭐

• openrct2(6)
• Official site: https://openrct2.io
• GitHub: https://github.com/OpenRCT2/OpenRCT2

okay that's the whole page, and before you go: this lovely thing came from Debian and it's dated December 19, 2021 💖 go forth and host, bestie, you got this 🫶🎀