From 8269917beee7e852af430cdf5b2ee15b0a207768 Mon Sep 17 00:00:00 2001 From: Pacman Ghost Date: Wed, 29 Mar 2023 22:35:20 +0700 Subject: [PATCH] Updated the documentation --- README.md | 1 + requirements.txt | 2 +- vasl_templates/webapp/config/site.cfg.example | 2 +- vasl_templates/webapp/static/help/index.html | 12 ++++++------ 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7d673ac..5b15c93 100644 --- a/README.md +++ b/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) diff --git a/requirements.txt b/requirements.txt index 2ca2c6c..c7fd75e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# python 3.10.4 +# python 3.10.7 flask==2.1.2 pyyaml==6.0 diff --git a/vasl_templates/webapp/config/site.cfg.example b/vasl_templates/webapp/config/site.cfg.example index 67f4e6f..2116263 100644 --- a/vasl_templates/webapp/config/site.cfg.example +++ b/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... diff --git a/vasl_templates/webapp/static/help/index.html b/vasl_templates/webapp/static/help/index.html index eefcdda..efc0845 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.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.

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.4, 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.10.7, 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):

@@ -154,11 +154,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.7\ -
VASL module: C:\bin\vasl\vasl-6.6.5.vmod +
VASSAL installation: C:\Program Files\VASSAL-3.6.14\ +
VASL module: C:\bin\vasl\vasl-6.6.6.vmod
VASL extensions: C:\bin\vasl\extensions\
VASL boards: C:\bin\vasl\boards\ -
Java: C:\Program Files\VASSAL-3.6.7\jre\bin\java.exe +
Java: C:\Program Files\VASSAL-3.6.14\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