51 lines
2.4 KiB
Markdown
51 lines
2.4 KiB
Markdown
|
# Arma Scripts Documentation
|
||
|
|
All script usages can be found by passing the "-h" flag unless explicity 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
|