Update doc (README.md)

This commit is contained in:
q3aql 2021-03-18 10:15:04 +01:00
parent f0cef155b2
commit c6062dace5

View File

@ -18,7 +18,7 @@ q3aServ - Create a Quake 3 server easily on Linux
```shell ```shell
RUN_PATH="/opt/Games/quake3" RUN_PATH="/opt/Games/quake3"
RUN_BINARY="ioq3ded.x86_64" RUN_BINARY="ioq3ded.x86_64"
STATUS_PATH=/var/www/html/quake3/status.txt STATUS_PATH="/var/www/html/quake3/status.txt"
``` ```
- Finally, execute the script with the appropriate parameters: - Finally, execute the script with the appropriate parameters:
@ -51,6 +51,14 @@ q3aServ - Create a Quake 3 server easily on Linux
ST - Stop Current Server ST - Stop Current Server
``` ```
* An example command would be the following:
```shell
$ ./q3aServ.sh FFA 3
```
* The number `3` indicates the map selection group. Each number will automatically choose certain maps.
* Default settings of basic mode are the following: * Default settings of basic mode are the following:
```shell ```shell
@ -62,10 +70,12 @@ q3aServ - Create a Quake 3 server easily on Linux
TOU_FRAGS_LIMIT="50" TOU_FRAGS_LIMIT="50"
``` ```
_Note: You can change this settings editing the file `q3aServ.sh`._ _Note: You can change this settings editing the file `q3aServ.sh` or using the custom game `CG`._
## Sintax (Custom Game): ## Sintax (Custom Game):
* With the option `CG` the syntax of the command is extended to be able to customize more game options:
```shell ```shell
$ ./q3aServ.sh CG $ ./q3aServ.sh CG
@ -93,3 +103,9 @@ _Note: You can change this settings editing the file `q3aServ.sh`._
- CA = Clan Arena (OSP) - CA = Clan Arena (OSP)
- CAI = Clan Arena Instagib (OSP) - CAI = Clan Arena Instagib (OSP)
``` ```
* An example command would be the following:
```shell
$ ./q3aServ.sh CG 2 10 2 30 100
```