Updated the documentation

README.md

@@ -18,3 +18,4 @@ You can find more examples of the program in action [here](examples/).
 * [Setting up Chapter H data](https://vasl-templates.org/help?tab=chapterh)
 * [Writing your own templates](https://vasl-templates.org/help?tab=templatepacks)
 * [For developers](https://vasl-templates.org/help?tab=fordevelopers)
+* [FAQ](https://vasl-templates.org/FAQ)

requirements.txt

@@ -1,4 +1,4 @@
-# python 3.10.4
+# python 3.10.7
 
 flask==2.1.2
 pyyaml==6.0

run-container.sh

@@ -14,6 +14,11 @@ function main
     VASL_BOARDS=
     CHAPTER_H_NOTES=
     USER_FILES=
+    LOGGING_CONFIG=
+    VASSAL_SHIM_LOGGING_CONFIG=
+    ASA_INDEX=
+    ROAR_INDEX=
+    VO_NOTES_IMAGE_CACHE=
     TEMPLATE_PACK=
     IMAGE_TAG=latest
     CONTAINER_NAME=vasl-templates
@@ -31,7 +36,7 @@ function main
         print_help
         exit 0
     fi
-    params="$(getopt -o p:v:e:k:t:d -l port:,control-tests-port:,vassal:,vasl:,vasl-extensions:,boards:,chapter-h:,template-pack:,user-files:,tag:,name:,detach,no-build,build-arg:,build-network:,run-network:,test-data-vassal:,test-data-vasl-mods:,help --name "$0" -- "$@")"
+    params="$(getopt -o p:v:e:k:t:d -l port:,control-tests-port:,vassal:,vasl:,vasl-extensions:,boards:,chapter-h:,template-pack:,user-files:,logging:,vassal-shim-logging:,asa-index:,roar-index:,vo-notes-image-cache:,tag:,name:,detach,no-build,build-arg:,build-network:,run-network:,test-data-vassal:,test-data-vasl-mods:,help --name "$0" -- "$@")"
     if [ $? -ne 0 ]; then exit 1; fi
     eval set -- "$params"
     while true; do
@@ -60,6 +65,21 @@ function main
             -k | --template-pack)
                 TEMPLATE_PACK=$2
                 shift 2 ;;
+            --logging)
+                LOGGING_CONFIG=$2
+                shift 2 ;;
+            --vassal-shim-logging)
+                VASSAL_SHIM_LOGGING_CONFIG=$2
+                shift 2 ;;
+            --asa-index)
+                ASA_INDEX=$2
+                shift 2 ;;
+            --roar-index)
+                ROAR_INDEX=$2
+                shift 2 ;;
+            --vo-notes-image-cache)
+                VO_NOTES_IMAGE_CACHE=$2
+                shift 2 ;;
             -t | --tag)
                 IMAGE_TAG=$2
                 shift 2 ;;
@@ -186,7 +206,67 @@ function main
         fi
         mpoint=/data/template-pack
         TEMPLATE_PACK_VOLUME="--volume $target:$mpoint"
-        TEMPLATE_PACK_ENV="--env DEFAULT_TEMPLATE_PACK=$mpoint --env DEFAULT_TEMPLATE_PACK_TARGET"
+        TEMPLATE_PACK_ENV="--env DEFAULT_TEMPLATE_PACK=$mpoint"
+    fi
+
+    # check if logging has been configured
+    if [ -n "$LOGGING_CONFIG" ]; then
+        target=$( get_target FILE "$LOGGING_CONFIG" )
+        if [ -z "$target" ]; then
+            echo "Can't find the logging config file: $LOGGING_CONFIG"
+            exit 1
+        fi
+        mpoint=/app/vasl_templates/webapp/config/logging.yaml
+        LOGGING_CONFIG_VOLUME="--volume $target:$mpoint"
+    fi
+    if [ -n "$VASSAL_SHIM_LOGGING_CONFIG" ]; then
+        target=$( get_target FILE "$VASSAL_SHIM_LOGGING_CONFIG" )
+        if [ -z "$target" ]; then
+            echo "Can't find the VASSAL shim logging config file: $VASSAL_SHIM_LOGGING_CONFIG"
+            exit 1
+        fi
+        mpoint=/app/vassal-shim/release/logback-test.xml
+        VASSAL_SHIM_LOGGING_CONFIG_VOLUME="--volume $target:$mpoint"
+    fi
+
+    # check if external ASA/ROAR index files have been specified
+    # NOTE: We don't need to pass env.vars into the container, or anything like that. The code already
+    # saves the downloaded files in /tmp/ (inside the container), so all we need to do is map these files
+    # to the specified external files.
+    if [ -n "$ASA_INDEX" ]; then
+        target=$( realpath --no-symlinks "$ASA_INDEX" )
+        if [ ! -f "$target" ]; then
+            if ! touch "$target" 2>/dev/null; then
+                echo "Can't find the ASA index file: $ASA_INDEX"
+                exit 1
+            fi
+        fi
+        mpoint=/tmp/asl-scenario-archive.json
+        ASA_INDEX_VOLUME="--volume $target:$mpoint"
+    fi
+    if [ -n "$ROAR_INDEX" ]; then
+        target=$( realpath --no-symlinks "$ROAR_INDEX" )
+        if [ ! -f "$target" ]; then
+            if ! touch "$target" 2>/dev/null ; then
+                echo "Can't find the ROAR index file: $ASA_INDEX"
+                exit 1
+            fi
+        fi
+        mpoint=/tmp/roar-scenario-index.json
+        ROAR_INDEX_VOLUME="--volume $target:$mpoint"
+    fi
+
+    # check if an external v/o notes image cache directory has been specified
+    if [ -n "$VO_NOTES_IMAGE_CACHE" ]; then
+        target=$( realpath --no-symlinks "$VO_NOTES_IMAGE_CACHE" )
+        if [ ! -d "$target" ]; then
+            if ! mkdir "$target" 2>/dev/null; then
+                echo "Can't find the V/O notes image cache directory: $VO_NOTES_IMAGE_CACHE"
+                exit 1
+            fi
+        fi
+        mpoint=/tmp/vo-notes-image-cache/
+        VO_NOTES_IMAGE_CACHE_VOLUME="--volume $target:$mpoint"
     fi
 
     # check if testing has been enabled
@@ -219,6 +299,8 @@ function main
         --env DOCKER_CONTAINER_NAME="$CONTAINER_NAME" \
         $CONTROL_TESTS_PORT_RUN \
         $VASSAL_VOLUME $VASL_MOD_VOLUME $VASL_EXTNS_VOLUME $VASL_BOARDS_VOLUME $CHAPTER_H_NOTES_VOLUME $TEMPLATE_PACK_VOLUME $USER_FILES_VOLUME \
+        $LOGGING_CONFIG_VOLUME $VASSAL_SHIM_LOGGING_CONFIG_VOLUME \
+        $ASA_INDEX_VOLUME $ROAR_INDEX_VOLUME $VO_NOTES_IMAGE_CACHE_VOLUME \
         $VASSAL_ENV $VASL_MOD_ENV $VASL_EXTNS_ENV $VASL_BOARDS_ENV $CHAPTER_H_NOTES_ENV $TEMPLATE_PACK_ENV $USER_FILES_ENV \
         $RUN_NETWORK $DETACH \
         $TEST_DATA_VASSAL $TEST_DATA_VASL_MODS \
@@ -288,10 +370,15 @@ function print_help {
         --build-network    Docker network to use when building the image.
         --run-network      Docker network to use when running the container.
 
+    Options for storing data files outside the container (so that they can be re-used):
+        --asa-index             Path to the ASL Scenario Archive index file (downloaded).
+        --roar-index            Path to the ROAR index file (downloaded).
+        --vo-notes-image-cache  Cache directory for images generated for vehicle/ordnance notes.
+
     Options for the test suite:
-      --control-tests-port   Remote test control port number.
-      --test-data-vassal     Directory containing VASSAL releases.
-      --test-data-vasl-mods  Directory containing VASL modules.
+      --control-tests-port      Remote test control port number.
+      --test-data-vassal        Directory containing VASSAL releases.
+      --test-data-vasl-mods     Directory containing VASL modules.
 
 NOTE: If the port the webapp server is listening on *inside* the container is different
 to the port exposed *outside* the container, webdriver image generation (e.g. Shift-Click

setup.py

@@ -28,7 +28,7 @@ def parse_requirements( fname ):
 
 setup(
     name = "vasl_templates",
-    version = "1.10", # nb: also update constants.py
+    version = "1.11", # nb: also update constants.py
     description = "Create HTML snippets for use in VASL.",
     license = "AGPLv3",
     url = "https://code.pacman-ghost.com/public/vasl-templates",

vasl_templates/tools/get_piece_info.py

@@ -64,6 +64,14 @@ for piece_info in doc.getroot():
     if info:
         report[ gpid ] = info
 
+# FUDGE! These are from extensions - it's not worth trying to figure these out programtically.
+report[ "adf:1948" ] = { "is_small": True } # BFP Blood & Jungle: Dutch Brandt 47mm Mortar
+report[ "adf:75" ] = { "is_small": True } # BFP Blood & Jungle: Indonesian Type 89 Heavy Grenade Launcher
+report[ "adf:77" ] = { "is_small": True } # BFP Blood & Jungle: Indonesian Type 97 Automatic Gun
+report[ "adf:76" ] = { "is_small": True } # BFP Blood & Jungle: Indonesian Year-11 Flat-Trajectory INF Gun
+report[ "adf:1407" ] = { "is_small": True } # BFP Poland In Flames: German 2cm Tankbusche S-18
+report[ "08d:75" ] = { "is_small": True } # Fight For Seoul: American M20(L) 75mm Recoilless Rifle
+
 # output the final report
 print( "{" )
 lines = []

vasl_templates/webapp/config/constants.py

@@ -4,7 +4,7 @@ import sys
 import os
 
 APP_NAME = "VASL Templates"
-APP_VERSION = "v1.10" # nb: also update setup.py
+APP_VERSION = "v1.11" # nb: also update setup.py
 APP_DESCRIPTION = "Generate HTML for use in VASL scenarios."
 APP_HOME_URL = "https://vasl-templates.org"
 

vasl_templates/webapp/config/site.cfg.example

@@ -2,7 +2,7 @@
 
 ; configure VASSAL and VASL
 VASSAL_DIR = ...configure the VASSAL installation directory...
-VASL_MOD = ...configure the VASL module (e.g. vasl-6.6.5.vmod)...
+VASL_MOD = ...configure the VASL module (e.g. vasl-6.6.6.vmod)...
 VASL_EXTNS_DIR = ...configure the VASL extensions directory...
 BOARDS_DIR = ...configure the VASL boards directory...
 

vasl_templates/webapp/data/default-template-pack/extras/booby-traps.j2

@@ -3,13 +3,20 @@
 <!-- vasl-templates:name Booby Traps -->
 <!-- vasl-templates:description Data chart for Booby Traps. -->
 
+<!-- player = {{PLAYER_DROPLIST:|Player}}
 <!-- boards = {{BOARDS*:/8|Board(s)}} -->
 
 <head>
 <meta charset="utf-8">
 <style>
+.header {
+    background: {{PLAYER_COLORS[PLAYER_DROPLIST][0]}} ;
+    border-bottom: 1px solid {{PLAYER_COLORS[PLAYER_DROPLIST][2]}} ;
+    padding: 2px 5px ;
+    font-size: 105% ; font-weight: bold ;
+}
+.header .level { font-size: 90% ; font-style: italic ; }
 {{CSS:common}}
-td.header { background: #f0f0f0 ; border-bottom: 1px solid #c0c0c0 ; padding: 2px 5px ; font-size: 105% ; font-weight: bold ; }
 </style>
 </head>
 
@@ -17,7 +24,7 @@ td.header { background: #f0f0f0 ; border-bottom: 1px solid #c0c0c0 ; padding: 2p
 
 <tr>
 <td class="header">
-Booby Traps (Level {{LEVEL:A::B::C/3|Level}})
+<img src="{{PLAYER_FLAGS[PLAYER_DROPLIST]}}?prefh={{PLAYER_FLAG_SIZE_LARGE}}" width="{{PLAYER_FLAG_SIZE_LARGE}}" height="{{PLAYER_FLAG_SIZE_LARGE}}">&nbsp;Booby Traps <span class="level">(Level {{LEVEL:A::B::C/3|Level}})</span>
 
 <tr>
 <td style="padding:2px 5px;">

vasl_templates/webapp/data/vasl-6.6.6/expected-multiple-images.json

@@ -0,0 +1,61 @@
+{
+
+"1555": {
+    "name": "2pdr Portee",
+    "front_images": [ "br/vehicles/portee.gif", "br/vehicles/portee0.gif" ],
+    "back_images": null
+},
+
+"2212": {
+    "name": "76* INF FRC",
+    "front_images": [ "al/gun/alINF76.gif", "al/gun/alINF76u.gif" ],
+    "back_images": "al/gun/alINF76b.gif"
+},
+
+"2698": {
+    "name": "SPW 251/10",
+    "front_images": "ge/veh/spw25110.gif",
+    "back_images": [ "No_ATR.gif", "No_PSK.gif" ]
+},
+
+"6765": {
+    "name": "81* MTR Krh/32",
+    "front_images": "fi/gun/fi81mmMTR.png",
+    "back_images": [ "fi/gun/fi81mmMTR.png", "fi/gun/fi81mmMTRB.png" ]
+},
+
+"6782": {
+    "name": "81* MTR Savu M42",
+    "front_images": [ "fi/gun/fi81mmMTR SavuB.png", "fi/gun/fi81mmMTR Savu.png" ],
+    "back_images": "fi/gun/fi81mmMTR SavuB.png"
+},
+
+"7409": {
+    "name": "76 ItK/28 B(s)",
+    "front_images": "fi/gun/fiAA76L.png",
+    "back_images": [ "fi/gun/fiAA76L.png", "fi/gun/fiAA76LB.png" ]
+},
+
+"adf:1828": {
+    "name": "105 ART wz.29",
+    "front_images": "po/gun/poARTwz29-BFP.png",
+    "back_images": [ "po/gun/poARTwz29-BFP.png", "po/gun/poARTwz29-BFPb.png" ]
+},
+"adf:1829": {
+    "name": "120* ART wz09.31",
+    "front_images": "po/gun/poARTwz0931-BFP.png",
+    "back_images": [ "po/gun/poARTwz0931-BFP.png", "po/gun/poARTwz0931-BFPb.png" ]
+},
+"adf:1830": {
+    "name": "155 ART wz.17",
+    "front_images": "po/gun/poARTwz17-BFP.png",
+    "back_images": [ "po/gun/poARTwz17-BFP.png", "po/gun/poARTwz17-BFPb.png" ]
+},
+
+"3b5:3676": {
+    "name": "M19A1 MGMC",
+    "front_images": [ "us/veh/usM19A1MGMC(trailer)KFW.png", "us/veh/usM19A1MGMC(KFW).png" ],
+    "back_images": null
+}
+
+}

vasl_templates/webapp/data/vasl-6.6.6/online-counter-images.json

@@ -0,0 +1,2 @@
+{
+}

vasl_templates/webapp/data/vasl-6.6.6/piece-info.json

@@ -0,0 +1,71 @@
+{
+"6996": {"is_small": true},
+"485": {"is_small": true},
+"850": {"is_small": true},
+"849": {"is_small": true},
+"12689": {"is_small": true},
+"856": {"is_small": true},
+"857": {"is_small": true},
+"11336": {"is_small": true},
+"858": {"is_small": true},
+"11337": {"is_small": true},
+"1149": {"is_small": true},
+"1153": {"is_small": true},
+"12687": {"is_small": true},
+"3b5:7613": {"is_small": true},
+"11359": {"is_small": true},
+"3b5:11259": {"is_small": true},
+"1632": {"is_small": true},
+"1636": {"is_small": true},
+"1641": {"is_small": true},
+"1648": {"is_small": true},
+"1982": {"is_small": true},
+"1983": {"is_small": true},
+"1984": {"is_small": true},
+"1985": {"is_small": true},
+"1986": {"is_small": true},
+"1987": {"is_small": true},
+"1988": {"is_small": true},
+"2172": {"is_small": true},
+"2173": {"is_small": true},
+"2176": {"is_small": true},
+"2179": {"is_small": true},
+"11391": {"is_small": true},
+"11392": {"is_small": true},
+"11395": {"is_small": true},
+"11396": {"is_small": true},
+"11440": {"is_small": true},
+"3b5:8401": {"is_small": true},
+"3b5:8402": {"is_small": true},
+"2465": {"is_small": true},
+"2474": {"is_small": true},
+"3252": {"is_small": true},
+"3253": {"is_small": true},
+"3263": {"is_small": true},
+"3422": {"is_small": true},
+"3428": {"is_small": true},
+"6730": {"is_small": true},
+"3605": {"is_small": true},
+"3608": {"is_small": true},
+"6763": {"is_small": true},
+"3679": {"is_small": true},
+"3680": {"is_small": true},
+"3681": {"is_small": true},
+"3682": {"is_small": true},
+"3691": {"is_small": true},
+"3692": {"is_small": true},
+"3959": {"is_small": true},
+"11558": {"is_small": true},
+"11559": {"is_small": true},
+"3b5:10150": {"is_small": true},
+"3b5:10151": {"is_small": true},
+"11600": {"is_small": true},
+"11604": {"is_small": true},
+"3b5:7871": {"is_small": true},
+"adf:1948": {"is_small": true},
+"adf:75": {"is_small": true},
+"adf:77": {"is_small": true},
+"adf:76": {"is_small": true},
+"adf:1407": {"is_small": true},
+"08d:75": {"is_small": true}
+}

vasl_templates/webapp/data/vasl-6.6.6/vasl-overrides.json

@@ -0,0 +1,147 @@
+{
+
+"2474": {
+    "expected": {
+        "name": "Goliath",
+        "front_images": [ "ge/gegol.gif", "ge/gegolb.gif" ],
+        "back_images": null
+    },
+    "updated": {
+        "front_images": "ge/gegol.gif"
+    }
+},
+
+"1555": {
+    "expected": {
+        "name": "2pdr Portee",
+        "front_images": "br/vehicles/portee.gif",
+        "back_images": [ "br/vehicles/portee.gif", "br/vehicles/portee0.gif" ]
+    },
+    "updated": {
+        "front_images": [ "br/vehicles/portee.gif", "br/vehicles/portee0.gif" ],
+        "back_images": null
+    }
+},
+
+"3463": {
+    "expected": {
+        "name": "75L AA 75/46",
+        "front_images": [ "it/gun/itAA7546.gif", "it/gun/itAA7546b.gif" ],
+        "back_images": [ "it/gun/itAA7546b.gif", "it/gun/itAA7546lb.gif" ]
+    },
+    "updated": {
+        "front_images": "it/gun/itAA7546.gif",
+        "back_images": "it/gun/itAA7546b.gif"
+    }
+},
+
+"3776": {
+    "expected": {
+        "name": "37* INF Skoda IG",
+        "front_images": [ "ax/gun/buIN37s.gif", "ax/gun/buIN37s2.gif" ],
+        "back_images": "ax/gun/buIN37sb.gif"
+    },
+    "updated": {
+        "front_images": "ax/gun/buIN37s.gif"
+    }
+},
+
+"3777": {
+    "expected": {
+        "name": "70* INF Skoda IG",
+        "front_images": [ "ax/gun/buIN37s.gif", "ax/gun/buIN37s2.gif" ],
+        "back_images": "ax/gun/buIN37sb.gif"
+    },
+    "updated": {
+        "front_images": "ax/gun/buIN37s2.gif"
+    }
+},
+
+"6802": {
+    "expected": {
+        "name": "20L (4) AA",
+        "front_images": [ "fi/gun/fi20L4 _2.png", "fi/gun/fi20L4 _2 LIM.png" ],
+        "back_images": null
+    },
+    "updated": {
+        "front_images": "fi/gun/fi20L4 _2.png"
+    }
+},
+
+"6803": {
+    "expected": {
+        "name": "20L VKT (12) AA",
+        "front_images": [ "fi/gun/fi20L12.png", "fi/gun/fi20L12L.png" ],
+        "back_images": null
+    },
+    "updated": {
+        "front_images": "fi/gun/fi20L12.png"
+    }
+},
+
+"6804": {
+    "expected": {
+        "name": "40L Bofors AA (s)",
+        "front_images": [ "fi/gun/fi40L.png", "fi/gun/fi40LL.png" ],
+        "back_images": null
+    },
+    "updated": {
+        "front_images": "fi/gun/fi40L.png"
+    }
+},
+
+"adf:1824": {
+    "expected": {
+        "name": "37L AT PTP obr. 30",
+        "front_images": "ru/gun/ruAT37L.gif",
+        "back_images": "ru/gun/ruAT37Lb.gif"
+    },
+    "updated": {
+        "front_images": "ru/gun/ru37LPTPobr30.png"
+    }
+},
+"adf:1822": {
+    "expected": {
+        "name": "37* INF PP obr. 15R",
+        "front_images": "ru/gun/ruINF37s.gif",
+        "back_images": "ru/gun/ruINF37sb.gif"
+    },
+    "updated": {
+        "front_images": "ru/gun/ru37PPobr15R.png"
+    }
+},
+"adf:1823": {
+    "expected": {
+        "name": "76* INF PP obr. 27",
+        "front_images": "ru/gun/ruINF76s.gif",
+        "back_images": "ru/gun/ruINF76sb.gif"
+    },
+    "updated": {
+        "front_images": "ru/gun/ru76PPobr27.png"
+    }
+},
+
+"3b5:10093": {
+    "expected": {
+        "name": "SL truck",
+        "front_images": [ "sh/SL3b(KFW).png", "sh/SL4b(KFW).png", "sh/SL5b(KFW).png", "sh/SL6b(KFW).png", "sh/SL1b(KFW).png", "sh/SL2b(KFW).png" ],
+        "back_images": [ "sh/SL3(KFW).png", "sh/SL4(KFW).png", "sh/SL5(KFW).png", "sh/SL6(KFW).png", "sh/SL1(KFW).png", "sh/SL2(KFW).png" ]
+    },
+    "updated": {
+        "front_images": "us/veh/usSearchlight(KFW).png",
+        "back_images": null
+    }
+},
+
+"08d:75": {
+    "expected": {
+        "name": "RCL 75*",
+        "front_images": "amrcl75-malf.png",
+        "back_images": "dm-75rcl.gif"
+    },
+    "updated": {
+        "front_images": "amrcl75.png"
+    }
+}
+
+}

vasl_templates/webapp/downloads.py

@@ -65,6 +65,8 @@ class DownloadedFile:
                 if len(data) < 1024 and os.path.isfile( data ):
                     with open( data, "r", encoding="utf-8" ) as fp:
                         data = fp.read()
+                if len( data ) == 0:
+                    return
                 self._data = json.loads( data )
                 # notify the owner
                 if self.on_data:
@@ -115,7 +117,7 @@ class DownloadedFile:
                     _logger.info( "Download of the %s file has been disabled.", df.key )
                     continue
                 ttl *= 60*60
-                if os.path.isfile( df.cache_fname ):
+                if os.path.isfile( df.cache_fname ) and os.stat( df.cache_fname ).st_size > 0:
                     # yup - check how long ago it was downloaded
                     mtime = os.path.getmtime( df.cache_fname )
                     age = int( time.time() - mtime )

vasl_templates/webapp/main.py

@@ -283,7 +283,7 @@ def get_program_info():
         params[ "DOCKER_IMAGE_NAME" ] = os.environ.get( "DOCKER_IMAGE_NAME" )
         params[ "DOCKER_IMAGE_TIMESTAMP" ] = datetime.strftime(
             parse_timestamp( os.environ.get( "DOCKER_IMAGE_TIMESTAMP" ) ),
-            "%H:%M %d %b %Y"
+            "%d %b %Y %H:%M"
         )
         params[ "DOCKER_CONTAINER_NAME" ] = os.environ.get( "DOCKER_CONTAINER_NAME" )
         with open( "/proc/self/cgroup", "r", encoding="utf-8" ) as fp:

vasl_templates/webapp/static/extras.js

@@ -115,7 +115,7 @@ function _show_extra_template( template_id )
                     buf.push( "<option>", param.options[j], "</option>" ) ;
                 buf.push( "</select>" ) ;
             } else if ( param.type === "player-droplist" ) {
-                buf.push( "<select name='_PLAYER_DROPLIST_' style='width:11.5em;'>" ) ;
+                buf.push( "<select class='param' name='PLAYER_DROPLIST' style='width:11.5em;'>" ) ;
                 add_player_nats( buf ) ;
                 buf.push( "</select>" ) ;
             } else if ( param.type === "player-color-droplist" ) {

vasl_templates/webapp/static/help/index.html

@@ -54,8 +54,8 @@ If you have Docker installed, the webapp can be run in a container e.g.
 <div class="code">
 ./run-container.sh \
     --port 5010 \
-    --vassal ~/vassal-3.6.7/ \
-    --vasl ~/vasl/vasl-6.6.5.vmod \
+    --vassal ~/vassal-3.6.14/ \
+    --vasl ~/vasl/vasl-6.6.6.vmod \
     --vasl-extensions ~/vasl/extensions/ \
     --boards ~/vasl/boards/ \
     --chapter-h ~/vasl/chapter-h/ \
@@ -73,7 +73,7 @@ If you have Docker installed, the webapp can be run in a container e.g.
 
 <p> You can also run the program directly from the source code. Get a copy from <a href="https://code.pacman-ghost.com/public/vasl-templates">here</a> in the usual way, by <tt>git clone</tt>'ing it, or downloading a ZIP and unpacking it somewhere.
 
-<p> The web server was written and tested using Python 3.10.4, but it doesn't do anything particularly funky, so any recent version of Python <em>should</em> work.
+<p> The web server was written and tested using Python 3.10.7, but it doesn't do anything particularly funky, so any recent version of Python <em>should</em> work.
 
 <p> While not essential, it is <em>strongly</em> recommended that you set up a <a href="https://virtualenv.pypa.io/en/stable/">virtual environment</a> first. Then <tt>cd</tt> into the project's root directory, and install the requirements (note the trailing period):
 <div class="code">
@@ -154,11 +154,11 @@ Configuring the program
 
 <p> Choose <em>Settings</em> from the <em>File</em> menu and configure the highlighted settings. As a guide, here are some example settings:
 <table class="settings">
-    <tr> <td class="key"> VASSAL&nbsp;installation: </td> <td class="val"> <nobr>C:\Program Files\VASSAL-3.6.7\</nobr>
-    <tr> <td class="key"> VASL&nbsp;module: </td> <td class="val"> <nobr>C:\bin\vasl\vasl-6.6.5.vmod</nobr>
+    <tr> <td class="key"> VASSAL&nbsp;installation: </td> <td class="val"> <nobr>C:\Program Files\VASSAL-3.6.14\</nobr>
+    <tr> <td class="key"> VASL&nbsp;module: </td> <td class="val"> <nobr>C:\bin\vasl\vasl-6.6.6.vmod</nobr>
     <tr> <td class="key"> VASL&nbsp;extensions: </td> <td class="val"> <nobr>C:\bin\vasl\extensions\</nobr>
     <tr> <td class="key"> VASL&nbsp;boards: </td> <td class="val"> <nobr>C:\bin\vasl\boards\</nobr>
-    <tr> <td class="key" valign="top"> Java: </td> <td class="val"> <nobr>C:\Program Files\VASSAL-3.6.7\jre\bin\java.exe</nobr>
+    <tr> <td class="key" valign="top"> Java: </td> <td class="val"> <nobr>C:\Program Files\VASSAL-3.6.14\jre\bin\java.exe</nobr>
         <div class="hint" style="margin:0.5em 1em;"> Leave this field blank to use the Java that comes with VASSAL (Windows only), or on your PATH. </div>
     <tr> <td class="key"> Web&nbsp;driver: </td> <td class="val"> <nobr>C:\bin\geckodriver.exe</nobr>
 </table>

vasl_templates/webapp/static/help/main.js

@@ -20,7 +20,7 @@ $(document).ready( function() {
         $( "a" ).each( function() {
             $(this).click( function(evt) {
                 var url = $(this).attr( "href" ) ;
-                if ( url[0] !== "#" && url.substring(0,16) !== "http://localhost" && url.substring(0,16) !== "http://127.0.0.1" && url.indexOf( "code.pacman-ghost.com" ) === -1 ) {
+                if ( url[0] !== "#" && url.substring(0,16) !== "http://localhost" && url.substring(0,16) !== "http://127.0.0.1" ) {
                     window.open( url ) ;
                     evt.preventDefault() ;
                     return false ;

vasl_templates/webapp/static/vassal.js

@@ -105,8 +105,8 @@ function _generate_snippets()
     // figure out which templates we don't want to auto-create labels for
     var no_autocreate = {} ;
     for ( var template_id in NATIONALITY_SPECIFIC_BUTTONS ) {
-        if ( ["pf","atmm","thh"].indexOf( template_id ) !== -1 || template_id.substring(0,3) === "pf-" ) {
-            // NOTE: PF, ATMM, THH are always available as an inherent part of a squad's capabilities
+        if ( ["pf","atmm"].indexOf( template_id ) !== -1 || template_id.substring(0,3) === "pf-" ) {
+            // NOTE: PF and ATMM are always available as an inherent part of a squad's capabilities
             // (subject to date restrictions), so we always auto-create these labels, unlike, say MOL or BAZ,
             // which are only present by SSR or OB counter).
             continue ;

vasl_templates/webapp/vasl_mod.py

@@ -16,8 +16,8 @@ from vasl_templates.webapp.config.constants import DATA_DIR
 from vasl_templates.webapp.vo import get_vo_listings
 from vasl_templates.webapp.utils import compare_version_strings
 
-SUPPORTED_VASL_MOD_VERSIONS = [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1", "6.6.4", "6.6.5" ]
-SUPPORTED_VASL_MOD_VERSIONS_DISPLAY = "6.6.0-.3, 6.6.3.1, 6.6.4-.5"
+SUPPORTED_VASL_MOD_VERSIONS = [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1", "6.6.4", "6.6.5", "6.6.6" ]
+SUPPORTED_VASL_MOD_VERSIONS_DISPLAY = "6.6.0-.6, 6.6.3.1"
 
 _zip_file_lock = threading.Lock()
 
@@ -25,6 +25,12 @@ _warnings = [] # nb: for the test suite
 
 # ---------------------------------------------------------------------
 
+class CantFindDataDirException( Exception ):
+    """Raised if the VASL data directory is missing."""
+    def __init__( self, vasl_version ):
+        super().__init__()
+        self.vasl_version = vasl_version
+
 def set_vasl_mod( vmod_fname, msg_store ):
     """Install a new global VaslMod object."""
     globvars.vasl_mod = None
@@ -36,6 +42,13 @@ def set_vasl_mod( vmod_fname, msg_store ):
         extns = _load_vasl_extns( extns_dir, msg_store )
         try:
             vasl_mod = VaslMod( vmod_fname, DATA_DIR, extns )
+        except CantFindDataDirException as ex:
+            msg = "Can't find the data directory for VASL {}." \
+                  " Are you running an older version of this program?".format( ex.vasl_version )
+            _logger.error( "%s", msg )
+            if msg_store:
+                msg_store.error( msg )
+            return
         except Exception as ex: #pylint: disable=broad-except
             msg = "Can't load the VASL module: {}".format( ex )
             _logger.error( "%s", msg )
@@ -265,11 +278,20 @@ class VaslMod:
             aliases = json.load( fp )
         self.vasl_version = aliases.get( self.vasl_real_version, self.vasl_real_version )
 
+        # locate the VASL data files
+        # NOTE: We do this explicitly because people were running older versions of vasl-templates, configured
+        # with a version of VASL that it didn't know about. An exception was thrown when we tried to open
+        # the data files below, which was caught and reported correctly, but the error message was a little opaque,
+        # so we check for this case explicitly, and try to show something a little more comprehensible :-/
+        dname = os.path.join( data_dir, "vasl-"+self.vasl_version )
+        if not os.path.isdir( dname ):
+            raise CantFindDataDirException( self.vasl_version )
+
         # load our overrides
-        fname = os.path.join( data_dir, "vasl-"+self.vasl_version, "vasl-overrides.json" )
+        fname = os.path.join( data_dir, dname, "vasl-overrides.json" )
         with open( fname, "r", encoding="utf-8" ) as fp:
             vasl_overrides = json.load( fp )
-        fname = os.path.join( data_dir, "vasl-"+self.vasl_version, "expected-multiple-images.json" )
+        fname = os.path.join( data_dir, dname, "expected-multiple-images.json" )
         with open( fname, "r", encoding="utf-8" ) as fp:
             expected_multiple_images = json.load( fp )
 
@@ -277,7 +299,7 @@ class VaslMod:
         target_gpids = get_vo_gpids( self )
 
         # parse the VASL module and any extensions
-        fname = os.path.join( data_dir, "vasl-"+self.vasl_version, "piece-info.json" )
+        fname = os.path.join( data_dir, dname, "piece-info.json" )
         with open( fname, "r", encoding="utf-8" ) as fp:
             piece_info = json.load( fp )
         for i,files in enumerate( self._files ):

vasl_templates/webapp/vassal.py

@@ -38,6 +38,7 @@ from vasl_templates.webapp.vasl_mod import get_reverse_remapped_gpid
 #   6.6.3 | 3.5.8   16+36
 #   6.6.4 | 3.6.6   17.0.2+8-LTS
 #   6.6.5 | 3.6.7   18.0.1
+#   6.6.6 | 3.6.14  19.0.2+7
 # NOTE: VASSAL+VASL back-compat has gone out the window :-/ We have to tie versions of VASL
 # to specific versions of VASSAL. Sigh...
 SUPPORTED_VASSAL_VERSIONS = {
@@ -45,10 +46,11 @@ SUPPORTED_VASSAL_VERSIONS = {
     "3.4.6": [ "6.6.0", "6.6.1" ],
     "3.5.5": [ "6.6.0", "6.6.1", "6.6.2" ],
     "3.5.8": [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1" ],
-    "3.6.6": [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1", "6.6.4", "6.6.5" ],
-    "3.6.7": [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1", "6.6.4", "6.6.5" ],
+    "3.6.6": [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1", "6.6.4", "6.6.5", "6.6.6" ],
+    "3.6.7": [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1", "6.6.4", "6.6.5", "6.6.6" ],
+    "3.6.14": [ "6.6.0", "6.6.1", "6.6.2", "6.6.3", "6.6.3.1", "6.6.4", "6.6.5", "6.6.6" ],
 }
-SUPPORTED_VASSAL_VERSIONS_DISPLAY = "3.4.2, 3.4.6, 3.5.5, 3.5.8, 3.6.6, 3.6.7"
+SUPPORTED_VASSAL_VERSIONS_DISPLAY = "3.4.2, 3.4.6, 3.5.5, 3.5.8, 3.6.6, 3.6.7, 3.6.14"
 
 # ---------------------------------------------------------------------