main v1.0
parent a6f22d3b25
commit a68f9c7785
  1. 13
      README.md

@ -15,7 +15,7 @@ The script has 2 flags controlling files generated:
Examples of the four combinations:
1. `perl wiki-map.pl -o output/Map.svg --no-html --regiondir output --api https://vipersgate.obscuritus.ca/api.php`
1. `perl wiki-map.pl -o output/Map.svg --no-html --api https://vipersgate.obscuritus.ca/api.php`
Creates a main map as an SVG output/Map.svg
2. `perl wiki-map.pl -o output/Map.svg --no-html --regiondir output --api https://vipersgate.obscuritus.ca/api.php`
Creates a main map as an SVG output/Map.svg and an SVG for each region and location, also in the output dir
@ -51,8 +51,7 @@ These are not settable in the script but can be added if desired.
<dl>
<dt>--border-width</dt><dd>Width of the border between hexes. Defaults to 1.</dd>
<dt>--border-colour</dt><dd>Colour of the border between hexes. Defaults to black.</dd>
<dt>--show-coords</dt>
<dd>
<dt>--show-coords</dt><dd>
Include coordinates in the image.
If included in the html document, a checkbox to toggle their visibility is added.
</dd>
@ -63,3 +62,11 @@ Output options. See above.
<dt>--outfile</dt><dd></dd>
<dt>--regiondir</dt><dd></dd>
</dl>
Miscellanious
<dl>
<dt>--embed-images</dt><dd>
Whether or not to embed referenced images directly in the document(s),
by fetching them from the wiki and base64 encoding them.
Defaults to true.
</dd>
</dl>

Loading…
Cancel
Save