Adjust log level information to conform to the rest of the repo

wolveix · Oct 3, 2024 · 923947b · 923947b
1 parent 4912807
commit 923947b
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 32 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -26,6 +26,8 @@ ENV AUTOSAVENUM="5" \
     GAMECONFIGDIR="/config/gamefiles/FactoryGame/Saved" \
     GAMESAVESDIR="/home/steam/.config/Epic/FactoryGame/Saved/SaveGames" \
     LOG="false" \
+    LOGNETLEVEL="Error" \
+    LOGNETTRAFFICLEVEL="Warning" \
     MAXOBJECTS="2162688" \
     MAXPLAYERS="4" \
     MAXTICKRATE="30" \

diff --git a/README.md b/README.md
@@ -130,7 +130,7 @@ services:
       - STEAMBETA=false
     restart: unless-stopped
     healthcheck:
-      test: ["CMD", "bash", "/healthcheck.sh"]
+      test: [ "CMD", "bash", "/healthcheck.sh" ]
       interval: 30s
       timeout: 10s
       retries: 3
@@ -170,34 +170,37 @@ helm install satisfactory k8s-at-home/satisfactory -f values.yaml
 
 ## Environment Variables
 
-| Parameter                 |  Default  | Function                                                         |
-|---------------------------|:---------:|------------------------------------------------------------------|
-| `AUTOSAVENUM`             |    `5`    | number of rotating autosave files                                |
-| `DEBUG`                   |  `false`  | for debugging the server                                         |
-| `DISABLESEASONALEVENTS`   |  `false`  | disable the FICSMAS event (you miserable bastard)                |
-| `LOG`                     |  `false`  | disable Satisfactory log pruning                                 |
-| `LOGNETERRORLEVEL`        |  `Error`  | LogNet errors at or above this log level will be printed         |
-| `LOGNETTRAFFICERRORLEVEL` | `Warning` | LogNetTraffic errors at or above this log level will be printed  |
-| `MAXOBJECTS`              | `2162688` | set the object limit for your server                             |
-| `MAXPLAYERS`              |    `4`    | set the player limit for your server                             |
-| `MAXTICKRATE`             |   `30`    | set the maximum sim tick rate for your server                    |
-| `PGID`                    |  `1000`   | set the group ID of the user the server will run as              |
-| `PUID`                    |  `1000`   | set the user ID of the user the server will run as               |
-| `ROOTLESS`                |  `false`  | run the container as a non-root user                             |
-| `SERVERGAMEPORT`          |  `7777`   | set the game's port                                              |
-| `SERVERIP`                | `0.0.0.0` | set the game's ip (usually not needed)                           |
-| `SERVERSTREAMING`         |  `true`   | toggle whether the game utilizes asset streaming                 |
-| `SKIPUPDATE`              |  `false`  | avoid updating the game on container start/restart               |
-| `STEAMBETA`               |  `false`  | set experimental game version                                    |
-| `TIMEOUT`                 |   `30`    | set client timeout (in seconds)                                  |
-| `VMOVERRIDE`              |  `false`  | skips the CPU model check (should not ordinarily be used)        |
-
-## Network Debugging
-
-The ini values of `Engine:[Core.Log]:LogNet` and `Engine:[Core.Log]:LogNetTraffic` can be modified via the
-`LOGNETERRORLEVEL` and `LOGNETTRAFFICERRORLEVEL` environment variables.
-
-The following log levels are supported: `Fatal, Error, Warning, Display, Log, Verbose, VeryVerbose`
+| Parameter               |  Default  | Function                                                  |
+|-------------------------|:---------:|-----------------------------------------------------------|
+| `AUTOSAVENUM`           |    `5`    | number of rotating autosave files                         |
+| `DEBUG`                 |  `false`  | for debugging the server                                  |
+| `DISABLESEASONALEVENTS` |  `false`  | disable the FICSMAS event (you miserable bastard)         |
+| `LOG`                   |  `false`  | disable Satisfactory log pruning                          |
+| `LOGNETLEVEL`           |  `Error`  | print network logs at or above this log level             |
+| `LOGNETTRAFFICLEVEL`    | `Warning` | print network traffic logs at or above this log level     |
+| `MAXOBJECTS`            | `2162688` | set the object limit for your server                      |
+| `MAXPLAYERS`            |    `4`    | set the player limit for your server                      |
+| `MAXTICKRATE`           |   `30`    | set the maximum sim tick rate for your server             |
+| `PGID`                  |  `1000`   | set the group ID of the user the server will run as       |
+| `PUID`                  |  `1000`   | set the user ID of the user the server will run as        |
+| `ROOTLESS`              |  `false`  | run the container as a non-root user                      |
+| `SERVERGAMEPORT`        |  `7777`   | set the game's port                                       |
+| `SERVERIP`              | `0.0.0.0` | set the game's ip (usually not needed)                    |
+| `SERVERSTREAMING`       |  `true`   | toggle whether the game utilizes asset streaming          |
+| `SKIPUPDATE`            |  `false`  | avoid updating the game on container start/restart        |
+| `STEAMBETA`             |  `false`  | set experimental game version                             |
+| `TIMEOUT`               |   `30`    | set client timeout (in seconds)                           |
+| `VMOVERRIDE`            |  `false`  | skips the CPU model check (should not ordinarily be used) |
+
+For the log level variables, the following values are supported by the game:
+
+- `Fatal`
+- `Error`
+- `Warning`
+- `Display`
+- `Log`
+- `Verbose`
+- `VeryVerbose`
 
 ## Experimental Branch
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -16,7 +16,7 @@ services:
       - STEAMBETA=false
     restart: unless-stopped
     healthcheck:
-      test: ["CMD", "bash", "/healthcheck.sh"]
+      test: [ "CMD", "bash", "/healthcheck.sh" ]
       interval: 30s
       timeout: 10s
       retries: 3

diff --git a/run.sh b/run.sh
@@ -46,8 +46,8 @@ else
 fi
 
 ini_args=(
-  "-ini:Engine:[Core.Log]:LogNet=${LOGNETERRORLEVEL:-Error}"
-  "-ini:Engine:[Core.Log]:LogNetTraffic=${LOGNETTRAFFICERRORLEVEL:-Warning}"
+  "-ini:Engine:[Core.Log]:LogNet=$LOGNETLEVEL"
+  "-ini:Engine:[Core.Log]:LogNetTraffic=$LOGNETTRAFFICLEVEL"
   "-ini:Engine:[/Script/FactoryGame.FGSaveSession]:mNumRotatingAutosaves=$AUTOSAVENUM"
   "-ini:Engine:[/Script/Engine.GarbageCollectionSettings]:gc.MaxObjectsInEditor=$MAXOBJECTS"
   "-ini:Engine:[/Script/OnlineSubsystemUtils.IpNetDriver]:LanServerMaxTickRate=$MAXTICKRATE"