Remove debug.

Add mods README.
Update docs to reflect the current state of the code...up to a point...WIP.
This commit is contained in:
Daniel Ceregatti 2023-06-14 19:49:39 -07:00
parent 4a6427f893
commit 46b8cce5cf
3 changed files with 31 additions and 13 deletions

View file

@ -74,7 +74,7 @@ docker compose up -d server
Tail the log: Tail the log:
``` ```
docker compose logs -f docker compose logs -f server
``` ```
## Stop ## Stop
@ -97,14 +97,13 @@ The following management commands presume the server has been brought [up](#run)
### RCON ### RCON
A terminal-based RCON client is included: https://github.com/indepth666/py3rcon. A terminal-based RCON client is included: https://github.com/indepth666/py3rcon.
The dayzserver script manages what's necessary to configure and run it: The dz script manages what's necessary to configure and run it:
``` ```
docker compose exec server dayzserver rcon docker compose exec server dz rcon
``` ```
To reset the RCON password in the Battle Eye configuration file, simply delete it, and a random one will be generated To reset the RCON password in the Battle Eye configuration file, simply delete it, and a random one will be generated on the next server startup:
on the next server startup:
``` ```
docker compose run --rm server rm serverfiles/battleye/baserver_x64_active* docker compose run --rm server rm serverfiles/battleye/baserver_x64_active*
@ -121,7 +120,7 @@ docker compose down
Then run the command: Then run the command:
``` ```
docker compose run --rm web dayzserver update docker compose run --rm web dz update
``` ```
Don't forget to [bring it back up](#run). Don't forget to [bring it back up](#run).
@ -129,13 +128,13 @@ Don't forget to [bring it back up](#run).
### Stop the server ### Stop the server
``` ```
docker compose exec server dayzserver stop docker compose exec server dz stop
``` ```
The server doesn't always exit when stopping it (SIGINT). When this happens, it's necessary to force stop it (SIGKILL): The server doesn't always exit when stopping it (SIGINT). When this happens, it's necessary to force stop it (SIGKILL):
``` ```
docker compose exec server dayzserver force docker compose exec server dz force
``` ```
When the server exits cleanly, i.e. exit code 0, the container also stops. Otherwise, a crash is presumed, and the server will be restarted. When the server exits cleanly, i.e. exit code 0, the container also stops. Otherwise, a crash is presumed, and the server will be restarted.
@ -148,8 +147,8 @@ required. This is not a clean exit, and will cause the server to restart. Manual
Interactive interface for managing mods. Interactive interface for managing mods.
``` ```
docker compose exec server dayzserver activate id | add id1 | deactivate id | list | modupdate | remove id docker compose exec server dz activate id | add id1 | deactivate id | list | modupdate | remove id
docker compose exec server dayzserver a id | add id1 | d id | l | m | r id docker compose exec server dz a id | add id1 | d id | l | m | r id
``` ```
Look for mods in the [DayZ Workshop](https://steamcommunity.com/app/221100/workshop/). Browse to one. In its URL will be Look for mods in the [DayZ Workshop](https://steamcommunity.com/app/221100/workshop/). Browse to one. In its URL will be
@ -157,7 +156,7 @@ an `id` parameter. Here is the URL to SimpleAutoRun: https://steamcommunity.com/
add it: add it:
``` ```
docker compose exec web dayzserver add 2264162971 docker compose exec web dz add 2264162971
``` ```
Adding and removing mods will add and remove their names from the `-mod=` parameter. Adding and removing mods will add and remove their names from the `-mod=` parameter.

21
files/mods/README.md Normal file
View file

@ -0,0 +1,21 @@
# Mods
## Custom mod integrations
The goal is to provide the ability to quickly and easily integrate a mod's extra files:
* Custom map mods that require mission files to be installed.
* Mods that require extra files to be merged into mission files.
* Mods that require extra integration steps in the profiles directory.
### [Banov](https://steamcommunity.com/sharedfiles/filedetails/?id=2415195639)
A custom map mod. The integration script installs the mission files from their github.
### [Raptors](https://steamcommunity.com/sharedfiles/filedetails/?id=2684950452)
...
### [Red Falcon Flight System Heliz](https://steamcommunity.com/sharedfiles/filedetails/?id=2692979668)
A mod that adds helicopters. The integration merges `types.xml`, `events.xml`, `cfgspawnabletypes.xml`, and `cfgeventspawns.xml` into the mission files. This allows for configuring spawn points on all the [supported maps](https://github.com/RedFalconKen/RedFalconFlightSystem-Heliz/tree/main/Config%20Files/Event%20Spawn%20Config), what helicopters spawn, how many, their parts, etc..

View file

@ -54,8 +54,6 @@ get_mod_id(){
# Get mod name by ID or index # Get mod name by ID or index
get_mod_name(){ get_mod_name(){
ID=$(get_mod_id ${1}) ID=$(get_mod_id ${1})
echo "ID: ${ID}" >&2
exit 0
if ! [ -d "${WORKSHOP_DIR}/${ID}" ] if ! [ -d "${WORKSHOP_DIR}/${ID}" ]
then then
echo "Mod ID ${1} doesn't exist" >&2 echo "Mod ID ${1} doesn't exist" >&2