{"meta":{"slug":"pterodactyl-arma-reforger","name":"Pterodactyl Arma Reforger","category":"arma","source":"pelican","owner":"pelican-eggs","repo":"games-steamcmd","branch":"main","path":"arma/arma_reforger/egg-pterodactyl-arma-reforger.json","rawUrl":"https://raw.githubusercontent.com/pelican-eggs/games-steamcmd/main/arma/arma_reforger/egg-pterodactyl-arma-reforger.json","indexedAt":1792246788483},"egg":{"_comment":"DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO","meta":{"version":"PTDL_v2","update_url":null},"exported_at":"2025-08-22T11:47:36+00:00","name":"Arma Reforger","author":"red_thirten@yahoo.com","description":"Experience authentic Cold War combat and join friends in the struggle for a sprawling, 51 km² mid-Atlantic island — or take on the role of Game Master and create your very own scenarios for others to enjoy.","features":["steam_disk_space"],"docker_images":{"ghcr.io/parkervcp/steamcmd:debian":"ghcr.io/parkervcp/steamcmd:debian"},"file_denylist":[],"startup":"sed -i 's/\"true\"/true/g; s/\"false\"/false/g' config.json; ./ArmaReforgerServer -gproj ./addons/data/ArmaReforger.gproj -config ./config.json -profile ./profile -backendlog -nothrow -listScenarios -logStats $(({{LOG_INTERVAL}}*1000)) -maxFPS {{MAX_FPS}} -addonTempDir ./tmp","config":{"files":"{\n    \"config.json\": {\n        \"parser\": \"json\",\n        \"find\": {\n            \"bindAddress\": \"0.0.0.0\",\n            \"bindPort\": \"{{server.build.default.port}}\",\n            \"publicAddress\": \"{{server.build.default.ip}}\",\n            \"publicPort\": \"{{server.build.default.port}}\",\n            \"game.name\": \"{{server.build.env.SERVER_NAME}}\",\n            \"game.password\": \"{{server.build.env.SERVER_PASS}}\",\n            \"game.passwordAdmin\": \"{{server.build.env.ADMIN_PASS}}\",\n            \"game.scenarioId\": \"{{server.build.env.SCENARIO_ID}}\",\n            \"game.maxPlayers\": \"{{server.build.env.MAX_PLAYERS}}\",\n            \"game.visible\": \"{{server.build.env.VISIBLE}}\",\n            \"game.gameProperties.disableThirdPerson\": \"{{server.build.env.DISABLE_THIRD}}\",\n            \"game.gameProperties.fastValidation\": true,\n            \"game.gameProperties.battlEye\": \"{{server.build.env.BATTLEYE}}\"\n        }\n    }\n}","startup":"{\n    \"done\": \"Starting RPL server\"\n}","logs":"{}","stop":"^C"},"scripts":{"installation":{"script":"#!/bin/bash\r\n\r\n## File: Pelican Arma Reforger Egg - egg-arma-reforger.json\r\n## Author: David Wolfe (Red-Thirten)\r\n## Date: 2024/11/28\r\n## License: MIT License\r\n## Image to install with is 'ghcr.io/parkervcp/installers:debian'\r\n\r\n## Download and install SteamCMD\r\nexport HOME=/mnt/server\r\ncd /tmp\r\nmkdir -p $HOME/steamcmd $HOME/steamapps\r\ncurl -sSL -o steamcmd.tar.gz https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz\r\ntar -xzvf steamcmd.tar.gz -C $HOME/steamcmd\r\ncd $HOME/steamcmd\r\n\r\n# Workaround for experimental\r\nif [[ \"${SRCDS_APPID}\" == \"1890870\" ]]; then\r\n    WINDOWS_INSTALL=\"1\"\r\nfi\r\n\r\n# SteamCMD fails otherwise for some reason, even running as root.\r\nchown -R root:root /mnt\r\n\r\n# Install/Verify game server using SteamCMD\r\n./steamcmd.sh +force_install_dir $HOME +login anonymous $( [[ \"${WINDOWS_INSTALL}\" == \"1\" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} +app_update 1007 $( [[ -z ${SRCDS_BETAID} ]] || printf %s \"-beta ${SRCDS_BETAID}\" ) $( [[ -z ${SRCDS_BETAPASS} ]] || printf %s \"-betapassword ${SRCDS_BETAPASS}\" ) validate +quit\r\n\r\n# Set up 32 and 64 bit libraries\r\nmkdir -p /mnt/server/.steam/sdk{32,64}\r\ncp -v linux32/steamclient.so /mnt/server/.steam/sdk32/steamclient.so\r\ncp -v linux64/steamclient.so /mnt/server/.steam/sdk64/steamclient.so\r\n\r\n## Arma Reforger setup\r\n# Check for successful installation\r\nif [[ ! -f \"$HOME/ArmaReforgerServer\" && ! -f \"$HOME/ArmaReforgerServer.exe\" ]]; then\r\n    echo -e \"\\n\\nSteamCMD failed to install the Arma Reforger Dedicated Server!\"\r\n    echo -e \"\\tTry reinstalling the server again.\\n\"\r\n    exit 1\r\nfi\r\n\r\nmkdir -p $HOME/profile $HOME/tmp\r\n\r\necho -e 'Creating default \"config.json\" configuration file...'\r\ncat > $HOME/config.json << EOF\r\n{\r\n\t\"bindAddress\": \"0.0.0.0\",\r\n\t\"bindPort\": ${SERVER_PORT},\r\n\t\"publicAddress\": \"${SERVER_IP}\",\r\n\t\"publicPort\": ${SERVER_PORT},\r\n\t\"game\": {\r\n\t\t\"name\": \"${SERVER_NAME}\",\r\n\t\t\"password\": \"${SERVER_PASS}\",\r\n\t\t\"passwordAdmin\": \"${ADMIN_PASS}\",\r\n\t\t\"admins\" : [],\r\n\t\t\"scenarioId\": \"${SCENARIO_ID}\",\r\n\t\t\"maxPlayers\": ${MAX_PLAYERS},\r\n\t\t\"visible\": ${VISIBLE},\r\n\t\t\"gameProperties\": {\r\n\t\t\t\"serverMaxViewDistance\": 1600,\r\n\t\t\t\"serverMinGrassDistance\": 50,\r\n\t\t\t\"networkViewDistance\": 1500,\r\n\t\t\t\"disableThirdPerson\": ${DISABLE_THIRD},\r\n\t\t\t\"fastValidation\": true,\r\n\t\t\t\"battlEye\": ${BATTLEYE},\r\n\t\t\t\"VONDisableUI\": false,\r\n\t\t\t\"VONDisableDirectSpeechUI\": false\r\n\t\t},\r\n\t\t\"mods\": []\r\n\t}\r\n}\r\nEOF\r\n\r\necho -e \"\\nArma Reforger Dedicated Server successfully installed!\\n\"","container":"ghcr.io/parkervcp/installers:debian","entrypoint":"/bin/bash"}},"variables":[{"name":"Admin Password","description":"","env_variable":"ADMIN_PASS","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string|max:32","field_type":"text"},{"name":"Automatic Updates","description":"Quickly checks for any server or mod updates on startup, and updates if necessary.","env_variable":"AUTO_UPDATE","default_value":"1","user_viewable":true,"user_editable":true,"rules":"boolean","field_type":"text"},{"name":"Disable Third Person","description":"","env_variable":"DISABLE_THIRD","default_value":"false","user_viewable":true,"user_editable":true,"rules":"required|string|in:true,false","field_type":"text"},{"name":"Enable BattlEye","description":"Enables the anti-cheat engine on the server and requires all clients to be running it.","env_variable":"BATTLEYE","default_value":"true","user_viewable":true,"user_editable":true,"rules":"required|string|in:true,false","field_type":"text"},{"name":"Max Players","description":"Maximum number of players allowed to join the server.","env_variable":"MAX_PLAYERS","default_value":"32","user_viewable":true,"user_editable":true,"rules":"required|integer|between:1,256","field_type":"text"},{"name":"Scenario ID","description":"ID of scenario to run/play. Valid IDs can be viewed in the console upon startup of the server.","env_variable":"SCENARIO_ID","default_value":"{ECC61978EDCC2B5A}Missions/23_Campaign.conf","user_viewable":true,"user_editable":true,"rules":"required|string","field_type":"text"},{"name":"Server Name","description":"Name displayed in the server browser.","env_variable":"SERVER_NAME","default_value":"Arma Reforger Server","user_viewable":true,"user_editable":true,"rules":"required|string|max:255","field_type":"text"},{"name":"Server Password","description":"Password required for clients to enter before they can join the server. Leave empty to have no password.","env_variable":"SERVER_PASS","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string|max:32","field_type":"text"},{"name":"Visible in Server Browser","description":"Set the visibility of the server in the Server Browser.","env_variable":"VISIBLE","default_value":"true","user_viewable":true,"user_editable":true,"rules":"required|string|in:true,false","field_type":"text"},{"name":"[Advanced] Arma Reforger Dedicated Server App ID","description":"Used for installation and updates. Rarely needs to be changed.","env_variable":"SRCDS_APPID","default_value":"1874900","user_viewable":false,"user_editable":false,"rules":"required|integer","field_type":"text"},{"name":"[Advanced] Log FPS Interval","description":"How often (in seconds) to log the FPS and other debug stats to the console. Set to 0 to disable.","env_variable":"LOG_INTERVAL","default_value":"0","user_viewable":true,"user_editable":true,"rules":"required|integer|min:0","field_type":"text"},{"name":"[Advanced] Max FPS","description":"Sets a maximum FPS limit for the server, saving performance in some cases. Leave empty for no limit.","env_variable":"MAX_FPS","default_value":"120","user_viewable":true,"user_editable":true,"rules":"nullable|integer|gt:0","field_type":"text"},{"name":"[Repair] Validate Server Files","description":"\"true\" to enable; empty to disable. Validates all server files when Automatic Updates is enabled. Note: This will significantly increase server startup times, so it is recommended to only enable this when needed.","env_variable":"VALIDATE","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string","field_type":"text"}]},"readme":"# Arma Reforger\n\n## Authors / Contributors\n\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n    <tr>\n        <td align=\"center\">\n            <a href=\"https://github.com/redthirten\">\n                <img src=\"https://avatars.githubusercontent.com/u/4533989\" width=\"50px;\" alt=\"\"/><br /><sub><b>Red-Thirten</b></sub>\n            </a>\n            <br />\n            <a href=\"https://github.com/pelican-eggs/games-steamcmd/commits?author=redthirten\" title=\"Codes\">💻</a>\n            <a href=\"https://github.com/pelican-eggs/games-steamcmd/commits?author=redthirten\" title=\"Maintains\">🔨</a>\n        </td>\n        <td align=\"center\">\n            <a href=\"https://github.com/Soljian\">\n                <img src=\"https://avatars.githubusercontent.com/u/4036453\" width=\"50px;\" alt=\"\"/><br /><sub><b>Soljian</b></sub>\n            </a>\n            <br />\n            <a href=\"https://github.com/pelican-eggs/games-steamcmd/commits?author=Soljian\" title=\"Contributor\">💡</a>\n        </td>\n    </tr>\n</table>\n<!-- markdownlint-enable -->\n<!-- prettier-ignore-end -->\n\n___\n\n### Game Description\n\nFrom Bohemia Interactive's [Website](https://reforger.armaplatform.com/):\n> Experience authentic Cold War combat and join friends in the struggle for a sprawling, 51 km² mid-Atlantic island — or take on the role of Game Master and create your very own scenarios for others to enjoy.\n___\n\n### Egg Capabilities\n\n- Configurable to automatically check for server updates on start via SteamCMD. Forcing validation is also configurable.\n- Able to download and load Arma Reforger Workshop mods on startup (requires manual editing of the `config.json` file).\n- Configuration of multiple common settings in the `config.json` file via Startup Parameters:\n  - Server Name, Passwords, Scenario ID, Disable Third Person, Max FPS, and more...\n- Max Players is configurable and able to be host enforced (\\*see [Recommended Egg Modifications](#restrict-max-players)).\n- [WHMCS](https://www.whmcs.com/) compatible.\n\n___\n\n### Server Ports\n\n| Port | Default | Protocol | Required | Notes |\n|---------|---------|---------|---------|---------|\n| **Game** | 2001 | UDP | **Yes** | Primary port in Panel |\n| A2S | 17777 | UDP | No | Steam Query / Requires additional configuration in `config.json` |\n| RCON | 19999 | UDP | No | Requires additional configuration in `config.json` |\n\n___\n\n### Installation/System Requirements\n\n|  | Bare Minimum | Recommended |\n|---------|---------|---------|\n| Processor | Recent x86/64 (AMD/Intel) processor. No ARM support. | Can use up to 300-600% CPU under load with uncapped FPS (set Max FPS to prevent). |\n| RAM | 3328 MiB | 6144-8192 MiB |\n| Storage | 5 GB | 7-10 GB (or more, depending on number of mods downloaded) |\n| Network | If node is behind a NAT, will require Egg Modification (\\*see [Define Host Registered Bind Address](#define-host-registered-bind-address) | Wings Node is not behind a NAT |\n| Game Ownership | Not required to start or download mods. | ---- |\n\n___\n\n### How to Add Mods\n\nCurrently, adding mods to your server is tricky because there is very little documentation and it is difficult to find mod IDs. Hopefully this will change in the future, but following these steps will get it to work:\n\n1. Open up a client copy of Arma Reforger and subscribe/download any mods you want to add to the server (at this time, I do not know of a way to find mod IDs without requiring use of the game).\n2. Once done, close the game and navigate to this folder on your computer: `My Documents\\My Games\\ArmaReforger\\addons\\`\n3. Aimlessly open each folder to find which mods you want to add and open each of their `ServerData.json` files in a text editor.\n4. Then, on your server panel, open the `config.json` file for editing.\n5. Find `\"mods\": []` and replace it with the following:\n\n```json\n\"mods\": [\n\t{\n\t\t\"modId\": \"591AF5BDA9F7CE8B\",\n\t\t\"name\": \"Capture & Hold\",\n\t\t\"version\": \"1.0.0\"\n\t},\n\t{\n\t\t\"modId\": \"9A51598BACFBFDE7\",\n\t\t\"name\": \"Explosive Goats Beta\",\n\t\t\"version\": \"0.5.42\"\n\t}\n]\n```\n\n6. Change `modId` to equal the `id` value found at the top of the `ServerData.json` file you found.\n7. Change `name` to equal the `name` value found at the **top** of the `ServerData.json` file you found.\n8. Change `version` to equal the `version` value found at the top of the `ServerData.json` file you found.\n9. Repeat for each mod you want to add by copy/pasting the `{}` sections like shown above. Make sure each `{}` section has a `,` after it, **except** for the last item.\n\nThe server will automatically download and run the mods you specify on startup. For mods that add scenarios, you can find the Scenario IDs listed as `gameId` in the `ServerData.json` file. Lastly, if a mod updates, you will likely have to change the `version` value to match it's new version. You may also have to delete the mod folder in the `addons/` directory to have it re-download (reports on this have been mixed).\n\n___\n\n### Recommended Egg Modifications\n\nThe following are highly recommended variable modifications you can make to the egg after importing it to your panel.\n\n#### Define Host Registered Bind Address\n\nDue to a current behavior of the Panel, `SERVER_IP` will not return the node's public IP address if it is behind a NAT; it will return its private IP address. Unfortunately at this time, Arma Reforger **requires** the server's public IP address to be strictly defined within `config.json`. If you know your node is behind a NAT (or you are finding your node's private IP address being added to `config.json`), you will need to edit this egg after importing it by following these steps:\n\n1. As a panel admin, find and open the egg within your Nests tab.\n2. On the first tab \"Configuration\", find the \"Configuration Files\" box under the \"Process Management\" section.\n3. Carefully (as to not touch anything else), find `{{server.build.default.ip}}` and replace it with your node's public IP address. If done correctly, the line should now look something like this:\n\n```json\n\"publicAddress\": \"123.4.56.789\",\n```\n\n#### Restrict Max Players\n\nIf you would like to restrict the maximum number of players that can join your client's server, you can change the permissions of the \"Max Players\" variable so that clients can only view this value (and not edit it). It's default value can also be changed, or the value can be changed on a server-by-server basis as desired.\n"}