From 64ee85a6ac7363edc75e0caf4ba7701b40401238 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:00:49 -0700 Subject: [PATCH 01/17] Update README.md - Added info on new Egg Capabilities - Added info on Recommended Egg Modifications - Rearranged topics in order of importance - Rewording to make things more clear - Grammar and spell checking --- .../steamcmd_servers/arma/arma3/README.md | 52 ++++++++++++------- 1 file changed, 32 insertions(+), 20 deletions(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/README.md b/game_eggs/steamcmd_servers/arma/arma3/README.md index 968ee770..dae5172e 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/README.md +++ b/game_eggs/steamcmd_servers/arma/arma3/README.md @@ -3,30 +3,26 @@ 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. ### Egg Capabilities -- Configurable to run 32 or 64-bit versions of the server. -- Configurable to run Beta/Performance binaries of the server (if desired; advanced users only). -- Able to download server updates. -- Able to download Steam Workshop mods\* and move `.bikey`'s to the `/keys/` directory (\*see Installation Requirements). -- Configurable to run up to 5 Headless Clients in parallel with the main server (may require additional performance overhead). +- Configurable to run 32 or 64-bit versions of the server +- Max Players is configurable and able to be host enforced (\*see Recommended Egg Modifications) +- Able to download server updates on startup +- Able to download, update, and load Steam Workshop mods on startup (\*see Installation Requirements) + - Accepts uploaded HTML modlist files exported from the Arma 3 Launcher to define mods to load on the server. + - Also accepts manually listed mods, CDLCs, and server-side only mods. + - Checks for mod updates against their Steam Workshop page's last update for quick and efficient update checks. + - Automatically moves mod `.bikey`'s to the `/keys/` directory. +- Configurable to download Creator DLCs +- Configurable to run Beta/Performance binaries of the server (if desired; advanced users only) +- Additional [Arma 3 startup parameters](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters) can be added to fine-tune performance +- Configurable to run up to 5 Headless Clients in parallel with the main server (may require additional performance overhead) +- [WHMCS](https://www.whmcs.com/) compatible (\*see Recommended Egg Modifications) ### Installation Requirements -- A valid, real Steam account, with **Steam Guard turned off**, is required to install the server (default "anonymous" login cannot be used). For security reasons it is [recommended](https://developer.valvesoftware.com/wiki/SteamCMD#With_a_Steam_account) that you create a new Steam account just for your dedicated servers. This account *does not* need to own Arma 3. -- For automatic Steam Workshop mod downloading to work, the Steam account *does* need to own Arma 3. This is, of course, optional functionality, and mods can be manually uploaded to the server if desired. Hosts may feel free to delete the "Steam Workshop Mods to Download/Update" variable if they would not like to offer it's functionallity. - -### Minimum RAM Warning -This server requires about 2048 MB of RAM to run properly. If used, every Headless Client uses an additional 2048 MB of RAM as well. - -### CPU Usage Information -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 alloted 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. - -### Additional Settings -Additional server flags can be found [here](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters). -These can help you fine tune how the server will behave during runtime. - -*Note: The `-maxMem=` flag is currently known to cause an unknown segmentaion fault crash on startup. Other hardware related flags may cause similar behavior.* +- A valid, **real** Steam account, with **Steam Guard turned off**, is required to install the server (default "anonymous" login cannot be used). 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. This account *does not* need to own Arma 3. +- 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. ### Server Ports -Default server ports. **All ports are required.** Ports after the Main port are relative to the main port (For example: The BattlEye port is always 4 ports higher than the main port). It is [recommended](https://community.bistudio.com/wiki/Arma_3:_Dedicated_Server#Port_Forwarding) that each server be 100 ports seperate from each other. +Default server ports are listed below, but the Main port can be any port. There are three more ports after the Main port 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. | Port | Default | |---------|---------| @@ -36,3 +32,19 @@ Default server ports. **All ports are required.** Ports after the Main port are | BattleEye (+4) | 2306 | #### Mods/Plugins may require ports to be added to the server. + +### CPU Usage Information +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. + +### Minimum RAM Requirement +This server requires about 2048 MB of RAM to run properly. If used, every Headless Client uses an additional 2048 MB of RAM as well. + +### Minimum Disk Requirement +This server requires just under 10 GB of disk space to safely run properly with no mods. However, mods can easily increase disk usage to 50 GB or more, depending on how many are downloaded. + +### Recommended Egg Modifications +The 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. +#### Default Steam Username & Password +- 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. +#### Restrict Max Players +- 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. From 18b533570b7e2911f42d774cfdc190b83811336a Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:05:35 -0700 Subject: [PATCH 02/17] Update README.md - Removed references to old/defunct Arma 3 eggs --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 3fa99605..5f2d7689 100644 --- a/README.md +++ b/README.md @@ -161,8 +161,6 @@ If you are reading this it looks like you are looking to add an egg to your serv * [ARK: Survival Evolved](game_eggs/steamcmd_servers/ark_survival_evolved) * [Arma](game_eggs/steamcmd_servers/arma) * [Arma 3](game_eggs/steamcmd_servers/arma/arma3) - * [Arma 3 64 Bit](game_eggs/steamcmd_servers/arma/arma3_x64) - * [Arma 3 Headless Client](game_eggs/steamcmd_servers/arma/arma3_headless_client) * [Assetto Corsa](game_eggs/steamcmd_servers/assetto_corsa) * [Avorion](game_eggs/steamcmd_servers/avorion) * [Barotrauma](game_eggs/steamcmd_servers/barotrauma) From 8fb71aa5da3184ea16942b5bdd86a26c61155839 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:09:15 -0700 Subject: [PATCH 03/17] Update README.md - Removed references to old/defunct Arma 3 eggs --- game_eggs/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/game_eggs/README.md b/game_eggs/README.md index cb3810d1..57a59346 100644 --- a/game_eggs/README.md +++ b/game_eggs/README.md @@ -92,8 +92,6 @@ * [ARK: Survival Evolved](steamcmd_servers/ark_survival_evolved) * [Arma](steamcmd_servers/arma) * [Arma 3](steamcmd_servers/arma/arma3) - * [Arma 3 64 Bit](steamcmd_servers/arma/arma3_x64) - * [Arma 3 Headless Client](steamcmd_servers/arma/arma3_headless_client) * [Assetto Corsa](steamcmd_servers/assetto_corsa) * [Avorion](steamcmd_servers/avorion) * [Barotrauma](steamcmd_servers/barotrauma) @@ -158,4 +156,4 @@ [Vintage Story](vintage_story/vintage_story) -[Xonotic](xonotic/xonotic) \ No newline at end of file +[Xonotic](xonotic/xonotic) From 6462981b330d7357dc0aecc2b8e75d2a69ce7b21 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:14:28 -0700 Subject: [PATCH 04/17] Update README.md - Fixed links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5f2d7689..e346726a 100644 --- a/README.md +++ b/README.md @@ -62,12 +62,12 @@ If you are reading this it looks like you are looking to add an egg to your serv * [MariaDB](/database/sql/mariadb) * [PostgreSQL](/database/sql/postgres) -## Voice Servers +## [Voice Servers](/voice_servers) * [Lavalink](/voice_servers/lavalink) * [TeaSpeak](/voice_servers/teaspeak) * [TS3-Manager](/voice_servers/ts3_manager) -## Game Eggs +## [Game Eggs](/game_eggs) [Among Us](game_eggs/among_us) * [Impostor Server](game_eggs/among_us/impostor_server) * [CrewLink Server](game_eggs/among_us/crewlink_server) From 1cc199c2711cbc785bdc8ff953c24897bbd4014e Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:16:49 -0700 Subject: [PATCH 05/17] Update README.md - Removed references to old/defunct Arma 3 eggs - Fixed title formatting --- game_eggs/steamcmd_servers/README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/game_eggs/steamcmd_servers/README.md b/game_eggs/steamcmd_servers/README.md index 4a8922dc..c7098796 100644 --- a/game_eggs/steamcmd_servers/README.md +++ b/game_eggs/steamcmd_servers/README.md @@ -1,4 +1,4 @@ -# SteamCMD Servers +# SteamCMD Servers This is a collection of servers that use SteamCMD to install. @@ -9,10 +9,7 @@ This is a collection of servers that use SteamCMD to install. [ARK: Survival Evolved](ark_survival_evolved) ## Arma -[Arma](arma) * [Arma 3](arma/arma3) - * [Arma 3 64 Bit](arma/arma3_x64) - * [Arma 3 Headless Client](arma/arma3_headless_client) ## Assetto Corsa [Assetto Corsa](assetto_corsa) @@ -129,4 +126,4 @@ This is a collection of servers that use SteamCMD to install. ## Valheim [Valheim](valheim) * [Valheim Vanilla](valheim/valheim_vanilla) - * [Valheim Plus Mod](valheim/valheim_plus) \ No newline at end of file + * [Valheim Plus Mod](valheim/valheim_plus) From 0feaf2c7e3333f28891b1ffa516e7dce8470b451 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:19:00 -0700 Subject: [PATCH 06/17] Update README.md - Small adjustments --- game_eggs/steamcmd_servers/arma/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/game_eggs/steamcmd_servers/arma/README.md b/game_eggs/steamcmd_servers/arma/README.md index 5598764f..d7f9463d 100644 --- a/game_eggs/steamcmd_servers/arma/README.md +++ b/game_eggs/steamcmd_servers/arma/README.md @@ -2,5 +2,6 @@ ARMA is a series of first-person tactical military shooters, originally released for Microsoft Windows. It features large elements of realism and simulation; a blend of large-scale military conflict spread across large areas alongside the more close quartered battles. -## Arma 3 +## Arma Titles +* Arma 2 (Egg Requested) * [Arma 3](arma3) From 27b0a3a103a107458a2580ab38be62afc09901ea Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:20:19 -0700 Subject: [PATCH 07/17] Update server.cfg - New password default value --- .../steamcmd_servers/arma/arma3/egg-arma3-config/server.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3-config/server.cfg b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3-config/server.cfg index 20c439a2..81306454 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3-config/server.cfg +++ b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3-config/server.cfg @@ -16,7 +16,7 @@ hostname = "Arma 3 Server"; // Server password - for private servers. -//password = "arma3pass"; +password = ""; // Admin Password //passwordAdmin = "ADMINPASSWORD"; From 500a91564a5dfc8de964b69d2e4b93e25be1aed5 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 16:42:07 -0700 Subject: [PATCH 08/17] egg-arma3.json Rewrite - Changed the image to the new Pterodactyl yolks image. - Removed the ability to specify custom server.cfg and basic.cfg file locations, because it only complicated things and was rarely changed from their default root location. - Added the ability to specify a custom basic.cfg URL location for installation (in case it updates in the future). - Added file parsing of the server.cfg to set the server password, max players, and ensure the headless client IPs are correct. - Fixed the stop code to actually kill the server - Adjusted the installation script to pull from the basic.cfg specified URL, and made the SteamCMD login command more robust against credentials with spaces or special characters. - Rearranged variables to be better grouped/ordered (will only apply if the egg is reinstalled on the panel). - Rewording of some variables' descriptions. - Added "Number of SteamCMD Retry Attempts" variable. - Added "Max Players" variable. - Added "Server Password" variable. - Added "Disable Mod Downloads/Updates" variable. - Added "Download Creator DLCs" variable. - Added "Modlist File" variable for defining an Arma 3 Launcher exported HTML modlist file for loading. - Renamed "Mods" to "Additional Mods" - Added "Validate Server Files" variable. - Added "HC Hide Console Output" variable. - Added "Clear HC Profiles Cache on Startup" variable. --- .../arma/arma3/egg-arma3.json | 195 +++++++++++------- 1 file changed, 124 insertions(+), 71 deletions(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json index 2a694fd7..ccffa2cb 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json +++ b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json @@ -1,45 +1,35 @@ { - "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "_comment": "Pterodactyl Arma 3 Egg ~ David Wolfe (Red-Thirten) ~ 2021-07-11", "meta": { "version": "PTDL_v1", - "update_url": null + "update_url": "https:\/\/github.com\/parkervcp\/eggs\/blob\/master\/game_eggs\/steamcmd_servers\/arma\/arma3\/egg-arma3.json" }, - "exported_at": "2021-07-02T04:17:45+03:00", "name": "Arma 3", "author": "rehlmgaming@gmail.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": null, "images": [ - "quay.io\/parkervcp\/pterodactyl-images:game_arma3" + "ghcr.io\/pterodactyl\/games:arma3" ], "file_denylist": [], - "startup": ".\/{{SERVER_BINARY}} -ip=0.0.0.0 -port={{SERVER_PORT}} -profiles=.\/serverprofile -bepath=.\/battleye -cfg=\\\"{{BASIC}}\\\" -config=\\\"{{CONFIG}}\\\" -mod=\\\"{{MODIFICATIONS}}\\\" -serverMod=\\\"{{SERVERMODS}}\\\" {{STARTUP_PARAMS}}", + "startup": ".\/{{SERVER_BINARY}} -ip=0.0.0.0 -port={{SERVER_PORT}} -profiles=.\/serverprofile -bepath=.\/battleye -cfg=basic.cfg -config=server.cfg -mod=\\\"{{CLIENT_MODS}}\\\" -serverMod=\\\"{{SERVERMODS}}\\\" {{STARTUP_PARAMS}}", "config": { - "files": "{}", + "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" + "stop": "^CC" }, "scripts": { "installation": { - "script": "#!\/bin\/bash\r\napt -y update\r\napt -y --no-install-recommends install curl lib32gcc1 ca-certificates\r\n\r\n## download and install steamcmd\r\ncd \/tmp\r\nmkdir -p \/mnt\/server\/steamcmd\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 using steamcmd\r\n.\/steamcmd.sh +login ${STEAM_USER} ${STEAM_PASS} +force_install_dir \/mnt\/server +app_update ${STEAMCMD_APPID} ${STEAMCMD_EXTRA_FLAGS} validate +quit\r\n\r\n## set up 32 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk32\r\ncp -v linux32\/steamclient.so ..\/.steam\/sdk32\/steamclient.so\r\n\r\n## set up 64 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk64\r\ncp -v linux64\/steamclient.so ..\/.steam\/sdk64\/steamclient.so\r\n\r\n## ARMA III specific setup\r\ncd \/mnt\/server\/\r\n\r\nmkdir -p \"\/mnt\/server\/.local\/share\/Arma 3\" \"\/mnt\/server\/.local\/share\/Arma 3 - Other Profiles\"\r\n\r\n[[ -f basic.cfg ]] || curl -sSLO https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/game_eggs\/steamcmd_servers\/arma\/arma3\/egg-arma3-config\/basic.cfg\r\n[[ -f server.cfg ]] || curl -sSLO https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/game_eggs\/steamcmd_servers\/arma\/arma3\/egg-arma3-config\/server.cfg\r\nchmod 755 basic.cfg server.cfg", + "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: 2021\/07\/11\r\n## License: MIT License\r\n\r\napt -y update\r\napt -y --no-install-recommends install curl lib32gcc1 ca-certificates\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 \"+login \\\"${STEAM_USER}\\\" \\\"${STEAM_PASS}\\\"\" +force_install_dir \/mnt\/server +app_update ${STEAMCMD_APPID} ${STEAMCMD_EXTRA_FLAGS} validate +quit\r\n\r\n# Set up 32 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk32\r\ncp -v linux32\/steamclient.so ..\/.steam\/sdk32\/steamclient.so\r\n\r\n# Set up 64 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk64\r\ncp -v linux64\/steamclient.so ..\/.steam\/sdk64\/steamclient.so\r\n\r\n# Arma 3 setup\r\ncd \/mnt\/server\/\r\n\r\nmkdir -p \"\/mnt\/server\/.local\/share\/Arma 3\" \"\/mnt\/server\/.local\/share\/Arma 3 - Other Profiles\"\r\n\r\n[[ -f basic.cfg ]] || curl -sSLO ${BASIC_URL}\r\n[[ -f server.cfg ]] || curl -sSLO ${BASIC_URL%\/*}\/server.cfg\r\nchmod 755 basic.cfg server.cfg", "container": "debian:buster-slim", "entrypoint": "bash" } }, "variables": [ { - "name": "Arma 3 Dedicated Server App ID", - "description": "Used for installation and updates.", - "env_variable": "STEAMCMD_APPID", - "default_value": "233780", - "user_viewable": false, - "user_editable": false, - "rules": "required|integer" - }, - { - "name": "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.*", + "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, @@ -47,14 +37,23 @@ "rules": "required|string" }, { - "name": "Steam Password", - "description": "Used for installation and updates. Steam Guard must be TURNED OFF for install to complete successfully. *This info is not visible to the server owner.*", + "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" }, + { + "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" + }, { "name": "Server Binary", "description": "Server binary to call on server start. (32-bit: arma3server | 64-bit: arma3server_x64)", @@ -66,7 +65,7 @@ }, { "name": "Extra Startup Parameters", - "description": "See https:\/\/community.bistudio.com\/wiki\/Arma_3_Startup_Parameters for more info.", + "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, @@ -74,26 +73,62 @@ "rules": "string|nullable" }, { - "name": "Server Configuration File", - "description": "See https:\/\/community.bistudio.com\/wiki\/server.cfg for more info.", - "env_variable": "CONFIG", - "default_value": "server.cfg", + "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": "string|nullable" + "rules": "required|integer|gt:0" }, { - "name": "Basic Network Configuration", - "description": "See https:\/\/community.bistudio.com\/wiki\/basic.cfg for more info.", - "env_variable": "BASIC", - "default_value": "basic.cfg", + "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": "required|string" + "rules": "nullable|string" }, { - "name": "Mods", - "description": "Mod folders to be used with the -mods startup option. NO capital letters, spaces, or folders starting with a number! Each folder must be followed with a semicolon (ex. @123456789;@987654321;etc;)", + "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" + }, + { + "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" + }, + { + "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" + }, + { + "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" + }, + { + "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, @@ -101,44 +136,35 @@ "rules": "nullable|string" }, { - "name": "Server Mods", - "description": "Server-side only mod folders to be used with the -serverMods startup option. 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" - }, - { - "name": "Check for Server Updates", - "description": "Check for server updates on server start. (1 True | 0 False)", - "env_variable": "UPDATE_SERVER", - "default_value": "0", - "user_viewable": true, - "user_editable": true, - "rules": "boolean" - }, - { - "name": "Steam Workshop Mods to Download\/Update", - "description": "[*Only works if the host owns Arma 3] Comma separated list of Steam Workshop mod IDs to download\/update on server start. (ex. 450814997,463939057) Each mod will be downloaded to the root directory with the folder format \"@ModIdNumber\". NOTE: Particularly large mods (ie. RHS, CUP, typically anything over 3 GB) may not download properly due to limitations of SteamCMD.", - "env_variable": "UPDATE_WORKSHOP", - "default_value": "", - "user_viewable": true, - "user_editable": true, - "rules": "string|nullable" - }, - { - "name": "Set Mods to Lowercase", - "description": "On server start, goes through all the mod folders listed in \"Mods\" & \"Server Mods\", and makes sure every folder and file is lowercase (to prevent errors). This is particularly useful to run ONCE after copying a mod from a Windows machine to the server, or if mods seem to not be loading.", + "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" }, + { + "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" + }, + { + "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" + }, { "name": "[Advanced] Extra Flags for SteamCMD", - "description": "Only used when checking for server updates, and typically used for grabbing beta builds.\r\nExample: -beta profiling -betapassword CautionSpecialProfilingAndTestingBranchArma3", + "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, @@ -147,7 +173,7 @@ }, { "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.", + "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, @@ -155,13 +181,40 @@ "rules": "required|integer|between:0,5" }, { - "name": "[Advanced] HC Connect Password", - "description": "If Headless Clients are used, this is the password used to connect to the server if the server is password locked.", - "env_variable": "HC_PASSWORD", - "default_value": "", + "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": "nullable|string" + "rules": "boolean" + }, + { + "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" + }, + { + "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" + }, + { + "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\/parkervcp\/eggs\/master\/game_eggs\/steamcmd_servers\/arma\/arma3\/egg-arma3-config\/basic.cfg", + "user_viewable": false, + "user_editable": false, + "rules": "required|url" } ] -} \ No newline at end of file +} From 77a0ce3df10a951b842d5e4d0bdc9a6b2d42adf5 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 19:16:16 -0700 Subject: [PATCH 09/17] Update egg-arma3.json - Added "backup" parkervcp image --- game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json index ccffa2cb..df2f28f5 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json +++ b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json @@ -9,7 +9,8 @@ "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": null, "images": [ - "ghcr.io\/pterodactyl\/games:arma3" + "ghcr.io\/pterodactyl\/games:arma3", + "quay.io\/parkervcp\/pterodactyl-images:game_arma3" ], "file_denylist": [], "startup": ".\/{{SERVER_BINARY}} -ip=0.0.0.0 -port={{SERVER_PORT}} -profiles=.\/serverprofile -bepath=.\/battleye -cfg=basic.cfg -config=server.cfg -mod=\\\"{{CLIENT_MODS}}\\\" -serverMod=\\\"{{SERVERMODS}}\\\" {{STARTUP_PARAMS}}", From e50cb2ae3d7f66afaec979bde3144e14b22d04ec Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 21:42:41 -0700 Subject: [PATCH 10/17] Update README.md - Add "How to Update Egg" section to address updating concerns --- .../steamcmd_servers/arma/arma3/README.md | 26 ++++++++++++++----- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/README.md b/game_eggs/steamcmd_servers/arma/arma3/README.md index dae5172e..85412136 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/README.md +++ b/game_eggs/steamcmd_servers/arma/arma3/README.md @@ -1,7 +1,9 @@ # Arma 3 +***Updating your Egg? Please see "How to Update Egg" at the end of this README to avoid any issues!*** +___ ### From their [Site](https://arma3.com/) 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. - +___ ### Egg Capabilities - Configurable to run 32 or 64-bit versions of the server - Max Players is configurable and able to be host enforced (\*see Recommended Egg Modifications) @@ -16,11 +18,11 @@ Experience true combat gameplay in a massive military sandbox. Deploying a wide - Additional [Arma 3 startup parameters](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters) can be added to fine-tune performance - Configurable to run up to 5 Headless Clients in parallel with the main server (may require additional performance overhead) - [WHMCS](https://www.whmcs.com/) compatible (\*see Recommended Egg Modifications) - +___ ### Installation Requirements - A valid, **real** Steam account, with **Steam Guard turned off**, is required to install the server (default "anonymous" login cannot be used). 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. This account *does not* need to own Arma 3. - 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. - +___ ### Server Ports Default server ports are listed below, but the Main port can be any port. There are three more ports after the Main port 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. @@ -32,19 +34,29 @@ Default server ports are listed below, but the Main port can be any port. There | BattleEye (+4) | 2306 | #### Mods/Plugins may require ports to be added to the server. - +___ ### CPU Usage Information 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. - +___ ### Minimum RAM Requirement This server requires about 2048 MB of RAM to run properly. If used, every Headless Client uses an additional 2048 MB of RAM as well. - +___ ### Minimum Disk Requirement This server requires just under 10 GB of disk space to safely run properly with no mods. However, mods can easily increase disk usage to 50 GB or more, depending on how many are downloaded. - +___ ### Recommended Egg Modifications The 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. #### Default Steam Username & Password - 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. #### Restrict Max Players - 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. +___ +### How to Update Egg +If you already have an Arma 3 egg installed on your panel, there are a couple things to consider before updating to this egg: +- 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. +- 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: + 1. Change the name of your existing Arma 3 egg to "Arma 3 (Old)". + 2. Install this updated egg as a new egg in your nest. + 3. Make any egg modifications you would like. (\*see Recommended Egg Modifications) + 4. Change all existing Arma 3 servers to the new egg via the Startup tab. + 5. Delete the old egg. From 22d4c3c3d4ea1390059d8a81366eb58cfbb2eb94 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Mon, 12 Jul 2021 21:52:40 -0700 Subject: [PATCH 11/17] Update egg-arma3.json - Added back depreciated variables so servers running the old Startup Command don't break. --- .../steamcmd_servers/arma/arma3/egg-arma3.json | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json index df2f28f5..48317a25 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json +++ b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json @@ -216,6 +216,24 @@ "user_viewable": false, "user_editable": false, "rules": "required|url" + }, + { + "name": "[Depreciated] Server Configuration File", + "description": "This is a depreciated variable that is only included for servers running on an older Startup Command.", + "env_variable": "CONFIG", + "default_value": "server.cfg", + "user_viewable": false, + "user_editable": false, + "rules": "string|nullable" + }, + { + "name": "[Depreciated] Basic Configuration File", + "description": "This is a depreciated variable that is only included for servers running on an older Startup Command.", + "env_variable": "BASIC", + "default_value": "basic.cfg", + "user_viewable": false, + "user_editable": false, + "rules": "required|string" } ] } From 8d85957c8ee5bdc81712e86b768cf4676b21c820 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Tue, 13 Jul 2021 16:44:26 -0700 Subject: [PATCH 12/17] Update egg-arma3.json Changed main image to parkervcp's ghcr/yolks image for testing. Must be changed before final release. --- game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json index 48317a25..ff403797 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json +++ b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json @@ -9,7 +9,7 @@ "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": null, "images": [ - "ghcr.io\/pterodactyl\/games:arma3", + "ghcr.io\/parkervcp\/yolks:arma3", "quay.io\/parkervcp\/pterodactyl-images:game_arma3" ], "file_denylist": [], From 33e0e4680c45b84afe28af986ce9710729fcb7d4 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Tue, 13 Jul 2021 23:49:54 -0700 Subject: [PATCH 13/17] Removed Arma 2 reference --- game_eggs/steamcmd_servers/arma/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/game_eggs/steamcmd_servers/arma/README.md b/game_eggs/steamcmd_servers/arma/README.md index d7f9463d..ddc7aa90 100644 --- a/game_eggs/steamcmd_servers/arma/README.md +++ b/game_eggs/steamcmd_servers/arma/README.md @@ -3,5 +3,4 @@ ARMA is a series of first-person tactical military shooters, originally released for Microsoft Windows. It features large elements of realism and simulation; a blend of large-scale military conflict spread across large areas alongside the more close quartered battles. ## Arma Titles -* Arma 2 (Egg Requested) * [Arma 3](arma3) From bd311a6867aa68ee494d6277d8ba7f0d117161c1 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Tue, 13 Jul 2021 23:57:48 -0700 Subject: [PATCH 14/17] Fixed Image Link in Egg --- game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json index ff403797..738300f1 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json +++ b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json @@ -9,7 +9,7 @@ "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": null, "images": [ - "ghcr.io\/parkervcp\/yolks:arma3", + "ghcr.io\/parkervcp\/games:arma3", "quay.io\/parkervcp\/pterodactyl-images:game_arma3" ], "file_denylist": [], From 3a49b70f8b6dfb8f98b6eda20763ff755a007a20 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Wed, 14 Jul 2021 11:23:21 -0700 Subject: [PATCH 15/17] Removed In-Dev update_url Feature To avoid issues in the future. --- game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json index 738300f1..f2d68d29 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json +++ b/game_eggs/steamcmd_servers/arma/arma3/egg-arma3.json @@ -2,7 +2,7 @@ "_comment": "Pterodactyl Arma 3 Egg ~ David Wolfe (Red-Thirten) ~ 2021-07-11", "meta": { "version": "PTDL_v1", - "update_url": "https:\/\/github.com\/parkervcp\/eggs\/blob\/master\/game_eggs\/steamcmd_servers\/arma\/arma3\/egg-arma3.json" + "update_url": null }, "name": "Arma 3", "author": "rehlmgaming@gmail.com", From 2c4b95927d511c310bc8dde5c2d4c5afb51399e6 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Wed, 14 Jul 2021 12:53:46 -0700 Subject: [PATCH 16/17] Add Authors / Contributors Added Authors / Contributors section, and added anchor links to specific sections. --- .../steamcmd_servers/arma/arma3/README.md | 58 ++++++++++++++++--- 1 file changed, 51 insertions(+), 7 deletions(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/README.md b/game_eggs/steamcmd_servers/arma/arma3/README.md index 85412136..fc395c7d 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/README.md +++ b/game_eggs/steamcmd_servers/arma/arma3/README.md @@ -1,14 +1,58 @@ # Arma 3 -***Updating your Egg? Please see "How to Update Egg" at the end of this README to avoid any issues!*** +***Updating your Egg? Please see [How to Update Egg](#how-to-update-egg) to avoid any issues!*** ___ -### From their [Site](https://arma3.com/) -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. +### Authors / Contributors + + + + + + + + + +
+ +
Red-Thirten + +
+ 💻 + 🔨 + 		+ +
Aussie Server Hosts + +
+ 💻 + 💡 + 		+ +
Softwarenoob + +
+ ✅ + 		+ +
Daave + +
+ 💻 + ⭐ + 💤 +
+ + + +___ +### Game Description +From Bohemia Interactive's [Website](https://arma3.com/): +> 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. ___ ### Egg Capabilities - Configurable to run 32 or 64-bit versions of the server -- Max Players is configurable and able to be host enforced (\*see Recommended Egg Modifications) +- Max Players is configurable and able to be host enforced (\*see [Recommended Egg Modifications](#recommended-egg-modifications)) - Able to download server updates on startup -- Able to download, update, and load Steam Workshop mods on startup (\*see Installation Requirements) +- Able to download, update, and load Steam Workshop mods on startup (\*see [Installation Requirements](#installation-requirements)) - Accepts uploaded HTML modlist files exported from the Arma 3 Launcher to define mods to load on the server. - Also accepts manually listed mods, CDLCs, and server-side only mods. - Checks for mod updates against their Steam Workshop page's last update for quick and efficient update checks. @@ -17,7 +61,7 @@ ___ - Configurable to run Beta/Performance binaries of the server (if desired; advanced users only) - Additional [Arma 3 startup parameters](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters) can be added to fine-tune performance - Configurable to run up to 5 Headless Clients in parallel with the main server (may require additional performance overhead) -- [WHMCS](https://www.whmcs.com/) compatible (\*see Recommended Egg Modifications) +- [WHMCS](https://www.whmcs.com/) compatible (\*see [Recommended Egg Modifications](#recommended-egg-modifications)) ___ ### Installation Requirements - A valid, **real** Steam account, with **Steam Guard turned off**, is required to install the server (default "anonymous" login cannot be used). 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. This account *does not* need to own Arma 3. @@ -57,6 +101,6 @@ If you already have an Arma 3 egg installed on your panel, there are a couple th - 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: 1. Change the name of your existing Arma 3 egg to "Arma 3 (Old)". 2. Install this updated egg as a new egg in your nest. - 3. Make any egg modifications you would like. (\*see Recommended Egg Modifications) + 3. Make any egg modifications you would like. (\*see [Recommended Egg Modifications](#recommended-egg-modifications)) 4. Change all existing Arma 3 servers to the new egg via the Startup tab. 5. Delete the old egg. From eb26dfb22a3f3f294b8cf13c2ad31a493dc51a40 Mon Sep 17 00:00:00 2001 From: Red-Thirten Date: Wed, 14 Jul 2021 13:04:05 -0700 Subject: [PATCH 17/17] Remove code reviewers from Contributors Unneeded --- game_eggs/steamcmd_servers/arma/arma3/README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/game_eggs/steamcmd_servers/arma/arma3/README.md b/game_eggs/steamcmd_servers/arma/arma3/README.md index fc395c7d..73aa486c 100644 --- a/game_eggs/steamcmd_servers/arma/arma3/README.md +++ b/game_eggs/steamcmd_servers/arma/arma3/README.md @@ -22,13 +22,6 @@ ___ 💻 💡 - - -
Softwarenoob - -
- ✅ -
Daave