q3aql/q3aServ
q3aql/q3aServ
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update doc (README.md)

Browse Source
This commit is contained in:
q3aql 2021-03-18 09:38:46 +01:00
parent d0e33611a9
commit bd88490e35
1 changed files with 54 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
README.md
View File

@ -15,71 +15,81 @@ q3aServ - Create a Quake 3 server easily on Linux
* Edit the file `q3aServ.sh`. * Edit the file `q3aServ.sh`.
* Change the following variables to the appropriate ones in your case: * Change the following variables to the appropriate ones in your case:
- `RUN_PATH="/opt/Games/quake3"` ```shell
- `RUN_BINARY="ioq3ded.x86_64"` RUN_PATH="/opt/Games/quake3"
- `STATUS_PATH=/var/www/html/quake3/status.txt` RUN_BINARY="ioq3ded.x86_64"
STATUS_PATH=/var/www/html/quake3/status.txt
```
- Finally, execute the script with the appropriate parameters: - Finally, execute the script with the appropriate parameters:
- `$ ./q3aServ.sh <option> [1-5]` ```cpp
$ ./q3aServ.sh <option> [1-5]
```
### Sintax (Basic): ### Sintax (Basic):
$ ./q3aServ.sh ```shell
$ ./q3aServ.sh
Quake 3 Server Script v4.1 Quake 3 Server Script v4.3
Config.files: /opt/Games/quake3/server/*.cfg Config.files: /opt/Games/quake3/server/*.cfg
Log.files: /home/q3aql/.q3a/baseq3/*.log Log.files: /home/q3aql/.q3a/baseq3/*.log
Status: /var/www/html/quake3/status.txt Status: /var/www/html/quake3/status.txt
Syntax: q3aServ.sh <option> [1-5] Syntax: q3aServ.sh <option> [1-5]
Available options: Available options:
CTF - Start Capture The Flag CTF - Start Capture The Flag
TD - Start Team Deathmatch TD - Start Team Deathmatch
FFA - Start Free For All FFA - Start Free For All
TOU - Start Tournament TOU - Start Tournament
CG - Custom Game CG - Custom Game
CL - Clear Logs CL - Clear Logs
ST - Stop Current Server ST - Stop Current Server
```
* Default settings of basic mode are the following: * Default settings of basic mode are the following:
- `BOTS_LEVEL="2"` ```shell
- `MIN_PLAYERS="5"` BOTS_LEVEL="2"
- `TIME_LIMIT="25"` MIN_PLAYERS="5"
- `FLAGS_LIMIT="10"` TIME_LIMIT="25"
- `FRAGS_LIMIT="150"` FLAGS_LIMIT="10"
- `TOU_FRAGS_LIMIT="50"` FRAGS_LIMIT="150"
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`._
## Sintax (Custom Game): ## Sintax (Custom Game):
$ ./q3aServ.sh CG ```shell
$ ./q3aServ.sh CG
Syntax: q3aServ.sh CG [map-selection] [gametype] [minplayers] [bot-level] [time-limit] [flags/frags-limit] Syntax: q3aServ.sh CG [map-selection] [gametype] [minplayers] [bot-level] [time-limit] [flags/frags-limit]
Available options: Available options:
* map-selection -> 1-5 * map-selection -> 1-5
* gametype -> CTF/FFA/TD/TOU/FT/CTFI/TDI/FFAI/CA/CAI * gametype -> CTF/FFA/TD/TOU/FT/CTFI/TDI/FFAI/CA/CAI
* minplayers -> 0-10 * minplayers -> 0-10
* bot-level -> 1-5 * bot-level -> 1-5
* time-limit -> 0-999 * time-limit -> 0-999
* flags/frags-limit -> 0-999 * flags/frags-limit -> 0-999
Abbreviations: Abbreviations:
CTF = Capture The Flag - CTF = Capture The Flag
FFA = Free For All - FFA = Free For All
TD = Team Deathmatch - TD = Team Deathmatch
TOU = Tournament - TOU = Tournament
FT = Freeze Tag TD (OSP) - FT = Freeze Tag TD (OSP)
CFTI = Capture The Flag Instagib (OSP) - CFTI = Capture The Flag Instagib (OSP)
TDI = Team Deatchmatch Instagib (OSP) - TDI = Team Deatchmatch Instagib (OSP)
FFAI = Free For All Instagib (OSP) - FFAI = Free For All Instagib (OSP)
CA = Clan Arena (OSP) - CA = Clan Arena (OSP)
CAI = Clan Arena Instagib (OSP) - CAI = Clan Arena Instagib (OSP)
```