Skip to content

Instantly share code, notes, and snippets.

@Freddo3000
Forked from marceldev89/a3update.py
Last active April 6, 2024 21:52
Show Gist options
  • Save Freddo3000/a5cd0494f649db75e43611122c9c3f15 to your computer and use it in GitHub Desktop.
Save Freddo3000/a5cd0494f649db75e43611122c9c3f15 to your computer and use it in GitHub Desktop.
Arma 3 Linux server and mod updater (workshop)
#!/usr/bin/python3
# MIT License
#
# Copyright (c) 2017 Marcel de Vries
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import os
import os.path
import re
import shutil
import time
from datetime import datetime
from urllib import request
# region Configuration
STEAM_CMD = "/home/steam/arma3/steam/steamcmd.sh" # Alternatively "steamcmd" if package is installed
STEAM_USER = ""
STEAM_PASS = ""
A3_SERVER_ID = "233780"
A3_SERVER_DIR = "/home/steam/arma3/install"
A3_WORKSHOP_ID = "107410"
A3_WORKSHOP_DIR = "{}/steamapps/workshop/content/{}".format(A3_SERVER_DIR, A3_WORKSHOP_ID)
A3_MODS_DIR = "/home/steam/arma3/mods"
A3_KEYS_DIR = "/home/steam/arma3/install/keys"
MODPACK_NAME = "Modpack"
MODPACK_PATH = "/home/steam/arma3/modpack.html"
MODS = {
"@cba_a3": "450814997",
"@ace3": "463939057",
"@alive": "620260972",
"@cup_terrains_core": "583496184",
"@cup_terrains_maps": "583544987",
"@cup_weapons": "497660133",
"@cup_units": "497661914",
"@cup_vehicles": "541888371",
"@blastcore": "767380317",
"@blastcore_server": "855973772"
}
# Only mod names go here, server/optional mods also need to be listed in MODS
SERVER_MODS = {
"@blastcore_server"
}
OPTIONAL_MODS = {
"@blastcore"
}
DLC = {
"Global Mobilization": "1042220"
}
UPDATE_PATTERN = re.compile(r"workshopAnnouncement.*?<p id=\"(\d+)\">", re.DOTALL)
TITLE_PATTERN = re.compile(r"(?<=<div class=\"workshopItemTitle\">)(.*?)(?=<\/div>)", re.DOTALL)
WORKSHOP_CHANGELOG_URL = "https://steamcommunity.com/sharedfiles/filedetails/changelog"
# endregion
# region Functions
def log(msg):
print("")
print("{{0:=<{}}}".format(len(msg)).format(""))
print(msg)
print("{{0:=<{}}}".format(len(msg)).format(""))
def call_steamcmd(params):
os.system("{} {}".format(STEAM_CMD, params))
print("")
def update_server():
steam_cmd_params = " +login {} {}".format(STEAM_USER, STEAM_PASS)
steam_cmd_params += " +force_install_dir {}".format(A3_SERVER_DIR)
steam_cmd_params += " +app_update {} validate".format(A3_SERVER_ID)
steam_cmd_params += " +quit"
call_steamcmd(steam_cmd_params)
def mod_needs_update(mod_id, path):
if os.path.isdir(path):
response = request.urlopen("{}/{}".format(WORKSHOP_CHANGELOG_URL, mod_id)).read()
response = response.decode("utf-8")
match = UPDATE_PATTERN.search(response)
if match:
updated_at = datetime.fromtimestamp(int(match.group(1)))
created_at = datetime.fromtimestamp(os.path.getctime(path))
return updated_at >= created_at
return False
def update_mods():
for mod_name, mod_id in MODS.items():
path = "{}/{}".format(A3_WORKSHOP_DIR, mod_id)
# Check if mod needs to be updated
if os.path.isdir(path):
if mod_needs_update(mod_id, path):
# Delete existing folder so that we can verify whether the
# download succeeded
shutil.rmtree(path)
else:
print("No update required for \"{}\" ({})... SKIPPING".format(mod_name, mod_id))
continue
# Keep trying until the download actually succeeded
tries = 0
while os.path.isdir(path) is False and tries < 10:
log("Updating \"{}\" ({}) | {}".format(mod_name, mod_id, tries + 1))
steam_cmd_params = " +login {} {}".format(STEAM_USER, STEAM_PASS)
steam_cmd_params += " +force_install_dir {}".format(A3_SERVER_DIR)
steam_cmd_params += " +workshop_download_item {} {} validate".format(
A3_WORKSHOP_ID,
mod_id
)
steam_cmd_params += " +quit"
call_steamcmd(steam_cmd_params)
# Sleep for a bit so that we can kill the script if needed
time.sleep(5)
tries = tries + 1
if tries >= 10:
log("!! Updating {} failed after {} tries !!".format(mod_name, tries))
def lowercase_workshop_dir():
os.system("(cd {} && find . -depth -exec rename -v 's/(.*)\/([^\/]*)/$1\/\L$2/' {{}} \;)".format(A3_WORKSHOP_DIR))
def create_mod_symlinks():
for mod_name, mod_id in MODS.items():
link_path = "{}/{}".format(A3_MODS_DIR, mod_name)
real_path = "{}/{}".format(A3_WORKSHOP_DIR, mod_id)
if os.path.isdir(real_path):
if not os.path.islink(link_path):
os.symlink(real_path, link_path)
print("Creating symlink '{}'...".format(link_path))
else:
print("Mod '{}' does not exist! ({})".format(mod_name, real_path))
key_regex = re.compile(r'(key).*', re.I)
def copy_keys():
# Check for broken symlinks
for key in os.listdir(A3_KEYS_DIR):
key_path = "{}/{}".format(A3_KEYS_DIR, key)
if os.path.islink(key_path) and not os.path.exists(key_path):
print("Removing outdated server key '{}'".format(key))
os.unlink(key_path)
# Update/add new key symlinks
for mod_name, mod_id in MODS.items():
if mod_name not in SERVER_MODS:
real_path = "{}/{}".format(A3_WORKSHOP_DIR, mod_id)
if not os.path.isdir(real_path):
print("Couldn't copy key for mod '{}', directory doesn't exist.".format(mod_name))
else:
dirlist = os.listdir(real_path)
keyDirs = [x for x in dirlist if re.search(key_regex, x)]
if keyDirs:
keyDir = keyDirs[0]
if os.path.isfile("{}/{}".format(real_path, keyDir)):
# Key is placed in root directory
key = keyDir
key_path = os.path.join(A3_KEYS_DIR, key)
if not os.path.exists(key_path):
print("Creating symlink to key for mod '{}' ({})".format(mod_name, key))
os.symlink(os.path.join(real_path, key), key_path)
else:
# Key is in a folder
for key in os.listdir(os.path.join(real_path, keyDir)):
real_key_path = os.path.join(real_path, keyDir, key)
key_path = os.path.join(A3_KEYS_DIR, key)
if not os.path.exists(key_path):
print("Creating symlink to key for mod '{}' ({})".format(mod_name, key))
os.symlink(real_key_path, key_path)
else:
print("!! Couldn't find key folder for mod {} !!".format(mod_name))
def generate_preset():
f = open(MODPACK_PATH, "w")
f.write(('<?xml version="1.0" encoding="utf-8"?>\n'
'<html>\n\n'
'<!--Created using a3update.py: https://gist.github.com/Freddo3000/a5cd0494f649db75e43611122c9c3f15-->\n'
'<head>\n'
'<meta name="arma:Type" content="{}" />\n'
'<meta name="arma:PresetName" content="{}" />\n'
'<meta name="generator" content="a3update.py https://gist.github.com/Freddo3000/a5cd0494f649db75e43611122c9c3f15"/>\n'
' <title>Arma 3</title>\n'
'<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet" type="text/css" />\n'
'<style>\n'
'body {{\n'
'margin: 0;\n'
'padding: 0;\n'
'color: #fff;\n'
'background: #000;\n'
'}}\n'
'body, th, td {{\n'
'font: 95%/1.3 Roboto, Segoe UI, Tahoma, Arial, Helvetica, sans-serif;\n'
'}}\n'
'td {{\n'
'padding: 3px 30px 3px 0;\n'
'}}\n'
'h1 {{\n'
'padding: 20px 20px 0 20px;\n'
'color: white;\n'
'font-weight: 200;\n'
'font-family: segoe ui;\n'
'font-size: 3em;\n'
'margin: 0;\n'
'}}\n'
'h2 {{'
'color: white;'
'padding: 20px 20px 0 20px;'
'margin: 0;'
'}}'
'em {{\n'
'font-variant: italic;\n'
'color:silver;\n'
'}}\n'
'.before-list {{\n'
'padding: 5px 20px 10px 20px;\n'
'}}\n'
'.mod-list {{\n'
'background: #282828;\n'
'padding: 20px;\n'
'}}\n'
'.optional-list {{\n'
'background: #222222;\n'
'padding: 20px;\n'
'}}\n'
'.dlc-list {{\n'
'background: #222222;\n'
'padding: 20px;\n'
'}}\n'
'.footer {{\n'
'padding: 20px;\n'
'color:gray;\n'
'}}\n'
'.whups {{\n'
'color:gray;\n'
'}}\n'
'a {{\n'
'color: #D18F21;\n'
'text-decoration: underline;\n'
'}}\n'
'a:hover {{\n'
'color:#F1AF41;\n'
'text-decoration: none;\n'
'}}\n'
'.from-steam {{\n'
'color: #449EBD;\n'
'}}\n'
'.from-local {{\n'
'color: gray;\n'
'}}\n'
).format("Modpack", MODPACK_NAME))
f.write(('</style>\n'
'</head>\n'
'<body>\n'
'<h1>Arma 3 - {} <strong>{}</strong></h1>\n'
'<p class="before-list">\n'
'<em>Drag this file or link to it to Arma 3 Launcher or open it Mods / Preset / Import.</em>\n'
'</p>\n'
'<h2 class="list-heading">Required Mods</h2>'
'<div class="mod-list">\n'
'<table>\n'
).format("Modpack", MODPACK_NAME))
for mod_name, mod_id in MODS.items():
if not (mod_name in OPTIONAL_MODS or mod_name in SERVER_MODS):
mod_url = "http://steamcommunity.com/sharedfiles/filedetails/?id={}".format(mod_id)
response = request.urlopen(mod_url).read()
response = response.decode("utf-8")
match = TITLE_PATTERN.search(response)
if match:
mod_title = match.group(1)
f.write(('<tr data-type="ModContainer">\n'
'<td data-type="DisplayName">{}</td>\n'
'<td>\n'
'<span class="from-steam">Steam</span>\n'
'</td>\n'
'<td>\n'
'<a href="{}" data-type="Link">{}</a>\n'
'</td>\n'
'</tr>\n'
).format(mod_title, mod_url, mod_url))
f.write('</table>\n'
'</div>\n'
'<h2 class="list-heading">Optional Mods</h2>'
'<div class="optional-list">\n'
'<table>\n'
)
for mod_name, mod_id in MODS.items():
if mod_name in OPTIONAL_MODS:
mod_url = "http://steamcommunity.com/sharedfiles/filedetails/?id={}".format(mod_id)
response = request.urlopen(mod_url).read()
response = response.decode("utf-8")
match = TITLE_PATTERN.search(response)
if match:
mod_title = match.group(1)
f.write(('<tr data-type="OptionalContainer">\n'
'<td data-type="DisplayName">{}</td>\n'
'<td>\n'
'<span class="from-steam">Steam</span>\n'
'</td>\n'
'<td>\n'
'<a href="{}" data-type="Link">{}</a>\n'
'</td>\n'
'</tr>\n'
).format(mod_title, mod_url, mod_url))
f.write('</table>\n'
'</div>\n'
'<h2 class="list-heading">DLC</h2>\n'
'<div class="dlc-list">\n'
'<table>\n'
)
for dlc_name, mod_id in DLC.items():
mod_url = "https://store.steampowered.com/app/{}".format(mod_id)
f.write(('<tr data-type="DlcContainer">\n'
'<td data-type="DisplayName">{}</td>\n'
'<td>\n'
'<a href="{}" data-type="Link">{}</a>\n'
'</td>\n'
'</tr>\n'
).format(dlc_name, mod_url, mod_url))
f.write('</table>\n'
'</div>\n'
'<div class="footer">\n'
'<span>Created using a3update.py by marceldev89; forked by Freddo3000.</span>\n'
'</div>\n'
'</body>\n'
'</html>\n'
)
# endregion
log("Updating A3 server ({})".format(A3_SERVER_ID))
update_server()
log("Updating mods")
update_mods()
log("Converting uppercase files/folders to lowercase...")
lowercase_workshop_dir()
log("Creating symlinks...")
create_mod_symlinks()
log("Copying server keys...")
copy_keys()
log("Generating modpack .html file...")
generate_preset()
log("Done!")
@Freddo3000
Copy link
Author

Added server key handling

@Freddo3000
Copy link
Author

It also now generates a preset file importable through the Arma Launcher.

You can also host this file on a webserver, and import it by pasting the link in the "File Name" field.

@Freddo3000
Copy link
Author

Fixed an issue if keys aren't found

@marceldev89
Copy link

👌

@Buri
Copy link

Buri commented Jul 2, 2020

Hey, it would be awesome if this also generated a startup script, which would load mods according to this config

@Freddo3000
Copy link
Author

Freddo3000 commented Jul 2, 2020

@Buri For that I'd recommend you check out https://github.com/Dahlgren/arma-server-web-admin

@dhkatz
Copy link

dhkatz commented Jul 6, 2020

The rename step was failing for me for some reason. But I re-implemented it in Python and it worked fine, which I think makes more sense anyways.

def lowercase_workshop_dir():
    def rename_all(root, items):
        for name in items:
            try:
                os.rename(os.path.join(root, name), os.path.join(root, name.lower()))
            except OSError:
                pass
    for root, dirs, files in os.walk(A3_WORKSHOP_DIR, topdown=False):
        rename_all(root, dirs)
        rename_all(root, files)

Also, something that was useful to me was generate the -mod parameter and printing them at the end (although can easily be extending to add the -servermod param too".

def print_launch_params():
    rel_path = os.path.relpath(A3_MODS_DIR, A3_SERVER_DIR)
    params = "-mod"
    for mod_name, mod_id in MODS.items():
        params += "{}/{}\;".format(rel_path, mod_name)
        
    print(params)

@Karlish-git
Copy link

Karlish-git commented Jun 30, 2022

there has been some changes to steamCMD.
now this script throws an error Please use force_install_dir before logon!

to fix this simply swap places for " +force_install_dir {}".format(A3_SERVER_DIR)and " +login {} {}".format(STEAM_USER, STEAM_PASS)
so it ends up looking like:

def update_server():
    steam_cmd_params = " +force_install_dir {}".format(A3_SERVER_DIR)
    steam_cmd_params += " +login {} {}".format(STEAM_USER, STEAM_PASS)
    steam_cmd_params += " +app_update {} validate".format(A3_SERVER_ID)
    steam_cmd_params += " +quit"
...

def update_mods():
....
            steam_cmd_params = " +force_install_dir {}".format(A3_SERVER_DIR)
            steam_cmd_params += " +login {} {}".format(STEAM_USER, STEAM_PASS)
            steam_cmd_params += " +workshop_download_item {} {} validate".format(

a small discussion where I learned about this:
ValveSoftware/steam-for-linux#8298

ps. downloading workshop items(missions) works only if the steam account owns the game!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment