Daniel Asher Resnick 8c2d5fc6c2 Layer-based rendering		5 months ago
HexGrid	Layer-based rendering	5 months ago
svg	Add Paths	1 year ago
tests	Add starts_from and ends_to path functionality	12 months ago
.gitignore	initial commit	2 years ago
HexGrid.pm	Layer-based rendering	5 months ago
MWTemplate.pm	Fix bug with MWTemplate::Parse	12 months ago
README.md	README: click-togglable pop-ups are enabled	6 months ago
coord_tripler.pl	.	6 months ago
grid-tester.pl	Coord tripler and grid tester	6 months ago
test-regions	Coord tripler and grid tester	6 months ago
wiki-map.pl	Get site image pages all together	12 months ago

README.md

Generate a map from specifications on a wiki

Prereqs

The Hexgrid modules and MWTemplate modules must be in @INC

Invoking

Writes to STDOUT by default; use -o/--outfile <file> to write to a <file> instead

The script has 2 flags controlling files generated:

--regiondir <dir>: If specified, also generate maps for each region and location, writing them to files in <dir>. Off by default.
--html/--no-html: Whether to generate (an) SVG file(s) or (an) html file(s), including logic for popups on clicks (currently half done). Makes html by default.

Examples of the four combinations:

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
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
perl wiki-map.pl -o output/Map.html --api https://vipersgate.obscuritus.ca/api.php Creates a main map with popups as output/Map.html
perl wiki-map.pl -o output/Map.html --regiondir output --api https://vipersgate.obscuritus.ca/api.php Creates a main map with popups as output/Map.html and an html page for each region and location, also in the output dir

1 is intented to make just a map for the main page. Unnecessary if using 2.

2 is intended to make a map for the main page, and for each Region, Subregion and Location page.

3 is intended to be linked to and has click-toggleable popups.

4 is an artifact of the above 3 and doesn't have intended use.

Options

Options can be abbreviated per Getopt::Long

--api-url:: Base URL of the wiki. Required.

Template names. Defaults to MapRegion, MapSubregion, MapLocation, MapSite.

--region-template-name
--subregion-template-name
--location-template-name
--site-template-name

Formatting options. The tiling module supports more overrides including per region/tile granularity. 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: Include coordinates in the image. If included in the html document, a checkbox to toggle their visibility is added.

Output options. See above.

--html-document
--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.