Release 1.16.2

Dockerfile

@@ -29,7 +29,8 @@ RUN mv GameData/Config/dedicated_cfg.txt dedicated_cfg.txt.bk && \
     mkdir -p Tracksbk/MatchSettings && \
     mkdir -p Tracksbk/Campaigns/Nations && \
     mv GameData/Tracks/MatchSettings/Nations/NationsBlue.txt Tracksbk/MatchSettings/MatchSettings.txt && \
-    mv GameData/Tracks/Campaigns/Nations/Blue Tracksbk/Campaigns/Nations/
+    mv GameData/Tracks/Campaigns/Nations/Blue Tracksbk/Campaigns/Nations/ && \
+    rm -rf GameData/Tracks
 # expose volumes
 VOLUME /app/server/GameData/Config
 VOLUME /app/server/GameData/Tracks

Plugins.ts

@@ -20,3 +20,4 @@ import './plugins/info_messages/InfoMessages.js'
 import './plugins/skip_endscreen/SkipEndscreen.js'
 import './plugins/ultimania/Ultimania.js'
 import './plugins/live_checkpoints/LiveCheckpoints.js'
+import './plugins/dynamic_time_limit/DynamicTimeLimit.js'

Update.js

@@ -57,9 +57,18 @@ async function hashFile(path) {
 
 async function generateHashes() {
   console.log('Generating hashes for current files...')
-  const entries = (await fs.readdir('./src', { recursive: true, withFileTypes: true }))
-  .concat(await fs.readdir('./plugins', { recursive: true, withFileTypes: true }))
-  .concat(await fs.readdir('./config', { recursive: true, withFileTypes: true }))
+  const entries = (await fs.readdir('./src', {
+    recursive: true,
+    withFileTypes: true
+  }))
+  .concat(await fs.readdir('./plugins', {
+    recursive: true,
+    withFileTypes: true
+  }))
+  .concat(await fs.readdir('./config', {
+    recursive: true,
+    withFileTypes: true
+  }))
 
   const res = new Map(
     await Promise.all(entries.filter(a => a.isFile() && (a.name.endsWith('.js') || a.name.endsWith('.ts')))
@@ -118,6 +127,7 @@ async function doUpdate(fromPath, newHashes, oldHashes = null) {
       errorOccurred = true
     }
   }
+
   // copy new hashes so you only have to update once
   try {
     await fs.copyFile(process.argv[2], '.hashes.json')
@@ -130,27 +140,35 @@ async function doUpdate(fromPath, newHashes, oldHashes = null) {
     console.log('Errors occurred during update, exiting...')
     process.exit(1)
   }
-  let log = 'Update successful!'
+
+  let log = `Update log to version ${JSON.parse(
+    await fs.readFile(path.join(fromPath, 'package.json'), { encoding: 'utf-8' }))['version']}\n\n`
   if (conflicts.length > 0) {
     console.log('!!! Update conflicts, make sure to fix them by comparing your files to files ending in .new !!!')
     console.log('If you do not fix these conflicts, the controller might fail to start or crash.')
     console.log('Affected files: ')
-    log = 'Update did not succeed because of conflicts. Please merge the following files manually:\n'
+    log += 'Update did not succeed because of conflicts. Please merge the following files manually:\n'
     conflicts.forEach(name => {
       console.log(name)
       log += name + '\n'
     })
     console.log('_____________________________________')
+  } else {
+    log += 'Update successful!'
   }
+
   try {
     await fs.writeFile('update.log', log, { encoding: 'utf-8' })
   } catch(e) {
     console.log('Failed to write update log.')
     console.log(e)
   }
-  if (conflicts.length > 0) { process.exit(2) }
+
+  if (conflicts.length > 0) {
+    process.exit(2)
+  }
   if (updatePerformed) {
-    console.log('Update successful.')
+    console.log('Update successful!')
   } else {
     console.log('Update not necessary.')
   }

config/Config.js

@@ -35,7 +35,7 @@ export default {
     kick: 1,
     forceSpectator: 1,
     addMap: 1,
-    removeMap: 1,
+    removeMap: 1
   },
   /**
    * Enable this for Trakman to take over handling maps. The controller will read maps from a folder
@@ -51,16 +51,16 @@ export default {
     /** Path to the `GameData/Tracks/` directory of the server. MUST end with a slash '/'!
      * Default value: "../GameData/Tracks/" assuming the Trakman directory is on the same level as the server.
      */
-    mapsDirectoryPrefix: "../GameData/Tracks/",
+    mapsDirectoryPrefix: '../GameData/Tracks/',
     /** Relative path to all the maps. Read recursively from `GameData/Tracks/`.
      *  MUST end with a slash '/' when a directory is specified (i.e. if not left empty)!
      *  Default value: ""
      */
-    mapsDirectory: "",
+    mapsDirectory: '',
     /** Ignore non-stadium maps */
     stadiumOnly: undefined,
     /** Amount of maps to load into the server. Default value: 5 */
-    preloadMaps: 5,
+    preloadMaps: 5
   },
   /**
    * When adding a large amount of maps, it is better to add them in smaller chunks. This is the size
@@ -77,12 +77,14 @@ export default {
   defaultTimeAttackTimeLimit: 300000,
   /** Minimal time value to which the dynamic timer can be set (in milliseconds) */
   dynamicTimerSubtractionLimit: 30000,
+  /** CallVotes are skip/restart votes that can be done through the ingame UI (ESC>Advanced Options), setting it to -1 disables CallVotes entirely */
+  callVoteRatio: -1,
   /** Relative path (/GameData/Config/) to the blacklist file */
-  blacklistFile: "blacklist.txt",
+  blacklistFile: 'blacklist.txt',
   /** Relative path (/GameData/Config/) to the guestlist file */
-  guestlistFile: "guestlist.txt",
-  /** Relative path (/GameData/Tracks/) to the matchsettings file */
-  matchSettingsFile: "MatchSettings/MatchSettings.txt",
+  guestlistFile: 'guestlist.txt',
+  /** Relative path (/GameData/Tracks/) to the match settings file, ignored if manualMapLoading is enabled */
+  matchSettingsFile: 'MatchSettings/MatchSettings.txt',
   /** Default message sent as the reason for administrative actions if nothing was specified by the admin */
   defaultReasonMessage: 'No reason specified',
   /** Things that will be interpreted as true for the boolean command parameter */
@@ -92,10 +94,12 @@ export default {
   /** Object with options for ufuzzy, see https://github.com/leeoniya/uFuzzy#options */
   searchOptions: {
     intraMode: 1,
-    alpha: "a-zа-яё"
+    alpha: 'a-zа-яё'
   },
-  /** Current controller version */
-  version: "1.6.1",
-  /** Controller repository link */
-  repo: "github.com/lythx/trakman",
+  /** When using `matchString()` util with `stripTrackmaniaFormatting = true`, values are cached to optimize performance */
+  matchStringCacheSize: 10000,
+  /** If haystack size exceeds this threshold `matchString()` will skip expensive haystack processing to optimize performance */
+  matchStringReduxModeThreshold: 5000,
+  /** Custom map environments. If a map has an environment that is not in this list, it will be marked as "Stadium" */
+  customEnvironments: ["Highlands", "NewSnowCar"]
 }

docker-compose.yml

@@ -53,6 +53,8 @@ services:
       DISCORD_EMBED_TITLE_URL: ""
       DISCORD_EMBED_TITLE_ICON_URL: ""
       DISCORD_TAGGED_USERS: ""
+      # Setup
+      UPDATE_UTILITY_DISABLED: "NO"
     ports: # Don't forget to change the ports
            # if you already have another server running
            # **The ports MUST match** because of the way the server works

docker_run.sh

@@ -5,7 +5,7 @@
 # create and copy dedicated config
 if find /app/server/GameData/Config -mindepth 1 -maxdepth 1 | read; then
   echo 'Server config exists, skipping initial setup.'
-  rm dedicated_cfg.txt.bk
+  rm dedicated_cfg.txt.bk 2>/dev/null
 else
   echo 'Setting up server...'
   # ugly xml replacement
@@ -17,35 +17,63 @@ else
   xml ed -L -u "/dedicated/masterserver_account/password" -v "$SERVER_ACC_PASSWORD" dedicated_cfg.txt.bk
   xml ed -L -u "/dedicated/masterserver_account/validation_key" -v "$SERVER_ACC_KEY" dedicated_cfg.txt.bk
   xml ed -L -u "/dedicated/server_options/name" -v "$SERVER_NAME" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/comment" -v "$SERVER_COMMENT" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/hide_server" -v "${SERVER_HIDE_SERVER=0}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/max_players" -v "${SERVER_MAX_PLAYERS=32}" dedicated_cfg.txt.bk
   xml ed -L -u "/dedicated/server_options/password" -v "$SERVER_PASSWORD" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/max_spectators" -v "${SERVER_MAX_SPECTATORS=32}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/password_spectator" -v "$SERVER_PASSWORD_SPECTATOR" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/ladder_mode" -v "${SERVER_LADDER_MODE=1}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/ladder_serverlimit_min" -v "${SERVER_LADDER_SERVERLIMIT_MIN=0}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/ladder_serverlimit_max" -v "${SERVER_LADDER_SERVERLIMIT_MAX=50000}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/enable_p2p_upload" -v "${SERVER_ENABLE_P2P_UPLOAD=True}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/server_options/enable_p2p_download" -v "${SERVER_ENABLE_P2P_DOWNLOAD=True}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/system_config/connection_uploadrate" -v "${SERVER_CONNECTION_UPLOADRATE=512}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/system_config/connection_downloadrate" -v "${SERVER_CONNECTION_DOWNLOADRATE=8192}" dedicated_cfg.txt.bk
   xml ed -L -u "/dedicated/system_config/server_port" -v "$SERVER_NET_PORT" dedicated_cfg.txt.bk
   xml ed -L -u "/dedicated/system_config/server_p2p_port" -v "$SERVER_P2P_PORT" dedicated_cfg.txt.bk
   xml ed -L -u "/dedicated/system_config/xmlrpc_port" -v "$SERVER_PORT" dedicated_cfg.txt.bk
-  xml ed -L -u "/dedicated/system_config/packmask" -v "$SERVER_PACKMASK" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/system_config/xmlrpc_allowremote" -v "${REMOTE_XMLRPC=False}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/system_config/packmask" -v "${SERVER_PACKMASK=nations}" dedicated_cfg.txt.bk
+  xml ed -L -u "/dedicated/system_config/disable_coherence_checks" -v "${SERVER_DISABLE_COHERENCE_CHECKS=laps}" dedicated_cfg.txt.bk
   mv /app/server/dedicated_cfg.txt.bk /app/server/GameData/Config/dedicated_cfg.txt
 fi
 # copy over default tracks
 if find /app/server/GameData/Tracks -mindepth 1 -maxdepth 1 | read; then
   echo 'Tracks exist, skipping initial setup.'
-  rm -r Tracksbk
+  rm -r Tracksbk 2>/dev/null
 else
   echo 'Setting up tracks...'
   mv /app/server/Tracksbk/* /app/server/GameData/Tracks/
 fi
 # update and copy over Trakman directory
 if find /app/server/trakman -mindepth 1 -maxdepth 1 | read; then
-  echo 'Trakman exists. Attempting update...'
-  cd trakman || exit
-  cp ../trakmanbk/Update.js .
-  node Update.js /app/server/trakmanbk/.hashes.json
-  if [ $? -gt 0 ]; then
-    chown server:server update.log
-    echo 'Update not fully successful, please stop the container.'
-    sleep 1m # wait a minute for user to read the message, or to realise something's wrong
-    exit
+  if [ "$UPDATE_UTILITY_DISABLED" = "YES" ]; then
+    echo 'Trakman exists, skipping initial setup.'
+  else
+    echo 'Trakman exists. Attempting update...'
+    if ! cd trakman 2>/dev/null
+    then
+      echo 'Trakman actually does not exist. This makes no sense. Aborting and trying again.'
+      exit
+    fi
+    if ! cp ../trakmanbk/Update.js . 2>/dev/null
+    then
+      # this runs if trakmanbk doesn't exist so we have nothing to update from
+      echo "Update not available."
+    else
+      if ! node Update.js /app/server/trakmanbk/.hashes.json
+      then
+        # this runs if trakmanbk exists and the update script fails
+        chown server:server update.log
+        echo 'Update not fully successful, please stop the container.'
+        sleep 1m # wait a minute for the user to read the message, or to realise something's wrong
+        exit 1
+      fi
+    fi
+    cd ..
   fi
-  cd ..
-  rm -r trakmanbk
+  rm -r trakmanbk 2>/dev/null
 else
   echo 'Setting up Trakman...'
   mv /app/server/trakmanbk/* /app/server/trakman/
@@ -63,6 +91,7 @@ touch trakman/logs/trace.log
 mkdir -p .pm2/logs
 touch .pm2/logs/Trakman-error.log
 touch .pm2/logs/Trakman-out.log
+touch .pm2/logs/docker.log
 mkdir -p trakman/temp
 touch trakman/temp/rank_coherence.txt
 mkdir -p trakman/plugins/server_links/temp
@@ -72,16 +101,18 @@ chown -R server:server /app/server
 echo "#!/bin/sh
 (while true; do
   /app/server/TrackmaniaServer /game_settings=MatchSettings/MatchSettings.txt /dedicated_cfg=dedicated_cfg.txt /nodaemon
-  echo 'Server exited with code ' $?
+  echo [\$(date +'%d %b %Y %T.%3N')] Server exited with code \$? | tee -a /app/server/.pm2/logs/docker.log
   echo 'Restarting...'
-done) &
-npm i --prefix /app/server/trakman
-npm run build --prefix /app/server/trakman
+done) &" > run.sh
+if [ "$INSTALL_ON_STARTUP" != "NO" ]; then
+  echo "npm i --prefix /app/server/trakman" >> run.sh
+fi
+echo "npm run build --prefix /app/server/trakman
 chmod -R a+w /app/server
 cd trakman
 trap 'echo Terminating; npx pm2 stop 0; npx pm2 kill; exit' SIGTERM SIGINT
-npx pm2 start ./built/src/Main.js --name Trakman
-wait $!" > run.sh
+npm run daemon
+wait \$!" >> run.sh
 chown server:server run.sh
 chmod 766 run.sh
 exec su-exec server ./run.sh