organize repo

update readme for steamcmd games move arma into the right folder.
2019-12-21 14:21:00 -05:00
parent 078413afb0
commit f4c069eb93
9 changed files with 69 additions and 43 deletions
--- a/steamcmd_servers/arma/README.md
+++ b/steamcmd_servers/arma/README.md
@@ -0,0 +1,9 @@
+# ARMA
+
+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 III
+[arma 3](arma3/)
+
+## ARMA III headless client
+[arma 3 headless](arma3_headless_client/)
--- a/steamcmd_servers/arma/arma3/README.md
+++ b/steamcmd_servers/arma/arma3/README.md
@@ -0,0 +1,20 @@
+# Arma 3
+### 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. 
+
+### Minimum RAM warning
+This server requires about 2048m to run properly. ARMA 3 is more CPU intensive though.
+
+### Additional settings
+Additional server flags can be found [here](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters).  
+This can help is you see the server using to many cores/threads on the server.
+
+### Server Ports
+Ports required to run the server in a table format.
+
+| Port    | default |
+|---------|---------|
+| Game    | 2302-2306    |
+| BattleEye    | 2344-2345    |
+
+#### Mods/Plugins may require ports to be added to the server.
--- a/steamcmd_servers/arma/arma3/egg-arma3-config/basic.cfg
+++ b/steamcmd_servers/arma/arma3/egg-arma3-config/basic.cfg
@@ -0,0 +1,83 @@
+// ****************************************************************************
+//                                                                            *
+//     Arma 3 - basic.cfg                                                   *
+//     Version 060116                                                         *
+//                                                                            *
+// ****************************************************************************
+
+// Defines network tuning parameters
+//
+// This file is to be passed to the -cfg parameter on the command line for the server
+// See http://community.bistudio.com/wiki/basic.cfg
+// The following settings are the suggested settings
+
+// BANDWIDTH SETTINGS
+
+// Bandwidth the server is guaranteed to have (in bps)
+// General guideline is NumberOfPlayers * 256kb
+// Default: 131072
+MinBandwidth=5120000;
+// Bandwidth the server can never go above (in bps)
+// For a single server, use full network speed; decrease when running multiple servers
+MaxBandwidth=10240000;
+
+// PACKET SETTINGS
+
+// Maximum number of packets per frame.
+// Increasing the value potentially decreases lag, but increases desync
+// Default: 128
+MaxMsgSend=2048;
+// Maximum payload of guaranteed packet (in b)
+// Small messages are packed to larger packets
+// Guaranteed packets are used for non-repetitive events, like shooting
+// Lower value means more packets are sent, so less events will get combined
+// Default: 512
+MaxSizeGuaranteed=512;
+// Maximum payload of non-guaranteed packet (in b)
+// Increasing this value may improve bandwidth requirement, but may also increase lag
+// Largest factor in desync
+// Guidance is half of MaxSizeGuaranteed
+// Default: 256
+MaxSizeNonguaranteed=256;
+// Maximal size of a packet sent over the network
+// Only necessary if ISP forces lower packet size and there are connectivity issues
+// Default: 1400
+// class sockets{maxPacketSize=1400};
+
+// SMOOTHNESS SETTINGS
+
+// Minimal error required to send network updates for far units
+// Smaller values will make for smoother movement at long ranges, but will increase network traffic
+// Default: 0.003
+MinErrorToSend=0.01;
+// Minimal error required to send network updates for near units
+// Using larger value can reduce traffic sent for near units
+// Also controls client to server traffic
+// Default: 0.01
+MinErrorToSendNear=0.02;
+
+// GEOLOCATION SETTINGS
+
+// Server latitude
+serverLatitude=52;
+serverLatitudeAuto=52;
+
+// Server Longitude
+serverLongitude=0;
+serverLongitudeAuto=0;
+// MISC
+// View Distance (not sure if this actually works)
+viewDistance=10000;
+
+// Maximum size (in b) for custom face or sound files
+// Default: 0
+MaxCustomFileSize=65536;
+// Server language
+language="English";
+steamLanguage="English";
+// Adapter
+adapter=-1;
+// Windowed mode
+Windowed=0;
+
+3D_Performance=1.000000;
--- a/steamcmd_servers/arma/arma3/egg-arma3-config/server.cfg
+++ b/steamcmd_servers/arma/arma3/egg-arma3-config/server.cfg
@@ -0,0 +1,158 @@
+// ****************************************************************************
+//                                                                            *
+//     Arma 3 - server.cfg                                                    *
+//     Version 060117                                                         *
+//                                                                            *
+// ****************************************************************************
+
+// ArmA 3 Server Config File
+//
+// More info about parameters:
+// https://community.bistudio.com/wiki/server.cfg
+
+
+// GENERAL SETTINGS
+
+// Hostname for server.
+hostname = "Arma 3 Server";
+
+// Server password - for private servers.
+//password = "arma3pass";
+
+// Admin Password
+//passwordAdmin = "ADMINPASSWORD";
+
+// Auto-admin
+admins[] = {"<UID>"};
+
+// Server Slots
+maxPlayers = 32;
+
+// Logfile
+logFile = "arma3server.log";
+
+// Minimum Required Client Build
+//requiredBuild = 95691
+
+class Missions
+{
+	class Mission1
+	{
+		template = ;
+		difficulty = "Regular";
+		class Params {};
+	};
+	class Mission2
+	{
+		template = ;
+		difficulty = "Regular";
+		class Params {};
+	};
+	class Mission3
+	{
+		template = ;
+		difficulty = "Regular";
+		class Params {};
+	};
+	class Mission4
+	{
+		template = ;
+		difficulty = "Regular";
+		class Params {};
+	};
+};
+
+// Message of the Day (MOTD)
+motd[] = {
+    "Welcome to My Arma 3 Server",
+    "TS3 Server:     teamspeak.somewhere.com",
+    "Web:            www.example.com"
+};
+
+// MOTD Interval (Seconds)
+motdInterval = 30;
+
+
+// VOTING
+
+// Server Mission Start
+//  minimum number of clients before server starts mission
+voteMissionPlayers = 1;
+
+// Accepted Vote Threshold
+//  0.33 = 33% clients.
+voteThreshold = 0.33;
+
+// INGAME SETTINGS
+
+// Disable Voice over Net (VoN)
+//  0 = voice enabled.
+//  1 = voice disabled.
+disableVoN = 0;
+
+// VoN Codec Quality
+//  0-10 = 8kHz (narrowband).
+//  11-20 = 16kHz (wideband).
+//  21-30 = 32kHz (ultrawideband).
+vonCodecQuality = 3;
+
+// Persistent Battlefield
+//  0 = disable.
+//  1 = enable.
+persistent = 1;
+
+// Time Stamp Format
+//  none, short, full
+timeStampFormat = "short";
+
+// Server Statistics
+//  Set this to 0 to opt-out! More info: https://community.bistudio.com/wiki/Arma_3_Analytics
+statisticsEnabled = 1;
+
+// SERVER SECURITY/ANTI HACK
+
+// Verify Signitures for Client Addons
+//  0 = off.
+//  1 = weak protection (depricated).
+//  2 = full protection.
+verifySignatures = 2;
+
+// Secure Player ID
+//  1 = Server warning message.
+//  2 = Kick client.
+requiredSecureId = 2;
+
+// Kick Duplicate Player IDs
+kickDuplicate = 1;
+
+// BattlEye Anti-Cheat
+//  0 = disable
+//  1 = enable
+BattlEye = 1;
+
+// Allowed File Extentions
+allowedLoadFileExtensions[] = {"hpp","sqs","sqf","fsm","cpp","paa","txt","xml","inc","ext","sqm","ods","fxy","lip","csv","kb","bik","bikb","html","htm","biedi"};
+allowedPreprocessFileExtensions[] = {"hpp","sqs","sqf","fsm","cpp","paa","txt","xml","inc","ext","sqm","ods","fxy","lip","csv","kb","bik","bikb","html","htm","biedi"};
+allowedHTMLLoadExtensions[] = {"htm","html","xml","txt"};
+
+// SCRIPTING ISSUES
+onUserConnected = "";
+onUserDisconnected = "";
+doubleIdDetected = "";
+
+// SIGNATURE VERIFICATION
+// kick = kick (_this select 0)
+// ban = ban (_this select 0)
+onUnsignedData = "kick (_this select 0)";
+onHackedData = "kick (_this select 0)";
+onDifferentData = "";
+
+// HEADLESS CLIENT SUPPORT
+// specify ip-adresses of allowed headless clients
+headlessClients[] = {"127.0.0.1", "172.18.0.1"};
+localClient[] = {"127.0.0.1", "172.18.0.1"};
+
+// BattlEye Anti-Cheat License
+//  0 = decline
+//  1 = accept
+battleyeLicense = 1;
--- a/steamcmd_servers/arma/arma3/egg-arma3.json
+++ b/steamcmd_servers/arma/arma3/egg-arma3.json
@@ -0,0 +1,108 @@
+{
+    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
+    "meta": {
+        "version": "PTDL_v1"
+    },
+    "exported_at": "2019-03-13T18:40:40-04:00",
+    "name": "Arma 3",
+    "author": "daave@aaathats3as.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.",
+    "image": "quay.io\/parkervcp\/pterodactyl-images:game_arma3",
+    "startup": ".\/arma3server -ip=0.0.0.0 -port={{SERVER_PORT}} -cfg={{BASIC}} -config={{CONFIG}} {{CUSTOM}} -mod=\"{{MODS}}\" -serverMod=\"{{SERVERMODS}}\"",
+    "config": {
+        "files": "{}",
+        "startup": "{\r\n    \"done\": \"Connected to Steam servers\",\r\n    \"userInteraction\": []\r\n}",
+        "logs": "{\r\n    \"custom\": true,\r\n    \"location\": \"latest.log\"\r\n}",
+        "stop": "^C"
+    },
+    "scripts": {
+        "installation": {
+            "script": "#!\/bin\/bash\r\n\r\napt -y update\r\napt -y --no-install-recommends install curl\r\napt -y --no-install-recommends install lib32gcc1 ca-certificates\r\n\r\ncd \/tmp\r\ncurl -sSLO http:\/\/media.steampowered.com\/installer\/steamcmd_linux.tar.gz\r\n\r\nmkdir -p \/mnt\/server\/steamcmd \/mnt\/server\/logs\r\nmkdir -p \"\/mnt\/server\/.local\/share\/Arma 3\" \"\/mnt\/server\/.local\/share\/Arma 3 - Other Profiles\"\r\n\r\ntouch \/mnt\/server\/latest.log\r\nchown -R root:root \/mnt\r\n\r\ntar -xzvf \/tmp\/steamcmd_linux.tar.gz -C \/mnt\/server\/steamcmd\r\ncd \/mnt\/server\/steamcmd\r\nexport HOME=\/mnt\/server\r\n\r\n.\/steamcmd.sh +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} +force_install_dir \/mnt\/server +app_update ${APP_ID} validate +quit\r\n\r\ncd \/mnt\/server\/\r\n[[ -f basic.cfg ]] || curl -sSLO https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/arma\/arma3\/egg-arma3-config\/basic.cfg\r\n[[ -f server.cfg ]] || curl -sSLO https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/arma\/arma3\/egg-arma3-config\/server.cfg",
+            "container": "ubuntu:18.04",
+            "entrypoint": "bash"
+        }
+    },
+    "variables": [
+        {
+            "name": "Game App ID",
+            "description": "Steam CMD App ID.",
+            "env_variable": "APP_ID",
+            "default_value": "233780",
+            "user_viewable": 1,
+            "user_editable": 0,
+            "rules": "required|alpha_dash|between:1,100"
+        },
+        {
+            "name": "Basic",
+            "description": "Basic network config",
+            "env_variable": "BASIC",
+            "default_value": "basic.cfg",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "string|nullable"
+        },
+        {
+            "name": "Config",
+            "description": "Server config",
+            "env_variable": "CONFIG",
+            "default_value": "server.cfg",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "string|nullable"
+        },
+        {
+            "name": "Custom Command Line Option.",
+            "description": "Put -autoinit or related things in here :)",
+            "env_variable": "CUSTOM",
+            "default_value": "",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "string|nullable"
+        },
+        {
+            "name": "SERVERMODS",
+            "description": "This is where you put the files that go along with the -serverMods startup option.",
+            "env_variable": "SERVERMODS",
+            "default_value": "",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "string|nullable"
+        },
+        {
+            "name": "Mods",
+            "description": "This is where you put mods that go along with the -mods startup option",
+            "env_variable": "MODS",
+            "default_value": "",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "string|nullable"
+        },
+        {
+            "name": "Steam User",
+            "description": "A Steam username with Arma3 on the account.",
+            "env_variable": "STEAM_USER",
+            "default_value": "anonymous",
+            "user_viewable": 0,
+            "user_editable": 0,
+            "rules": "required|string"
+        },
+        {
+            "name": "Steam Password",
+            "description": "Steam User Password",
+            "env_variable": "STEAM_PASS",
+            "default_value": "",
+            "user_viewable": 0,
+            "user_editable": 0,
+            "rules": "nullable|string"
+        },
+        {
+            "name": "Steam Auth Code",
+            "description": "Steam Auth Code only when you're using Steam Auth",
+            "env_variable": "STEAM_AUTH",
+            "default_value": "",
+            "user_viewable": 0,
+            "user_editable": 0,
+            "rules": "nullable|string"
+        }
+    ]
+}
--- a/steamcmd_servers/arma/arma3_headless_client/README.md
+++ b/steamcmd_servers/arma/arma3_headless_client/README.md
@@ -0,0 +1,21 @@
+# Arma 3 Headless Client
+### From their [Site](https://community.bistudio.com/wiki/Arma_3_Headless_Client)
+What is a Headless Client (HC) used for?
+* Headless Client is used to offload AI calculations from the server
+* Headless Client is integrated into game client and dedicated server executable (WIndows and Linux, use -client parameter)
+* The server doesn't allow arbitrary connections from headless clients if you do not define the headless clients IPs in the server.cfg,
+
+### But why?
+If you host an Arma 3 Server with lots of AI in it, the Server FPS will drop fast.
+Since the server files are only 32 Bit you will need some kind of magical assistant to prevent slow AI.
+
+### Minimum RAM warning
+This server requires about 2048m to run properly. ARMA 3 is more CPU intensive though.
+
+### Additional settings
+Additional server flags can be found [here](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters).  
+This can help is you see the server using to many cores/threads on the server.
+If you want to know how to implement, take a look at the Wiki [here](https://community.bistudio.com/wiki/Arma_3_Headless_Client#Spawning_the_AI) or at a guide in the A3 Forums [here](https://forums.bohemia.net/forums/topic/178434-arma3-headless-client-guide/).
+
+### Server Ports
+Since this is basically a client, this Egg does not need a port. 
--- a/steamcmd_servers/arma/arma3_headless_client/egg-arma3-headless-client.json
+++ b/steamcmd_servers/arma/arma3_headless_client/egg-arma3-headless-client.json
@@ -0,0 +1,99 @@
+{
+    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
+    "meta": {
+        "version": "PTDL_v1"
+    },
+    "exported_at": "2019-03-25T14:09:36+01:00",
+    "name": "Arma 3 Headless Client",
+    "author": "brainp4in@blueberry-hood-clan.de",
+    "description": "Headless Clients are used to offload AI calculations from the Arma 3 Server.",
+    "image": "quay.io\/parkervcp\/pterodactyl-images:game_arma3",
+    "startup": ".\/arma3server -client -connect={{SERVERIP}} -port={{SERVERPORT}} {{CUSTOM}} -mod=\"{{MODS}}\"",
+    "config": {
+        "files": "{}",
+        "startup": "{\r\n    \"done\": \"Client connected\",\r\n    \"userInteraction\": []\r\n}",
+        "logs": "{\r\n    \"custom\": true,\r\n    \"location\": \"latest.log\"\r\n}",
+        "stop": "^C"
+    },
+    "scripts": {
+        "installation": {
+            "script": "#!\/bin\/bash\r\n\r\napt -y update\r\napt -y --no-install-recommends install curl\r\napt -y --no-install-recommends install lib32gcc1 ca-certificates\r\n\r\ncd \/tmp\r\ncurl -sSLO http:\/\/media.steampowered.com\/installer\/steamcmd_linux.tar.gz\r\n\r\nmkdir -p \/mnt\/server\/steamcmd \/mnt\/server\/logs\r\nmkdir -p \"\/mnt\/server\/.local\/share\/Arma 3\" \"\/mnt\/server\/.local\/share\/Arma 3 - Other Profiles\"\r\n\r\ntouch \/mnt\/server\/latest.log\r\nchown -R root:root \/mnt\r\n\r\ntar -xzvf \/tmp\/steamcmd_linux.tar.gz -C \/mnt\/server\/steamcmd\r\ncd \/mnt\/server\/steamcmd\r\nexport HOME=\/mnt\/server\r\n\r\n.\/steamcmd.sh +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} +force_install_dir \/mnt\/server +app_update ${APP_ID} validate +quit\r\n\r\ncd \/mnt\/server\/\r\ncurl -sSLO https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/arma\/arma3\/egg-arma3-config\/server.cfg\r\ncurl -sSLO https:\/\/raw.githubusercontent.com\/parkervcp\/eggs\/master\/arma\/arma3\/egg-arma3-config\/basic.cfg",
+            "container": "ubuntu:18.04",
+            "entrypoint": "bash"
+        }
+    },
+    "variables": [
+        {
+            "name": "Game App ID",
+            "description": "Steam CMD App ID.",
+            "env_variable": "APP_ID",
+            "default_value": "233780",
+            "user_viewable": 1,
+            "user_editable": 0,
+            "rules": "required|alpha_dash|between:1,100"
+        },
+        {
+            "name": "Server IP",
+            "description": "IP address of the Arma 3 server that should be supported by the Headless Client.",
+            "env_variable": "SERVERIP",
+            "default_value": "127.0.0.1",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "required|string|max:30"
+        },
+        {
+            "name": "Server Port",
+            "description": "Port of the Arma 3 server that should be supported by the Headless Client.",
+            "env_variable": "SERVERPORT",
+            "default_value": "2302",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "required|string|max:5"
+        },
+        {
+            "name": "Custom Command Line Option.",
+            "description": "Put -autoinit or related things in here :)",
+            "env_variable": "CUSTOM",
+            "default_value": "",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "string|nullable"
+        },
+        {
+            "name": "Mods",
+            "description": "This is where you put mods that go along with the -mods startup option",
+            "env_variable": "MODS",
+            "default_value": "",
+            "user_viewable": 1,
+            "user_editable": 1,
+            "rules": "string|nullable"
+        },
+        {
+            "name": "Steam User",
+            "description": "A Steam username with Arma3 on the account.",
+            "env_variable": "STEAM_USER",
+            "default_value": "anonymous",
+            "user_viewable": 0,
+            "user_editable": 0,
+            "rules": "required|string"
+        },
+        {
+            "name": "Steam Password",
+            "description": "Steam User Password",
+            "env_variable": "STEAM_PASS",
+            "default_value": "",
+            "user_viewable": 0,
+            "user_editable": 0,
+            "rules": "nullable|string"
+        },
+        {
+            "name": "Steam Auth Code",
+            "description": "Steam Auth Code only when you're using Steam Auth",
+            "env_variable": "STEAM_AUTH",
+            "default_value": "",
+            "user_viewable": 0,
+            "user_editable": 0,
+            "rules": "nullable|string"
+        }
+    ]
+}