We'll set up The Streets Of Stalingrad, and the scenario card tells us that this is played on Board 1, so fire up VASL, add this board, then save the scenario somewhere (e.g. streets-of-stalingrad.vsav).
+
We'll set up The Streets Of Stalingrad, and the scenario card tells us that this is played on Board 1, so fire up VASL, add this board, then save the scenario somewhere (e.g. streets-of-stalingrad.vsav).
+
-In vasl-templates, open the save file for this scenario (The Streets Of Stalingrad (Scenario C).json; you'll find it in the examples/ directory).
-
Browse through the tabs, and you'll see all the scenario details e.g. Victory Conditions, SSR's, setup instructions. The program also shows the latest results from ROAR. +In VASL Templates, open the save file for this scenario (The Streets Of Stalingrad (Scenario C).json; you'll find it in the examples/ directory). +
Browse through the tabs, and you'll see all the scenario details e.g. Victory Conditions, SSR's, setup instructions. +
Click on the info icon in the top-right corner of the Scenario panel to get more detailed information about the scenario. +
We now want to create labels in the VASL scenario for all this information. Choose Update VASL scenario from the menu, and select the VASL scenario file you created earlier (e.g. streets-of-stalingrad.vsav). The program will now launch VASSAL to do the work, so be patient since it may take a minute or two, and you may see VASSAL momentarily appear on-screen.
@@ -167,12 +173,12 @@ In particular, note the data tables for the vehicles, which contain useful infor
-We can pretty-up the labels by including pictures in them. Open the User Settings dialog and turn on Images in scenarios.
+We can pretty-up the labels by including pictures in them. Open the User Settings dialog and turn on the Images in scenarios settings.
Update the VASL scenario again (as above), open it again in VASSAL, and you will see that the labels now include nationality flags, and the vehicle data tables show the counter images:
-
-First, we enter the basic details about the scenario.
-
Click on one of the Snippet buttons, and the program will generate an HTML snippet and put it into your clipboard, which you can then copy into a VASL label. -
You can also click on the Search ROAR button, to look for a scenario in ROAR. The basic details for the scenario will be loaded, along with the latest results. +
+We start by entering the basic scenario details, such as its name, location and date. The easiest way to do this is to search the ASL Scenario Archive.
+
Click on the search button, enter the name of the scenario, and once you've found the correct one, click on Import to transfer the details into VASL Templates. +
If the Downloads button is enabled, this means that somebody has contributed the entire scenario setup and/or VASL save file, and these are available for download. +
-To create a label in VASL, open the Draggable Overlays window, and drag a label onto the main window.
+Once the scenario details are in, click on one of the Snippet buttons, and the program will generate an HTML snippet and put it into your clipboard, which you can then copy into a VASL label.
+
To create a label in VASL, open the Draggable Overlays window, and drag a label onto the main window.
Labels come in two parts, which are accessible via the right-click menu, or press Ctrl-L and Ctrl-2 to access each one. I always just use the first line, so I delete everything in line 2.
The thick black box indicates that the label is selected. If you click elsewhere on the main window, it goes away, and the label will remain in place even if you click on it, or try to drag it. To select it again, Shift-click somewhere in the box, and you will be able to move it around, or edit it. This can sometimes be difficult to find, since it's not visible on-screen, but it will be in the middle (vertically and horizontally) of the label.
@@ -207,6 +215,8 @@ To create a label in VASL, open the Draggable Overlays window, and drag
Once you have a label in VASL, copy the HTML snippet generated above into it.
Repeat the process to add the ELR and SAN for both players, and you will now have two labels that you can position in the VASL scenario.
+
+
Once you've got the hang of adding labels to your VASL scenario, you can get VASL Templates to do it automatically for you. After entering all the scenario details, choose Update VASL scenario from the menu, select the .vsav file you want to update, and all the labels will be inserted into the scenario (or updated, if they're already there).
If you have already set up the VASL scenario, you can choose "Analyze VASL scenario" from the menu, and the program will scan the .vsav file for vehicles and ordnance, and automatically create entries for each one. Only counters from the two configured nationalities will be imported, so make sure you set these first. +
If you have already set up the VASL scenario, you can choose Analyze VASL scenario from the menu, and the program will scan the .vsav file for vehicles and ordnance, and automatically create entries for each one. Only counters from the two configured nationalities will be imported, so make sure you set these first.
-
+When the scenario has been completed and checked, you can contribute it back to the community by uploading it to the ASL Scenario Archive, where it will be made available to everyone for download.
+
Just add your VASL scenario file (.vsav), a screenshot will be automatically generated (or you can add your own), then click Upload. +
+As an added bonus, VASL Templates can also analyze VASL log files, to generate a report on how the game went. Choose Analyze log files from the menu, and add one or more VASL log files.
+
You will be shown a report showing distribution graphs for the dice, and how the dice went over time. You can filter by the type of dice roll (e.g. only Morale Checks or To Kill rolls), as well as change the window size for moving averages. You can even download the data as a CSV, for further analysis! +
If there is more than one log file, you can also drill down into each individual session:
+
+
+The report also calculates "hotness", which is a measure of how hot your dice were. The more low rolls you make, the higher your hotness score, while rolling high makes it go down.
+
So if you lose, you now have some hard numbers to back you up when you blame the dice 
+
+
+
-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): -
Configure your VASL user name here, to have it always shown first when analyzing VASL log files. + +
This setting lets you change the font, and its size, used in VASL labels. + +
Turn this on to automatically create labels that list the national capabilities for both sides when updating a VASL scenario. + +
Turn this on to completely omit vehicle/ordnance multi-applicable notes that haven't been set up (instead of showing them as "unavailable"). + +
Turn this on to show the User Settings dialog before updating a VASL scenario. This is useful if you are often creating VASL setups with different settings, and gives you a chance to make sure they are correct.
+
+
+
+
Images cannot be stored in a VASL scenario file, so they must stored elsewhere, which means that VASL needs to be told where to get them from: +
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.
If you have set up the Chapter H vehicle/ordnance notes as HTML, it may not be possible to get the layout you want, since VASSAL's HTML engine is very old and doesn't support many HTML/CSS features. To work around this, this option tells VASL Templates to render the HTML itself (using a modern browser) and send it as an image to VASSAL, which is slower but gives better results.
Note that since pylint is run as part of these tests, this should be done from the root directory of the repo. -
The program uses VASSAL to update VASL scenarios (.vsav files), and since this is written in Java, a helper program has been written in Java to do this. diff --git a/vasl_templates/webapp/static/help/main.css b/vasl_templates/webapp/static/help/main.css index 94d5713..37cf122 100644 --- a/vasl_templates/webapp/static/help/main.css +++ b/vasl_templates/webapp/static/help/main.css @@ -54,3 +54,8 @@ div.warning { background: url(images/warning.gif) 2px 2px no-repeat ; font-size: 80% ; font-style: italic ; } + +ul { list-style-image: url("images/bullet.png") ; } +ul ul { list-style-image: url("images/bullet2.png") ; } +ul ul ul { list-style-image: url("images/bullet3.png") ; } +li .note { font-size: 80% ; font-style: italic ; } diff --git a/vasl_templates/webapp/templates/user-settings-dialog.html b/vasl_templates/webapp/templates/user-settings-dialog.html index 7d8c775..c046f05 100644 --- a/vasl_templates/webapp/templates/user-settings-dialog.html +++ b/vasl_templates/webapp/templates/user-settings-dialog.html @@ -1,7 +1,7 @@