games-standalone/openrct2/README.md
Red-Thirten c45b6b16d4 Update Installation Script & Small Fixes
- Bump Installation Script container to `debian:bookworm-slim`. This fixes building from source.
- Installation Script now installs the portable bookworm binary of the server when installing a precompiled release (previously it downloaded the AppImage and extracted it).
- Fixed various Startup Variable descriptions.
- Fixed Pelican Egg Configuration Files variable names and Startup Variable sort values.
- Cleaned up the README to have proper syntax.
2024-10-16 19:21:43 -07:00

5.5 KiB

OpenRCT2

Authors / Contributors


Red-Thirten

💻 🔨

parkervcp

💻 💡

janisozaur

💻 💡

Game Description

From OpenRCT2's Website:

OpenRCT2 is an open-source re-implementation of RollerCoaster Tycoon 2 (RCT2), expanding the game with new features, fixing bugs and raising game limits. The gameplay revolves around building and maintaining an amusement park containing attractions, shops and facilities. The player must try to make a profit and maintain a good park reputation whilst keeping the guests happy. OpenRCT2 allows for both scenario and sandbox play. Scenarios require the player to complete a certain objective in a set time limit whilst sandbox allows the player to build a more flexible park with optionally no restrictions or finance.


Server Ports

Port Default Protocol
Primary 11753 TCP

Installation/System Requirements

Minimum
Processor x86/64 (*multiarch may be supported for develop builds, but has not been tested)
RAM 256-512 MiB (depends on # of clients & park size)
Storage 110 MB (may require more if building from source)
RCT2 Files Not required

Save Files

Save files and autosaves are located in this directory:

/home/container/ServerData/save/

If the "Load Latest Autosave" startup variable is enabled, and the autosave/ directory exists, the server will load the latest autosave instead of the specified Save File.


Updating the Server

Assuming you have "OpenRCT2 Version" set to latest or develop, you can simply reinstall the server to get the latest server files. Saves, configs, logs, etc. in /home/container/ServerData/ will not be modified/deleted.

Console Commands

Until support for console commands to interactive programs gets added to Pterodactyl, entering commands via the panel's console do nothing (reference issue pterodactyl/panel#3712).


Becoming an Admin on the Server

Unfortunately, because console commands currently do not register, becoming the first admin on the server takes some steps, listed below:

  1. Ensure the "Log Server Actions" startup variable is set to "true".
  2. Start the server and join it with the client you want to make an admin.
  3. Open ServerData/serverlogs/<Server Name>/<Latest Date>.txt and copy the SHA1 hash next to your client's username (note the username as well).
  4. Then, open ServerData/users.json. Paste the hash into the "hash" value, change the "name" value to your client's username, and save the file.
  5. Reboot the server, re-join it, and you should be an admin!

After becoming an admin, you can use the in-game users management window to add additional admins (or groups) more easily if you wish.


Known Issues

The following are known issues that are unique to running OpenRCT2 on Pterodactyl, but likely can only be fixed by further development/updates from OpenRCT2.

  • Configuring a password on the server disallows non-admin clients from entering in a password in their client to connect; it just disconnects them. Admin clients can still join normally. (reference issue OpenRCT2/OpenRCT2#16396)
  • You may rarely run into the server crashing on start due to a "Floating point exception(core dumped)" error. If this occurs to you, please help with OpenRCT2 development by doing the following:
    1. Add the following to the beginning of your server's startup command: SEGFAULT_SIGNALS=fpe LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so
    2. Start the server. If it boots normally, nothing extra will print. If it crashes, it will print a stack trace to the console.
    3. If a crash occurs, copy the entire stack trace, and save it to a log sharing website (like Hastebin).
    4. Open a new Bug Report Issue with OpenRCT2 and share your logs with them.