diff --git a/README.md b/README.md index f89b6ae..1b4c2ef 100644 --- a/README.md +++ b/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.
--border-width
Width of the border between hexes. Defaults to 1.
--border-colour
Colour of the border between hexes. Defaults to black.
-
--show-coords
-
+
--show-coords
Include coordinates in the image. If included in the html document, a checkbox to toggle their visibility is added.
@@ -63,3 +62,11 @@ Output options. See above.
--outfile
--regiondir
+Miscellanious +
+
--embed-images
+ 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. +
+