Arma Scripts docs/help update
This commit is contained in:
parent
dc5d7e4f43
commit
4f3032a9e4
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
usage() {
|
usage() {
|
||||||
printf "%s\n" \
|
printf "%s\n" \
|
||||||
"Usage: $(basename "${0}") -u <steam username> -p <steam password>
|
"Usage: $(basename "${0}") -s <server id> -n | $(basename "${0}") -s <server id> -u <steam username>
|
||||||
--user <steam username> | -u <steam username>
|
--user <steam username> | -u <steam username>
|
||||||
The username used to login for steam
|
The username used to login for steam
|
||||||
|
|
||||||
@ -10,19 +10,16 @@ usage() {
|
|||||||
--user Sbinalla
|
--user Sbinalla
|
||||||
Note:
|
Note:
|
||||||
Only required when --no-update is not passed
|
Only required when --no-update is not passed
|
||||||
|
|
||||||
--server <server number> | -s <server number>
|
--server <server number> | -s <server number>
|
||||||
The server number (the ID of the server within the Arma directory)
|
The server number (the ID of the server within the Arma directory)
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
--server 0
|
--server 0
|
||||||
|
|
||||||
--no-update | -n
|
--no-update | -n
|
||||||
Skips the steam update and validation and just starts the server
|
Skips the steam update and validation and just starts the server
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
--no-update"
|
--no-update"
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
error() {
|
error() {
|
||||||
|
@ -1,8 +1,10 @@
|
|||||||
# Arma Scripts Documentation
|
# Arma Scripts Documentation
|
||||||
|
|
||||||
All script usages can be found by passing the "-h" flag unless explicity stated otherwise, for example:
|
All script usages can be found by passing the "-h" flag unless explicity stated otherwise, for example:
|
||||||
`Arma-Start-Server -h`
|
`Arma-Start-Server -h`
|
||||||
|
|
||||||
## Arma-Install-Mod
|
## Arma-Install-Mod
|
||||||
|
|
||||||
Used to install mods to an Arma 3 Server
|
Used to install mods to an Arma 3 Server
|
||||||
|
|
||||||
- Usage:
|
- Usage:
|
||||||
@ -14,17 +16,18 @@ Used to install mods to an Arma 3 Server
|
|||||||
- `-u` | `--user`
|
- `-u` | `--user`
|
||||||
- The steam user that is used to login and download mods from the steam workshop
|
- The steam user that is used to login and download mods from the steam workshop
|
||||||
- `-s` | `--server`
|
- `-s` | `--server`
|
||||||
- The server number corresponding to the server in ~/Arma/ where the server number is the last character in
|
- The server number corresponding to the server in ~/Arma/ where the server number is the last character in
|
||||||
the server name
|
the server name
|
||||||
- E.g. The server is named: "Server-0" then the server number would be "0"
|
- E.g. The server is named: "Server-0" then the server number would be "0"
|
||||||
- `-w` | `--workshop-id`
|
- `-w` | `--workshop-id`
|
||||||
- The workshop id from the arma3 workshop (the last numbers in the steam workshop url)
|
- 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
|
- Example: https://steamcommunity.com/workshop/filedetails/?id=463939057, the workshop-id would be
|
||||||
463939057
|
463939057
|
||||||
|
|
||||||
## Arma-Parse-Modlist
|
## 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
|
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-Parse-Modlist` to automatically install all mods from a given modlist -- significantly faster than using
|
||||||
`Arma-Install-Mod` on files one at a time.
|
`Arma-Install-Mod` on files one at a time.
|
||||||
|
|
||||||
A modlist can be exported to the server via scp like so:
|
A modlist can be exported to the server via scp like so:
|
||||||
@ -38,13 +41,58 @@ A modlist can be exported to the server via scp like so:
|
|||||||
- This would install all mods in the given modlist to "Arma-Server-0"
|
- This would install all mods in the given modlist to "Arma-Server-0"
|
||||||
- Positional Arguments
|
- Positional Arguments
|
||||||
- `<path/to/modlist>`
|
- `<path/to/modlist>`
|
||||||
- The absolute path to a given modlist, using relative paths *may* work, but is not supported nor
|
- The absolute path to a given modlist, using relative paths *may* work, but is not supported nor
|
||||||
recommended
|
recommended
|
||||||
- `<steam username>`
|
- `<steam username>`
|
||||||
- The steam user that is used to login and download mods from the steam workshop
|
- The steam user that is used to login and download mods from the steam workshop
|
||||||
- `<server number>`
|
- `<server number>`
|
||||||
- The server number corresponding to the server in ~/Arma/ where the server number is the last character in
|
- The server number corresponding to the server in ~/Arma/ where the server number is the last character in
|
||||||
the server name
|
the server name
|
||||||
- E.g. The server is named: "Server-0" then the server number would be "0"
|
- E.g. The server is named: "Server-0" then the server number would be "0"
|
||||||
|
|
||||||
## Arma-Start-Server
|
## 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`.
|
||||||
|
|
||||||
|
- 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"
|
Loading…
Reference in New Issue
Block a user