diff --git a/README.md b/README.md index 15a339a5..006e4acf 100644 --- a/README.md +++ b/README.md @@ -229,6 +229,7 @@ If you are reading this it looks like you are looking to add an egg to your serv * [TShock](game_eggs/terraria/tshock) [Tycoon Games](game_eggs/tycoon_games) +* [OpenRCT2](game_eggs/tycoon_games/openrct2) * [OpenTTD](game_eggs/tycoon_games/openttd) [Veloren](game_eggs/veloren) diff --git a/game_eggs/README.md b/game_eggs/README.md index 81e64039..43aafbc4 100644 --- a/game_eggs/README.md +++ b/game_eggs/README.md @@ -156,6 +156,7 @@ * [TShock](terraria/tshock) [Tycoon Games](tycoon_games) +* [OpenRCT2](tycoon_games/openrct2) * [OpenTTD](tycoon_games/openttd) [Unreal Engine](unreal_engine) diff --git a/game_eggs/tycoon_games/README.md b/game_eggs/tycoon_games/README.md new file mode 100644 index 00000000..cee33a2c --- /dev/null +++ b/game_eggs/tycoon_games/README.md @@ -0,0 +1,9 @@ +# Tycoon Game Servers + +This is a collection of Tycoon game servers, that are typically open-source re-implementations of classic Tycoon titles. + +## Roller Coaster Tycoon 2 +[OpenRCT2](openrct2) + +## Transport Tycoon Deluxe +[OpenTTD](openttd) diff --git a/game_eggs/tycoon_games/openrct2/README.md b/game_eggs/tycoon_games/openrct2/README.md new file mode 100644 index 00000000..b0dbaf98 --- /dev/null +++ b/game_eggs/tycoon_games/openrct2/README.md @@ -0,0 +1,88 @@ +# OpenRCT2 +***Note:** OpenRCT2 only recently (Jan. 2022) updated to support non-interactive Docker environments, and development is ongoing to improve it. Please understand future updates may be unstable, or this Egg may update in the future to accommodate changes.* +___ +### Authors / Contributors + + + + + + + + +
+ +
Red-Thirten + +
+ 💻 + 🔨 + 		+ +
parkervcp + +
+ 💻 + 💡 + 		+ +
janisozaur + +
+ 💻 + 💡 +
+ + + +___ +### Game Description +From OpenRCT2's [Website](https://openrct2.io/): +> 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 (TCP) | +|---------|---------| +| Game | 11753 | + +___ +### Installation/System Requirements + +| | Minimum | +|---------|---------| +| Processor | Multiarch is supported for most modern processors | +| RAM | 256-512 MiB (depends on # of clients & park size) | +| Storage | 80 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. +___ +### 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](https://github.com/pterodactyl/panel/issues/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//.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, and change the "name" value to your client's username. +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. +- Only building from source from the `develop` branch currently yields a package that is bootable. This will no longer be true for any OpenRCT2 releases after v.0.3.5.1. + - This also means that clients joining the server must be on the latest `develop` branch as well. +- 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](https://github.com/OpenRCT2/OpenRCT2/issues/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](https://www.hastebin.com)). + 4. [Open a new Bug Report Issue with OpenRCT2](https://github.com/OpenRCT2/OpenRCT2/issues/new?assignees=&labels=bug&template=bug_report.yaml) and share your logs with them. diff --git a/game_eggs/tycoon_games/openrct2/egg-openrct2.json b/game_eggs/tycoon_games/openrct2/egg-openrct2.json new file mode 100644 index 00000000..ed070f1a --- /dev/null +++ b/game_eggs/tycoon_games/openrct2/egg-openrct2.json @@ -0,0 +1,193 @@ +{ + "_comment": "Pterodactyl OpenRCT2 Egg ~ Red-Thirten and parkervcp ~ 2022-01-12", + "meta": { + "version": "PTDL_v1", + "update_url": null + }, + "name": "OpenRCT2", + "author": "rehlmgaming@gmail.com", + "description": "OpenRCT2 is an open-source re-implementation of RollerCoaster Tycoon 2 (RCT2), expanding the game with new features, fixing bugs and raising game limits.", + "features": null, + "images": [ + "ghcr.io\/parkervcp\/yolks:debian" + ], + "file_denylist": [], + "startup": ".\/OpenRCT2\/openrct2-cli --version && .\/OpenRCT2\/openrct2-cli host $(if {{LOAD_AUTOSAVE}} && [ -d ServerData\/save\/autosave\/ ]; then find ServerData\/save\/autosave\/ | sort -r | head -1; else echo \"{{SAVE_URI}}\"; fi) --port {{SERVER_PORT}} --user-data-path \/home\/container\/ServerData\/", + "config": { + "files": "{\r\n \"ServerData\/config.ini\": {\r\n \"parser\": \"ini\",\r\n \"find\": {\r\n \"general.autosave\": \"{{server.build.env.AUTOSAVE_INTERVAL}}\",\r\n \"general.autosave_amount\": \"{{server.build.env.AUTOSAVE_AMOUNT}}\",\r\n \"network.player_name\": \"\\\"{{server.build.env.SERVER_PLAYER_NAME}}\\\"\",\r\n \"network.default_port\": \"{{server.build.default.port}}\",\r\n \"network.default_password\": \"\\\"{{server.build.env.SERVER_PASSWORD}}\\\"\",\r\n \"network.advertise\": \"{{server.build.env.SERVER_ADVERTISE}}\",\r\n \"network.maxplayers\": \"{{server.build.env.MAX_PLAYERS}}\",\r\n \"network.server_name\": \"\\\"{{server.build.env.SERVER_NAME}}\\\"\",\r\n \"network.server_description\": \"\\\"{{server.build.env.SERVER_DESCRIPTION}}\\\"\",\r\n \"network.server_greeting\": \"\\\"{{server.build.env.SERVER_GREETING}}\\\"\",\r\n \"network.provider_name\": \"\\\"{{server.build.env.PROVIDER_NAME}}\\\"\",\r\n \"network.provider_email\": \"\\\"{{server.build.env.PROVIDER_EMAIL}}\\\"\",\r\n \"network.provider_website\": \"\\\"{{server.build.env.PROVIDER_WEBSITE}}\\\"\",\r\n \"network.log_chat\": \"{{server.build.env.LOG_CHAT}}\",\r\n \"network.log_server_actions\": \"{{server.build.env.LOG_SERVER_ACTIONS}}\",\r\n \"network.pause_server_if_no_clients\": \"{{server.build.env.PAUSE_NO_CLIENTS}}\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"Listening for clients on\"\r\n}", + "logs": "{}", + "stop": "^C^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n\r\n## File: Pterodactyl OpenRCT2 Egg - egg-openrct2.json\r\n## Authors: David Wolfe (Red-Thirten), parkervcp\r\n## Date: 2022\/01\/12\r\n## License: MIT License\r\n\r\nGITHUB_PACKAGE=\"OpenRCT2\/OpenRCT2\"\r\nMATCH=\"linux-bullseye-x86_64.tar.gz\"\r\nDEFAULT_SAVE=\"https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/game_eggs\/tycoon_games\/openrct2\/save.park\"\r\n\r\n## OpenRCT2 Install\r\napt -y update\r\n[ ! -d \/mnt\/server ] && mkdir \/mnt\/server\r\ncd \/mnt\/server\r\n# Remove existing installation if present\r\n[ -d OpenRCT2 ] && rm -rf OpenRCT2\r\n\r\n# Determine if installing from source or from release\r\nif [ \"${VERSION}\" == \"develop\" ]; then\r\n # Get required packages\r\n apt -y install curl git make cmake gcc build-essential libicu-dev pkg-config libcurl4-openssl-dev libcrypto++-dev libpng-dev libssl-dev libzip-dev duktape-dev nlohmann-json3-dev\r\n echo -e \"\\nInstalling\/Updating OpenRCT2 from source...\\n\"\r\n # Setup temp directory for building and move to it\r\n [ -d temp ] && rm -rf temp\r\n mkdir temp && cd temp\r\n # Clone the branch and check if successful\r\n git clone --branch \"${VERSION}\" https:\/\/github.com\/${GITHUB_PACKAGE}\r\n if [ ! -d OpenRCT2 ]; then\r\n echo -e \"\\nFailed to clone \\\"${VERSION}\\\" branch from https:\/\/github.com\/${GITHUB_PACKAGE}\\n\"\r\n exit 1\r\n fi\r\n cd OpenRCT2\r\n mkdir build && cd build\r\n # Prepare CMake files for a lightweight and CLI-only build of OpenRCT2, using the appropriate flags\r\n cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DPORTABLE=ON -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_CXX_FLAGS=\"-g -gz\" -DDISABLE_TTF=ON -DDISABLE_GOOGLE_BENCHMARK=ON -DDISABLE_DISCORD_RPC=ON -DDISABLE_GUI=ON\r\n echo -e \"\\nBuilding OpenRCT2 package from source...\\n\\tThis process can take quite some time. Grab a coffee :)\\n\"\r\n # Build OpenRCT2\r\n DESTDIR=. make install\r\n # Check if build was successful and move to it\r\n if [ ! -d usr\/local ]; then\r\n echo -e \"\\nFailed to successfully build OpenRCT2!\\n\"\r\n exit 1\r\n fi\r\n cd usr\/local\r\n # Make executable-ready package by moving compiled files to the correct locations\r\n mkdir -p \/mnt\/server\/OpenRCT2\/data\r\n mv bin\/* \/mnt\/server\/OpenRCT2\/\r\n mv share\/openrct2\/* share\/openrct2-cli\/* \/mnt\/server\/OpenRCT2\/data\/\r\n mv share\/doc \/mnt\/server\/OpenRCT2\/\r\n cd \/mnt\/server\r\n rm -rf temp # Clean up temp building directory\r\n echo -e \"\\nBuild of OpenRCT2 package complete!\"\r\nelse\r\n # Get required packages\r\n apt install -y curl jq\r\n echo -e \"\\nInstalling\/Updating OpenRCT2 from release tag \\\"${VERSION}\\\"...\\n\"\r\n # This is a simple script to use the GitHub API for release versions.\r\n # This requires the egg has a variable for GITHUB_PACKAGE, VERSION and MATCH (MATCH is to match the filename in some way).\r\n # Get release info and download links\r\n LATEST_JSON=$(curl --silent \"https:\/\/api.github.com\/repos\/${GITHUB_PACKAGE}\/releases\/latest\")\r\n RELEASES=$(curl --silent \"https:\/\/api.github.com\/repos\/${GITHUB_PACKAGE}\/releases\")\r\n\r\n if [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\n else\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\n fi\r\n # Download and unpackage the release\r\n curl -L ${DOWNLOAD_URL} | tar -xzv\r\n # Check if it was successful\r\n if [ -d OpenRCT2 ]; then\r\n echo -e \"\\nDownload of OpenRCT2 release successful!\"\r\n else\r\n echo -e \"\\nFailed to download\/unpack file: ${DOWNLOAD_URL}\\n\"\r\n exit 1\r\n fi\r\nfi\r\n\r\n## OpenRCT2 Setup\r\n# Setup ServerData\/save directory\r\n[ ! -d ServerData\/save ] && mkdir -p ServerData\/save\r\ncd ServerData\/save\r\n# Download default save.park if missing\r\nif [ ! -f save.park ]; then\r\n echo -e \"Downloading default save.park file from ${DEFAULT_SAVE}\"\r\n curl -sSLO ${DEFAULT_SAVE}\r\nfi\r\n\r\necho -e \"\\nOpenRCT2 Successfully Installed!\"", + "container": "debian:bullseye-slim", + "entrypoint": "\/bin\/bash" + } + }, + "variables": [ + { + "name": "Save File", + "description": "Save file (.sv4 \/ .sv6 \/ .park) to load. Can be a file path or can be a webhosted file URL. An existing save file must be specified; the server cannot generate a new scenario\/save from scratch.", + "env_variable": "SAVE_URI", + "default_value": "ServerData\/save\/save.park", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|min:4" + }, + { + "name": "Load Latest Autosave", + "description": "Will load the latest autosave (assuming one is present) *instead* of the Save File when the server is started. Useful for loading the latest progress of a park after a reboot. Set to \"false\" to \"lock\" progress of the park, and always load the original Save File on start up.", + "env_variable": "LOAD_AUTOSAVE", + "default_value": "true", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false" + }, + { + "name": "Autosave Interval", + "description": "0 = Every 1 min, 1 = Every 5 min, 2 = Every 15 min, 3 = Every 30 min, 4 = Every hour, 5 = Never", + "env_variable": "AUTOSAVE_INTERVAL", + "default_value": "1", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,5" + }, + { + "name": "Autosaves To Keep", + "description": "Number of autosaves to keep before rolling over and deleting the oldest one. Set to 0 to disable autosaving.", + "env_variable": "AUTOSAVE_AMOUNT", + "default_value": "10", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|min:0" + }, + { + "name": "Max Players", + "description": "Maximum players allowed to connect to the server.", + "env_variable": "MAX_PLAYERS", + "default_value": "16", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|min:0" + }, + { + "name": "Server Password", + "description": "Password requested by the server for clients to connect. Admins do not have to enter password to join. Leave empty for no password.", + "env_variable": "SERVER_PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Advertise Server", + "description": "If set to \"false\", the server will not be advertised in the master server list, and clients must manually connect.", + "env_variable": "SERVER_ADVERTISE", + "default_value": "true", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false" + }, + { + "name": "Pause Server If No Clients", + "description": "Set to \"true\" to have the server pause simulation if no clients are on the server.", + "env_variable": "PAUSE_NO_CLIENTS", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false" + }, + { + "name": "Server Name", + "description": "Name of the server that appears in the server list.", + "env_variable": "SERVER_NAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Server Description", + "description": "Description of the server that appears when hovering over the server in the server list.", + "env_variable": "SERVER_DESCRIPTION", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Server Player Name", + "description": "The server appears as a player in the player list. This is the name it will have.", + "env_variable": "SERVER_PLAYER_NAME", + "default_value": "Server", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Server Greeting", + "description": "The \"Message of the Day\" that gets sent to all clients who join.", + "env_variable": "SERVER_GREETING", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Provider Name", + "description": "Server provider name that appears in server information window.", + "env_variable": "PROVIDER_NAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Server Provider E-Mail", + "description": "Server provider e-mail that appears in server information window.", + "env_variable": "PROVIDER_EMAIL", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Server Provider Website", + "description": "Server provider website that appears in server information window.", + "env_variable": "PROVIDER_WEBSITE", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable" + }, + { + "name": "Log Chat", + "description": "Set to \"true\" if you would like in-game chat logged to file in Data\/chatlogs.", + "env_variable": "LOG_CHAT", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false" + }, + { + "name": "Log Server Actions", + "description": "Set to \"true\" if you would like in-game actions logged to file in Data\/serverlogs.", + "env_variable": "LOG_SERVER_ACTIONS", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false" + }, + { + "name": "OpenRCT2 Version", + "description": "The release tag (version) of OpenRCT2 to download and install from their official Github (ie. \"v0.3.5.1\"). Use \"latest\" to download the latest release, or \"develop\" to build from the latest source (takes longer to install but is the most up to date).", + "env_variable": "VERSION", + "default_value": "develop", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|min:1" + } + ] +} \ No newline at end of file diff --git a/game_eggs/tycoon_games/openrct2/save.park b/game_eggs/tycoon_games/openrct2/save.park new file mode 100644 index 00000000..a634de47 Binary files /dev/null and b/game_eggs/tycoon_games/openrct2/save.park differ