{"meta":{"slug":"arma3","name":"Arma3","category":"arma","source":"pterodactyl","owner":"pterodactyl","repo":"game-eggs","branch":"main","path":"arma/arma3/egg-arma3.json","rawUrl":"https://raw.githubusercontent.com/pterodactyl/game-eggs/main/arma/arma3/egg-arma3.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":"2024-01-13T21:10:57+01:00","name":"Arma 3","author":"red_thirten@yahoo.com","description":"Experience true combat gameplay in a massive military sandbox. Deploying a wide variety of single and multiplayer content, over 20 vehicles and 40 weapons, and limitless opportunities for content creation, this is the PC's premier military game. Authentic, diverse, open - Arma 3 sends you to war.","features":["steam_disk_space"],"docker_images":{"ghcr.io/ptero-eggs/games:arma3":"ghcr.io/ptero-eggs/games:arma3"},"file_denylist":[],"startup":"./{{SERVER_BINARY}} -ip=0.0.0.0 -port={{SERVER_PORT}} -profiles=./serverprofile -bepath=./ -cfg=basic.cfg -config=server.cfg -mod=\\\"{{CLIENT_MODS}}\\\" -serverMod=\\\"{{SERVERMODS}}\\\" \\\"{{STARTUP_PARAMS}}\\\"","config":{"files":"{\r\n    \"server.cfg\": {\r\n        \"parser\": \"file\",\r\n        \"find\": {\r\n            \"password=\": \"password = \\\"{{env.SERVER_PASSWORD}}\\\";\",\r\n            \"//password=\": \"password = \\\"{{env.SERVER_PASSWORD}}\\\";\",\r\n            \"password =\": \"password = \\\"{{env.SERVER_PASSWORD}}\\\";\",\r\n            \"//password =\": \"password = \\\"{{env.SERVER_PASSWORD}}\\\";\",\r\n            \"maxPlayers\": \"maxPlayers = {{env.MAX_PLAYERS}};\",\r\n            \"headlessClients\": \"headlessClients[] = { \\\"127.0.0.1\\\" };\",\r\n            \"localClient\": \"localClient[] = { \\\"127.0.0.1\\\" };\"\r\n        }\r\n    }\r\n}","startup":"{\r\n    \"done\": \"Host identity created.\"\r\n}","logs":"{}","stop":"^C"},"scripts":{"installation":{"script":"#!/bin/bash\r\n\r\n## File: Pterodactyl Arma 3 Egg - egg-arma3.json\r\n## Author: David Wolfe (Red-Thirten)\r\n## Date: 2022/05/22\r\n## License: MIT License\r\n## Image to install with is 'ghcr.io/ptero-eggs/installers:debian'\r\n\r\n# Install packages. Default packages below are skipped if using image noted above, thus speeding up the install process.\r\napt -y update\r\napt -y --no-install-recommends install curl lib32gcc-s1 ca-certificates\r\n\r\n# Check for valid Steam credentials to download Arma 3 with (requires valid Steam account)\r\nif [[ \"${STEAM_USER}\" == \"\" ]] || [[ \"${STEAM_USER}\" == \"anonymous\" ]] || [[ \"${STEAM_PASS}\" == \"\" ]]; then\r\n    echo -e \"INSTALLATION ERROR: A valid REAL Steam account is required to download the Arma 3 Dedicated Server.\"\r\n    echo -e \"\\t(\\\"anonymous\\\" account cannot be used. Game ownership is not required.)\"\r\n    exit 1\r\nfi\r\n\r\n# Download and install SteamCMD\r\ncd /tmp\r\nmkdir -p /mnt/server/steamcmd /mnt/server/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 /mnt/server/steamcmd\r\ncd /mnt/server/steamcmd\r\n\r\n# SteamCMD fails otherwise for some reason, even running as root.\r\n# This is changed at the end of the install process anyways.\r\nchown -R root:root /mnt\r\nexport HOME=/mnt/server\r\n\r\n# Install game server using SteamCMD\r\n./steamcmd.sh +force_install_dir /mnt/server \"+login \\\"${STEAM_USER}\\\" \\\"${STEAM_PASS}\\\"\" +app_update ${STEAMCMD_APPID} ${STEAMCMD_EXTRA_FLAGS} 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 3 setup\r\ncd /mnt/server/\r\n[[ -f basic.cfg ]] || curl -sSLO ${BASIC_URL}\r\n[[ -f server.cfg ]] || curl -sSLO ${BASIC_URL%/*}/server.cfg\r\nchmod 644 basic.cfg server.cfg\r\n\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"","container":"ghcr.io/ptero-eggs/installers:debian","entrypoint":"/bin/bash"}},"variables":[{"name":"[REQUIRED] Steam Username","description":"Used for installation and updates. Account does not need to own Arma 3, but MUST BE a VALID Steam account (anonymous login cannot be used). For security reasons it is recommended that you create a new Steam account just for your dedicated servers. *This info is not visible to the server owner.*","env_variable":"STEAM_USER","default_value":"your_steam_username","user_viewable":false,"user_editable":false,"rules":"required|string","field_type":"text"},{"name":"[REQUIRED] Steam Password","description":"Used for installation and updates. Steam Guard MUST be completely TURNED OFF for install to complete successfully. *This info is not visible to the server owner, BUT IS stored in PLAIN TEXT. It is NOT advised to use a personal account; best to use a dummy account.*","env_variable":"STEAM_PASS","default_value":"your_steam_password","user_viewable":false,"user_editable":false,"rules":"required|string","field_type":"text"},{"name":"Number of SteamCMD Retry Attempts","description":"How many times SteamCMD should retry downloading a server or mod after a recoverable error. (ie. A particularly large mod like CUP or RHS download times out)","env_variable":"STEAMCMD_ATTEMPTS","default_value":"3","user_viewable":false,"user_editable":false,"rules":"required|integer","field_type":"text"},{"name":"Server Binary","description":"Server binary to call on server start. (32-bit: arma3server | 64-bit: arma3server_x64)","env_variable":"SERVER_BINARY","default_value":"arma3server_x64","user_viewable":true,"user_editable":true,"rules":"required|string|in:arma3server,arma3server_x64,arma3serverprofiling,arma3serverprofiling_x64","field_type":"text"},{"name":"Extra Startup Parameters","description":"See https://community.bistudio.com/wiki/Arma_3_Startup_Parameters for more info on valid flags for this field. \"-noLogs\" is recommended to prevent console rate-limit warnings.","env_variable":"STARTUP_PARAMS","default_value":"-noLogs","user_viewable":true,"user_editable":true,"rules":"string|nullable","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|gt:0","field_type":"text"},{"name":"Server Password","description":"Password required to join the server. Leave blank to have no password.","env_variable":"SERVER_PASSWORD","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string","field_type":"text"},{"name":"Automatic Updates","description":"Quickly checks for any server or mod updates on startup, and updates if necessary. (1 Enable | 0 Disable)","env_variable":"UPDATE_SERVER","default_value":"1","user_viewable":true,"user_editable":true,"rules":"boolean","field_type":"text"},{"name":"Disable Mod Downloads/Updates","description":"If the Steam account does not own the base Arma 3 game, Steam Workshop mod downloads/updates will not work. If so, this setting allows disabling of this feature to avoid errors. (1 Disable | 0 Enable)","env_variable":"DISABLE_MOD_UPDATES","default_value":"0","user_viewable":false,"user_editable":false,"rules":"boolean","field_type":"text"},{"name":"Download Creator DLCs","description":"Downloads/Updates all the mod files required to run any CDLC during the next Automatic Update. DLCs can be enabled by adding their mod folder name to the Additional Mods startup variable. For example, add \"vn;\" to load the Prairie Fire CDLC. (1 Yes | 0 No)","env_variable":"CDLC","default_value":"0","user_viewable":true,"user_editable":true,"rules":"boolean","field_type":"text"},{"name":"Modlist File (Exported from A3 Launcher)","description":"Filename for an exported modlist. This file will be parsed for mod installation and loading. Upload your HTML file to the root directory (eg. /home/container/modlist.html). Leave blank to disable loading mods from a modlist.","env_variable":"MOD_FILE","default_value":"modlist.html","user_viewable":true,"user_editable":true,"rules":"nullable|string","field_type":"text"},{"name":"Additional Mods","description":"A semicolon-separated list of additional mod folders to load. Useful for loading CDLCs or manually uploaded mods. This mod list will be loaded in addition to the Modlist File (if used). Any mods in this list that are in \"@workshopID\" form will also be included in Automatic Updates (if enabled). NO capital letters, spaces, or folders starting with a number! (ex. myMod;vn;@123456789;@987654321;etc;)","env_variable":"MODIFICATIONS","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string","field_type":"text"},{"name":"[Repair] Make Mod Files Lowercase","description":"Every mod that is set to be loaded will have its folder and files changed to lowercase (to prevent errors). It is recommended to enable this for one server boot after copying a mod from a Windows machine to the server, or if mods seem to not be loading. (1 Enable | 0 Disable)","env_variable":"MODS_LOWERCASE","default_value":"0","user_viewable":true,"user_editable":true,"rules":"boolean","field_type":"text"},{"name":"[Repair] Validate Server Files","description":"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. (1 Enable | 0 Disable)","env_variable":"VALIDATE_SERVER","default_value":"0","user_viewable":true,"user_editable":true,"rules":"boolean","field_type":"text"},{"name":"[Advanced] Server-Side Only Mods","description":"Mod folders to be used with the \"-serverMods\" startup option. They only run server-side and are not required by clients if \"verifySignatures\" is enabled. Any mods in this list that are in \"@workshopID\" form will also be included in Automatic Updates (if enabled). NO capital letters, spaces, or folders starting with a number! Each folder must be followed with a semicolon (ex. @123456789;@987654321;etc;)","env_variable":"SERVERMODS","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string","field_type":"text"},{"name":"[Advanced] Optional Client-Side Mods","description":"A semicolon-separated list of optional mods to load into the keys folder, but not include in server's mod parameter. Useful for allowing clients to connect to the server with or without the mod loaded. Mods in this list must be in \"@workshopID\" form (ex. @123456789;@987654321;). These will also be included in Automatic Updates (if enabled).","env_variable":"OPTIONALMODS","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string","field_type":"text"},{"name":"[Advanced] Extra Flags for SteamCMD","description":"[This will override \"Download Creator DLCs\" if used] Only used when checking for server updates, and typically used for grabbing beta builds. Example: -beta profiling -betapassword CautionSpecialProfilingAndTestingBranchArma3","env_variable":"STEAMCMD_EXTRA_FLAGS","default_value":"","user_viewable":true,"user_editable":true,"rules":"nullable|string","field_type":"text"},{"name":"[Advanced] Headless Clients (HC)","description":"Number of Headless Clients (0 - 5) to launch parallel with the server. Be sure to set the following \"HC Connect Password\" variable if your server is password locked. PLEASE NOTE: Using a headless client is only recommended for advanced users, adds extra overhead to your permitted server resources, and is only beneficial if a properly written, HC compliant, mission file is provided. See https://community.bistudio.com/wiki/Arma_3:_Headless_Client for more info.","env_variable":"HC_NUM","default_value":"0","user_viewable":true,"user_editable":true,"rules":"required|integer|between:0,5","field_type":"text"},{"name":"[Advanced] HC Hide Console Output","description":"Hides Headless Client console output (except for critical errors) to prevent nonessential console spam. (1 Hide | 0 Show)","env_variable":"HC_HIDE","default_value":"1","user_viewable":true,"user_editable":true,"rules":"boolean","field_type":"text"},{"name":"[Advanced] Clear HC Profiles Cache on Startup","description":"Deletes all profiles from the \"/home/container/serverprofile/home\" directory on startup, except for the server's main \"Player\" profile. Recommended to enable when running HCs, because the profiles are generally unused and can cause HCs to crash if they develop errors. (1 Enable | 0 Disable)","env_variable":"CLEAR_CACHE","default_value":"0","user_viewable":true,"user_editable":true,"rules":"boolean","field_type":"text"},{"name":"[Advanced] Arma 3 Dedicated Server App ID","description":"Used for installation and updates. Rarely needs to be changed.","env_variable":"STEAMCMD_APPID","default_value":"233780","user_viewable":false,"user_editable":false,"rules":"required|integer","field_type":"text"},{"name":"[Advanced] basic.cfg URL","description":"URL to a valid Arma 3 basic.cfg file. The \"Basic\" configuration file is used during server runtime for advanced network performance tuning. Because it is a required file, this URL is used to download it during installation, or if the file is found missing during startup.","env_variable":"BASIC_URL","default_value":"https://raw.githubusercontent.com/ptero-eggs/game-eggs/main/arma/arma3/egg-arma3-config/basic.cfg","user_viewable":false,"user_editable":false,"rules":"required|url","field_type":"text"}]},"readme":"# Arma 3\n\n***Updating your Egg? Please see [How to Update Egg](#how-to-update-egg) to avoid any issues!***\n___\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/lilkingjr1\">\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/parkervcp/eggs/commits?author=lilkingjr1\" title=\"Codes\">💻</a>\n        </td>\n        <td align=\"center\">\n            <a href=\"https://github.com/aussieserverhosts\">\n                <img src=\"https://avatars.githubusercontent.com/u/65438932\" width=\"50px;\" alt=\"\"/><br /><sub><b>Aussie Server Hosts</b></sub>\n            </a>\n            <br />\n            <a href=\"https://github.com/parkervcp/eggs/commits?author=aussieserverhosts\" title=\"Codes\">💻</a>\n            <a href=\"https://github.com/parkervcp/eggs/commits?author=aussieserverhosts\" title=\"Contributor\">💡</a>\n        </td>\n        <td align=\"center\">\n            <a href=\"https://github.com/IAmSilK\">\n                <img src=\"https://avatars.githubusercontent.com/u/16708907\" width=\"50px;\" alt=\"\"/><br /><sub><b>IAmSilK</b></sub>\n            </a>\n            <br />\n            <a href=\"https://github.com/parkervcp/eggs/commits?author=IAmSilK\" title=\"Codes\">💻</a>\n            <a href=\"https://github.com/parkervcp/eggs/commits?author=IAmSilK\" title=\"Contributor\">💡</a>\n        </td>\n        <td align=\"center\">\n            <a href=\"https://github.com/Yomanz\">\n                <img src=\"https://avatars.githubusercontent.com/u/5119107\" width=\"50px;\" alt=\"\"/><br /><sub><b>Daave</b></sub>\n            </a>\n            <br />\n            <a href=\"https://github.com/parkervcp/eggs/commits?author=Yomanz\" title=\"Codes\">💻</a>\n            <a href=\"https://github.com/parkervcp/eggs/commits?author=Yomanz\" title=\"Original Creator\">⭐</a>\n            <a href=\"https://github.com/parkervcp/eggs/commits?author=Yomanz\" title=\"Retired from Development\">💤</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://arma3.com/):\n> Experience true combat gameplay in a massive military sandbox. Deploying a wide variety of single and multiplayer content, over 20 vehicles and 40 weapons, and limitless opportunities for content creation, this is the PC’s premier military game. Authentic, diverse, open - Arma 3 sends you to war.\n___\n\n### Egg Capabilities\n\n- Configurable to run 32 or 64-bit versions of the server\n- Max Players is configurable and able to be host enforced (\\*see [Recommended Egg Modifications](#recommended-egg-modifications))\n- Able to download server updates on startup\n- Able to download, update, and load Steam Workshop mods on startup (\\*see [Installation Requirements](#installation-requirements))\n  - Accepts uploaded HTML modlist files exported from the Arma 3 Launcher to define mods to load on the server.\n  - Also accepts manually listed mods, CDLCs, and server-side only mods.\n  - Checks for mod updates against their Steam Workshop page's last update for quick and efficient update checks.\n  - Automatically moves mod `.bikey`'s to the `/keys/` directory.\n- Configurable to download Creator DLCs\n- Configurable to run Beta/Performance binaries of the server (if desired; advanced users only)\n- Additional [Arma 3 startup parameters](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters) can be added to fine-tune performance\n- Configurable to run up to 5 Headless Clients in parallel with the main server (may require additional performance overhead)\n- [WHMCS](https://www.whmcs.com/) compatible (\\*see [Recommended Egg Modifications](#recommended-egg-modifications))\n\n___\n\n### Installation Requirements\n\n- A valid, **real** Steam account, with **Steam Guard turned off**, is required to install the server (default \"anonymous\" login cannot be used). This account *does not* need to own Arma 3. For security reasons it is [recommended by Valve](https://developer.valvesoftware.com/wiki/SteamCMD#With_a_Steam_account) that you create a new Steam account just for your dedicated servers.\n- For automatic Steam Workshop mod downloading to work, the Steam account *does* need to own Arma 3. However, this is optional functionality, and mods can be manually uploaded to the server if desired. Hosts may feel free to change the \"Disable Mod Downloads/Updates\" variable to `1` if they would not like to offer it's functionality to clients.\n\n___\n\n### Server Ports\n\nDefault server ports are listed below, but the Main port can be any port. There are three more ports after the Main port that are relative to the Main port (For example: The BattlEye port is always 4 ports higher than the Main port). **All four ports are required for normal server behavior.** It is [recommended](https://community.bistudio.com/wiki/Arma_3:_Dedicated_Server#Port_Forwarding) that each server be 100 ports separate from each other.\n\n| Port | Default (UDP) |\n|---------|---------|\n| **Arma 3 Game & VON (Main)** | 2302 |\n| Steam Query (+1) | 2303 |\n| Steam Port (+2) | 2304 |\n| BattleEye (+4) | 2306 |\n\n___\n\n### Installation/System Requirements\n\n|  | Bare Minimum | Recommended |\n|---------|---------|---------|\n| Processor | Recent x86/64 (AMD/Intel) processor. No ARM support. | ARMA 3 is mainly CPU intensive. Contrary to popular belief, the server binary *can* run on multiple cores/threads. However, it's ability to manage asynchronous tasks and hyperthread is *very* limited, meaning additional cores/threads reach diminishing returns very quickly. In addition, it's ability to utilize all of the CPU allotted to it for AI processing seems to be limited as well. Therefore, a Headless Client ***and*** a properly written mission file are highly recommended if large amounts of AI units will be used. |\n| RAM | 2048 MiB | 3072 MiB (If used, every Headless Client uses an additional 2048 MB of RAM as well) |\n| Storage | 10 GB | 50+ GB (depends on how many mods are installed) |\n| Network | 0.512 Mbit/s/player | 1-5 Mbit/s/player |\n| Host OS | Most stable Linux OS branches should work | Using the latest kernel version for your installed OS can prevent some edge-case installation/boot issues. |\n\n___\n\n### RCON\n\nExternal/Compatible RCON clients can be used to connect to the server if the following requirements are met:\n\n1. An extra port is forwarded and assigned to the server in Pterodactyl. It is recommended to use the +5 port from the Main port (ie. if Main port is 2032, RCON port would be 2037). The +3 port **cannot** be used as it is reserved.\n2. `server.cfg` has `BattlEye = 1;`. Unfortunately, RCON cannot be used with BattlEye off.\n3. A `beserver_x64.cfg` file (or `beserver.cfg` if using 32-bit) is added to `/home/container/battleye/launch` with the following content:\n```\nRConPassword your_rcon_password\nRConPort your_rcon_port\n```\n\n___\n\n### Mounting Workshop Mods\n\nServer hosts may wish to save space and avoid download issues by mounting large and/or common mods. Unfortunately, Arma only allows mods to be loaded from directories down-stream of the server binary (ie. `/home/container/*`. Docker limitations disallow Pterodactyl from mounting mounts into `/home/container/*`. The only way around this that I can think of is to create a symlink with a destination that is outside of this location. If anyone knows a way around this, please open an Issue to let us know.\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. While viewing this egg, simply go to the \"Variables\" tab of the egg editor to make these changes.\n\n#### Default Steam Username & Password\n\n- To make deploying servers easy (**or if you are using WHMCS**), it is recommended to edit the default values of \"Steam Username\" and \"Steam Password\" to your Steam account dedicated for hosting. This will make all newly installed servers use these credentials. **DO NOT** make these fields visible to the end user so that they can use their own Steam accounts; the panel will save their Steam credentials in **plain text**, which is a BIG NO NO for security and privacy.\n\n#### Restrict Max Players\n\n- If 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___\n\n### How to Update Egg\n\nIf you already have an Arma 3 egg installed on your panel, there are a couple things to consider before updating to this egg:\n- The Startup Command has changed, but Pterodactyl currently does not update this across all your existing servers. Servers will still boot with their old Startup Command, but the new HTML Modlist feature will not work, and depreciated variables for config files will be used. Servers will have to be manually updated to the new Startup Command via the Startup tab.\n- Startup Variables have been completely rehauled. While most important existing variables have retained their Environment Variable names, a lot of their titles and order have been adjusted. Simply updating your existing egg with this egg may lead to Startup Variables being terribly out of order and cluttered. Therefore, the following steps are recommended to avoid this:\n  1. Change the name of your existing Arma 3 egg to \"Arma 3 (Old)\".\n  2. Install this updated egg as a new egg in your nest.\n  3. Make any egg modifications you would like. (\\*see [Recommended Egg Modifications](#recommended-egg-modifications))\n  4. Change all existing Arma 3 servers to the new egg via the Startup tab.\n  5. Delete the old egg.\n"}