Bash_Scripts/CentOS/Arma/README.md

Arma Scripts Documentation

All script usages can be found by passing the "-h" flag unless explicitly stated otherwise, for example: Arma-Start-Server -h

Arma-Install-Mod

Used to install mods to an Arma 3 Server

• Usage:
  • Arma-Install-Mod -u <steam username> -s <server id> -w <workshop id>
  • Example:
    • Arma-Install-Mod -u treatybreaker -s 0 -w 463939057 -m ace3
      • This would install the ace3 mod to the server named "Arma-Server-0"
  • Flags
    • -u | --user
      • The steam user that is used to login and download mods from the steam workshop
    • -s | --server
      • The server number corresponding to the server in ~/Arma/ where the server number is the last character in the server name
        • E.g. The server is named: "Server-0" then the server number would be "0"
    • -w | --workshop-id
      • The workshop id from the arma3 workshop (the last numbers in the steam workshop url)
        • Example: https://steamcommunity.com/workshop/filedetails/?id=463939057, the workshop-id would be 463939057

Arma-Parse-Modlist

In the Arma 3 launcher it is possible to export a selected modlist as a html file. The exported modlist can be used with Arma-Parse-Modlist to automatically install all mods from a given modlist -- significantly faster than using Arma-Install-Mod on files one at a time.

A modlist can be exported to the server via scp like so:

scp Arma-Modlist.html user@host:~/ -- this will send the modlist to the home directory of the given user

• Usage
  • Arma-Parse-Modlist <path/to/modlist> <steam username> <server number>
  • Example:
    • Arma-Parse-Modlist ~/Arma-Modlist.html treatybreaker 0
      • This would install all mods in the given modlist to "Arma-Server-0"
  • Positional Arguments
    • <path/to/modlist>
      • The absolute path to a given modlist, using relative paths may work, but is not supported nor recommended
    • <steam username>
      • The steam user that is used to login and download mods from the steam workshop
    • <server number>
      • The server number corresponding to the server in ~/Arma/ where the server number is the last character in the server name
        • E.g. The server is named: "Server-0" then the server number would be "0"

Arma-Start-Server

Used to launch an Arma server or create a new server

• Usage
  • Without steam update/download (only use this on an existing server)
    • Arma-Start-Server -s <server number> -n
    • Example:
      • Arma-Start-Server -s 0 -n
        • This would start "Arma-Server-0" without updating from steam and as such is significantly faster to start
  • With steam update/download
    • Arma-Start-Server -s <server number> -u <steam username>
    • Example:
      • Arma-Start-Server -s 0 -u treatybreaker
        • This would start "Arma-Server-0" and update or install the server with the steam user "treatybreaker"
  • Flags
    • -u | --user
      • The steam user that is used to login and download/update the server
      • Should only be used if -n/--no-update flag isn't passed
    • -s | --server
      • The server number corresponding to the server in ~/Arma/ where the server number is the last character in the server name
        • E.g. The server is named: "Server-0" then the server number would be "0"
    • -n | --no-update
      • This skips any login with steam and does not update/install/validate server files
      • Only use on servers that exist and are known to have good file validity
      • Do not use this with the -u/--user flag

Arma-Connect-Server

Used to connect to a running Arma server's console to see log output or kill the server with ^C (control + c)

To disconnect from an Arma server without killing it type ^B D, that being hold control and b and then let go of both and hit d.

-h flag does not exist for this script. (No help menu)

• Usage
  • Arma-Connect-Server <server number>
    • Example:
      • Arma-Connect-Server 0
        • This would connect to the server started with server number "0"
  • Positional Arguments
    • <server number>
      • The server number corresponding to the server in ~/Arma/ where the server number is the last character in the server name
        • E.g. The server is named: "Server-0" then the server number would be "0"