diff --git a/chapter-h/README.md b/chapter-h/README.md index edc6fbb..cb9f7bd 100644 --- a/chapter-h/README.md +++ b/chapter-h/README.md @@ -1,5 +1,5 @@ # Chapter H Vehicle/Ordnance notes -*VASL Templates* supports including Chapter H notes in your VASL scenarios, but since this is copyrighted material, it is not included in releases, and you will need to set up the data yourself. +It is possible to include Chapter H notes in your VASL scenarios, but since this is copyrighted material, it is not included in releases, and you will need to set up the data yourself. The ZIP file in this directory contains placeholder files for the Chapter H notes, refer to the [documentation](https://rawgit.com/pacman-ghost/vasl-templates/master/vasl_templates/webapp/static/help/index.html?tab=chapterh) for instructions on how to set things up. diff --git a/vasl_templates/webapp/static/help/images/hill-621.png b/vasl_templates/webapp/static/help/images/hill-621.png index 02fdb70..904ea77 100644 Binary files a/vasl_templates/webapp/static/help/images/hill-621.png and b/vasl_templates/webapp/static/help/images/hill-621.png differ diff --git a/vasl_templates/webapp/static/help/images/hill-621.small.png b/vasl_templates/webapp/static/help/images/hill-621.small.png index 3110d4c..d70fc45 100644 Binary files a/vasl_templates/webapp/static/help/images/hill-621.small.png and b/vasl_templates/webapp/static/help/images/hill-621.small.png differ diff --git a/vasl_templates/webapp/static/help/images/user-file.png b/vasl_templates/webapp/static/help/images/user-file.png new file mode 100644 index 0000000..4fdc414 Binary files /dev/null and b/vasl_templates/webapp/static/help/images/user-file.png differ diff --git a/vasl_templates/webapp/static/help/images/user-file.small.png b/vasl_templates/webapp/static/help/images/user-file.small.png new file mode 100644 index 0000000..86c5bad Binary files /dev/null and b/vasl_templates/webapp/static/help/images/user-file.small.png differ diff --git a/vasl_templates/webapp/static/help/index.html b/vasl_templates/webapp/static/help/index.html index 8823975..eb4559c 100644 --- a/vasl_templates/webapp/static/help/index.html +++ b/vasl_templates/webapp/static/help/index.html @@ -73,10 +73,37 @@ python vasl_templates/webapp/run_server.py and then connect to it in a browser at http://localhost:5010. +
If you have Docker installed, the webapp can be run in a container: +
Then open a browser and connect to the webapp at http://localhost:5010. +
Note that some features (e.g. updating a VASL scenario file) may not be available. +
Some features require a webdriver to be installed. You can use either: +
Unpack the download ZIP file somewhere (it will contain a single executable file), and configure the location in the Server Settings dialog (or set WEBDRIVER_PATH in site.cfg, if you are running from source). +
The desktop application uses OpenGL for the embedded browser, so if you are getting error messages about OpenGL, or the main window is not displaying properly, you can try configuring OpenGL to work in a different way. -
Create a file called debug.cfg in $/lib/vasl_templates/webapp/config/ (the same directory that contains a file called app.cfg) that looks like this: +
Create a file called debug.cfg in $/config/ (the same directory that contains a file called app.cfg) that looks like this:
The scenario date is taken into account when generating these tables e.g. APCR for the Pz IVH is A52, but since the program knows the scenario is set in 1944, it just shows A5. Had the scenario been set in 1941, it wouldn't be shown at all.
Double-click on an entry to make changes to it e.g. because an SSR changes its capabilities, or you'd like to add a note. + +
@@ -160,6 +189,27 @@ Finally, if special support weapons such as PF and BAZ are in play, snippets are
Extra templates are also available to generate ad-hoc snippets e.g. to keep track of how many PF shots you have left, or to generate a shaded box that can be inserted behind the Turn Track to indicate an LV Hindrance. +
+You can also include your own images in scenarios e.g. the picture from the scenario card, or CG reinforcement tables. + +
In the Server Settings dialog, configure the directory where you keep your files, then in a template, use {{USER_FILES}} at the start of an image URL e.g. +
If you want VASL counter images to appear in the UI, you need to tell the program where to find the VASL module (i.e. the vasl-X.X.X.vmod file you load into VASSAL):
Once you've configured the VASL module, if you want to also show VASL counter images in the OB snippets that you copy in the VASL scenario, turn this on in the User settings dialog from the main application menu.
VASL Templates supports including Chapter H notes in your VASL scenarios, but since this is copyrighted material, the data files are not included in releases, and you will need to set them up yourself. +
It is possible to include Chapter H notes in your VASL scenarios, but since this is copyrighted material, the data files are not included in releases, and you will need to set them up yourself.
Unpack this ZIP file somewhere, and configure the location in the Server Settings dialog (or the CHAPTER_H_NOTES_DIR setting in site.cfg, if you are running from source). -
The ZIP file contains placeholder files for the Chapter H notes and multi-applicable notes, so all you have to do is replace these files with the real content. +
The ZIP file contains placeholder files for the Chapter H vehicle/ordnance notes and multi-applicable notes, so all you have to do is update these files with the real content. -
Multi-applicable notes are stored as HTML, so, for example, for German Multi-Applicable Vehicle Note A, change the file german/vehicles/a.html as follows: +
Multi-applicable notes are stored as HTML, so for example, for German Multi-Applicable Vehicle Note A, change the file german/vehicles/a.html as follows:
The vehicle and ordnance notes themselves are stored as image files, so you need to scan your Chapter H pages, and crop each individual note. For example, an image for the German PSW 234/1 can be seen to the left. Right-click on it, download it, and save it on top of german/vehicles/74.png (because it's note #74).
@@ -207,11 +257,13 @@ Finally, if special support weapons such as PF and BAZ are in play, snippets are
Each individual vehicle and ordnance can also now have its own snippet button. Click on the one for the PSW 234/1, transfer the snippet to your VASL scenario, and you will see the image for Note 74 you set up earlier.
-
If you shift-click on the Snippet buttons, an image of the snippet will be copied to the clipboard, instead of the raw HTML snippet. You can then copy these into Microsoft Word (or any other editor that can accept images), and print it out, to get a reference sheet with all the Chapter H notes for a scenario. Very handy, even if you're not using VASL! +
If you Shift-click on the Snippet buttons, an image of the snippet will be copied to the clipboard, instead of the raw HTML snippet. You can then copy these into Microsoft Word (or any other editor that can accept images), and print it out, to get a reference sheet with all the Chapter H notes for a scenario. Very handy, even if you're not using VASL! +
The HTML snippets are generated from template files, which are simply text files that contain the HTML you want to insert into the VASL labels, but with placeholders for the scenario name, victory conditions, each player's OB, etc. The user enters these details into the program, and when they want to generate a snippet, all the placeholders are replaced in the template with the real values, thus producing an HTML snippet specific to that scenario. -
The template files can be found in $/lib/vasl_templates/webapp/data/default-template-pack/ (where $ is where you've installed the program). +
The template files can be found in $/data/default-template-pack/ (where $ is where you've installed the program).
Note that since pylint is run as part of these tests, this should be done from the root directory of the repo. -
NOTE: Internet Explorer is also supported as a WebDriver, but due to differences in the way it works, some tests are currently failing for this. +
Then run the container:
Note that if you have SElinux enabled, it may prevent the container from accessing the VASL .vmod file, in which case, you can allow access like this: