Updated the documentation.

master v1.12
Pacman Ghost 4 months ago
parent 2b4bc9045a
commit 24106fb7e5
  1. BIN
      vasl_templates/webapp/static/help/images/asl-rulebook2.png
  2. BIN
      vasl_templates/webapp/static/help/images/asl-rulebook2.small.png
  3. 31
      vasl_templates/webapp/static/help/index.html

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

@ -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.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.
<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.10, 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.11.4, 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">
@ -101,6 +101,18 @@ pip install --editable .[gui]
<p> Then, run the <tt>vasl-templates</tt> command.
<a name="asl-rulebook2"></a>
<h2> Integrating with <tt>asl-rulebook2</tt></h2>
<p> <img src="images/asl-rulebook2.png" class="preview" style="float:right;">
If you are using <a href="https://code.pacman-ghost.com/public/asl-rulebook2"><tt>asl-rulebook2</tt></a>, 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.
<p> In your <tt>site.cfg</tt>, configure the base URL of the <tt>asl-rulebook2</tt> application e.g.
<div class="code">
[Site Config]
ASL_RULEBOOK2_BASE_URL = http://localhost:5020
</div>
<a name="install-webdriver"></a>
<h2>Installing a webdriver</h2>
@ -154,11 +166,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.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"> VASSAL&nbsp;installation: </td> <td class="val"> <nobr>C:\Program Files\VASSAL-3.7.5\</nobr>
<tr> <td class="key"> VASL&nbsp;module: </td> <td class="val"> <nobr>C:\bin\vasl\vasl-6.6.7.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.14\jre\bin\java.exe</nobr>
<tr> <td class="key" valign="top"> Java: </td> <td class="val"> <nobr>C:\Program Files\VASSAL-3.7.5\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>
@ -548,6 +560,13 @@ When you're writing a new template file, it would be painful to have to ZIP up a
<a name="dev-setup"></a>
<h2 style="margin-top:0;"> Setting up </h2>
<div class="info" style="float:right;max-width:40%;margin-left:1em;">
If you want to run the GUI, you will also need to install the GUI requirements:
<div class="code">
pip install --editable .[gui]
</div>
</div>
<p> After cloning the repo, install the <em>developer</em> requirements:
<div class="code">
pip install --editable .[dev]

Loading…
Cancel
Save