view release on metacpan or  search on metacpan

lib/Game/TextMapper.pm  view on Meta::CPAN

C<https://campaignwiki.org/wiki/NameOfYourWiki/X>. You can also use
C<%s> in the URL and then this placeholder will be replaced with the
(URL encoded) label.

=head2 License

This program is copyright (C) 2007-2024 Alex Schroeder <alex@gnu.org>.

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License along
with this program. If not, see L<http://www.gnu.org/licenses/>.

The maps produced by the program are obviously copyrighted by I<you>,
the author. If you're using SVG icons, these I<may> have a separate
license.

=over

=item * If you produce a map using the I<Gazetteer> icons by Thorfinn Tait, the
map is automatically licensed under the Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy
of this license, visit L<https://creativecommons.org/licenses/by-nc-sa/4.0/>.

=item * If you produce a map using the I<Gnomeyland> icons by Gregory B.
MacKenzie, the map is automatically licensed under the Creative Commons
Attribution-ShareAlike 3.0 Unported License. To view a copy of this license,
visit L<https://creativecommons.org/licenses/by-sa/3.0/>.

=back

You can add arbitrary SVG using the B<license> keyword (without a
tile). This is what the Gnomeyland library does, for example.

    grass attributes fill="#90ee90"
    0101 grass
    license <text>Public Domain</text>

There can only be I<one> license keyword. If you use multiple
libraries or want to add your own name, you will have to write your
own.

There's a 50 pixel margin around the map, here's how you might
conceivably use it for your own map that uses the I<Gnomeyland> icons
by Gregory B. MacKenzie:

    grass attributes fill="#90ee90"
    0101 grass
    0201 grass
    0301 grass
    0401 grass
    0501 grass
    license <text x="50" y="-33" font-size="15pt" fill="#999999">Copyright Alex Schroeder 2013. <a style="fill:#8888ff" xlink:href="http://www.busygamemaster.com/art02.html">Gnomeyland Map Icons</a> Copyright Gregory B. MacKenzie 2012.</text><text x=...

Unfortunately, it all has to go on a single line.

The viewport for the map is determined by the hexes of the map. You need to take
this into account when putting a license onto the map. Thus, if your map does
not include the hex 0101, you can't use coordinates for the license text around
the origin at (0,0) – you'll have to move it around.

=head2 Algorithms

Text Mapper implements a number of different algorithms.

=head3 Smale

The default algorithm was developed by Erin D. Smale. See L<Hex-based Campaign
Design (Part 1)|http://www.welshpiper.com/hex-based-campaign-design-part-1/> and
L<Hex-based Campaign Design (Part
2)|http://www.welshpiper.com/hex-based-campaign-design-part-2/> for more
information.

The output uses the I<Gnomeyland> icons by Gregory B. MacKenzie. These are
licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.
To view a copy of this license, visit
L<http://creativecommons.org/licenses/by-sa/3.0/>. If you use these maps in your
works, you must take this into account.

See L<Game::TextMapper::Smale> for more information.

=head3 Alpine

The Alpine algorithm was developed by Alex Schroeder. See L<Alpine map generator
1|https://alexschroeder.ch/wiki/2016-08-06_Alpine_Map_Generator> and L<Alpine
map generator 2|https://alexschroeder.ch/wiki/2016-08-16_Alpine_Map_Generator>
for more information.

The output also uses the I<Gnomeyland> icons by Gregory B. MacKenzie. These are
licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.
To view a copy of this license, visit
L<http://creativecommons.org/licenses/by-sa/3.0/>. If you use these maps in your
works, you must take this into account.

See L<Game::TextMapper::Schroeder::Alpine> for more information.

=head3 Apocalypse

The Apocalypse algorithm was developed by Alex Schroeder. See L<Hex describing the
post-apocalypse|https://alexschroeder.ch/wiki/2020-10-02_Hex_describing_the_post-apocalypse>
for more information.

The output uses the I<Apocalypse> library. This library is dedicated to the
public domain.

See L<Game::TextMapper::Schroeder::Alpine> for more information.

=head3 Gridmapper

The Gridmapper algorithm was developed by Alex Schroeder and is based on
geomorph sketches by Robin Green. See L<The Nine Forms of the Five Room
Dungeon|https://gnomestew.com/the-nine-forms-of-the-five-room-dungeon/> by
Matthew J. Neagley for more information.