diff --git a/vasl_templates/webapp/static/help/images/asl-rulebook2.png b/vasl_templates/webapp/static/help/images/asl-rulebook2.png new file mode 100644 index 0000000..3ffd77c Binary files /dev/null and b/vasl_templates/webapp/static/help/images/asl-rulebook2.png differ diff --git a/vasl_templates/webapp/static/help/images/asl-rulebook2.small.png b/vasl_templates/webapp/static/help/images/asl-rulebook2.small.png new file mode 100644 index 0000000..b3fa504 Binary files /dev/null and b/vasl_templates/webapp/static/help/images/asl-rulebook2.small.png differ diff --git a/vasl_templates/webapp/static/help/index.html b/vasl_templates/webapp/static/help/index.html index 07807a0..439d0de 100644 --- a/vasl_templates/webapp/static/help/index.html +++ b/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.
./run-container.sh \ --port 5010 \ - --vassal ~/vassal-3.6.14/ \ - --vasl ~/vasl/vasl-6.6.6.vmod \ + --vassal ~/vassal-3.7.5/ \ + --vasl ~/vasl/vasl-6.6.7.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.

You can also run the program directly from the source code. Get a copy from here in the usual way, by git clone'ing it, or downloading a ZIP and unpacking it somewhere. -

The web server was written and tested using Python 3.10.10, but it doesn't do anything particularly funky, so any recent version of Python should work. +

The web server was written and tested using Python 3.11.4, but it doesn't do anything particularly funky, so any recent version of Python should work.

While not essential, it is strongly recommended that you set up a virtual environment first. Then cd into the project's root directory, and install the requirements (note the trailing period):

@@ -101,6 +101,18 @@ pip install --editable .[gui]

Then, run the vasl-templates command. + +

Integrating with asl-rulebook2

+ +

+If you are using asl-rulebook2, you can connect it to this program, and vehicle/ordnance entries will show an icon that you can click to open their Chapter H entries. + +

In your site.cfg, configure the base URL of the asl-rulebook2 application e.g. +

+[Site Config] +ASL_RULEBOOK2_BASE_URL = http://localhost:5020 +
+

Installing a webdriver

@@ -154,11 +166,11 @@ Configuring the program

Choose Settings from the File menu and configure the highlighted settings. As a guide, here are some example settings: -
VASSAL installation: C:\Program Files\VASSAL-3.6.14\ -
VASL module: C:\bin\vasl\vasl-6.6.6.vmod +
VASSAL installation: C:\Program Files\VASSAL-3.7.5\ +
VASL module: C:\bin\vasl\vasl-6.6.7.vmod
VASL extensions: C:\bin\vasl\extensions\
VASL boards: C:\bin\vasl\boards\ -
Java: C:\Program Files\VASSAL-3.6.14\jre\bin\java.exe +
Java: C:\Program Files\VASSAL-3.7.5\jre\bin\java.exe
Leave this field blank to use the Java that comes with VASSAL (Windows only), or on your PATH.
Web driver: C:\bin\geckodriver.exe
@@ -548,6 +560,13 @@ When you're writing a new template file, it would be painful to have to ZIP up a

Setting up

+
+If you want to run the GUI, you will also need to install the GUI requirements: +
+pip install --editable .[gui] +
+
+

After cloning the repo, install the developer requirements:

pip install --editable .[dev]