README Updates

This commit is contained in:
Price Hiller 2021-07-31 22:26:22 -05:00
parent 769db18f35
commit 113ba7cd50
3 changed files with 83 additions and 3 deletions

View File

@ -1,6 +1,6 @@
# 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 explicitly stated otherwise, for example:
`Arma-Start-Server -h`
## Arma-Install-Mod

View File

@ -72,7 +72,7 @@ log() {
fi
local FORMAT
FORMAT="[$(echo_rgb "$(date +%Y-%m-%dT%H:%M:%S%z)" 180 140 255)]"
FORMAT="[$(echo_rgb "$(date +%Y-%m-%dT%H:%M:%S)" 180 140 255)]"
# Convert the level to uppercase
local level

View File

@ -1 +1,81 @@
Minecraft Server Uses Spigot
# Minecraft Scripts Documentation
All script usages can be found by passing the "-h" flag unless explicitly stated otherwise, for example:
`Minecraft-Start-Server -h`
## Ports
| Type | Range |
| --- | --- |
| Game Ports | 12000-12099 |
| Query Ports | 12100-12199 |
| RCON Ports | 12200-12299 |
## Minecraft-Start-Server
Used to install or start a minecraft server. All minecraft servers are installed to ~/Minecraft/ (this directory
is created automatically)
All Minecraft servers backup their `server.propeerties` file when launched with this script to their
server directory/backups. e.g. `~/Minecraft/Server-1/backups/`
- Usage:
- To run an existing server and overwrite RCON password
- `Minecraft-Start-Server -s <server id>`
- Example:
- `Minecraft-Start-Server -s 0`
- This would start "Minecraft-Server-0" and overwrite Minecraft's RCON password with the password
provided by the script
- To run an existing server, but don't overwrite the RCON password
- `Minecraft-Start-Server -s <server id> -r`
- Example:
- `Minecraft-Start-Server -s 0`
- This would start "Minecraft-Server-0", but not overwrite the RCON password in Minecraft's config
- To install a new server
- `Minecraft-Start-Server -s <new server id> -j <path/to/minecraft/server/jar>`
- Example:
- `Minecraft-Start-Server -s 0 -j ~/minecraft_server1.17.1.jar`
- This would copy the provided server jar to Server-0 and install the server
- Flags
- `-s` | `--server`
- The server id that is provided to start/install the server
- Corresponds with the server in ~/Minecraft where the ID is the number in the directory name
- `-r` | `--rcon-ignore`
- This flag will ensure that Minecraft's rcon password is not overwritten by the script
- `-j` | `--jar`
- Path to a minecraft server jar and the server will install that jar to the given ID
##Minecraft-Connect-Server
Used to connect to a running Minecraft server's console to see log output or kill the server with ^C (control + c)
To disconnect from an Minecraft server without killing it type ^B D, that being hold `control` and `b` and then let go of
*both* and hit `d`.
- Usage
- `Minecraft-Connect-Server <server id>`
- Example:
- `Minecraft-Connect-Server 0`
- This would connect to the server prefixed with server number "0"
- Positional Arguments
- `<server id>`
- The server number corresponding to the server in ~/Minecraft/ 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"
##Minecraft-Stop-Server
Used to stop a running Minecraft server
This sends ^C (control c) to the Minecraft server
- Usage
- `Minecraft-Stop-Server <server id>`
- Example:
- `Minecraft-Stop-Server 0`
- This would stopthe server prefixed with server number "0"
- Positional Arguments
- `<server id>`
- The server number corresponding to the server in ~/Minecraft/ 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"