Mercurial > hg > batmud > maputils

annotate README @ 2833:d0e186348cb2 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add mention of soft level limitation to 'Eightleg woods'.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 26 May 2024 20:33:53 +0300
parents b05a75d273bd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
b9c6775d0889 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 MapUtils
b9c6775d0889 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 ========
83
95bfef502aae Added some legalese
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
3 Miscellaneous utilities for processing ASCII map data from
95bfef502aae Added some legalese
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
4 BatMUD in various interesting ways.
95bfef502aae Added some legalese
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
5
2368
ba0ff73a1013 Adjust by/copyright lines.
Matti Hamalainen <ccr@tnsp.org>
parents: 2367
diff changeset
6 Programmed and designed by Matti Hämäläinen (aka Ggr Pupunen @ BatMUD)
2573
397f8c487cf2 Bump copyright years.
Matti Hamalainen <ccr@tnsp.org>
parents: 2515
diff changeset
7 (C) Copyright 2006-2024 Tecnic Software productions (TNSP)
1
b9c6775d0889 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8
2075
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
9 Licensed under GNU General Public License version 2 or later,
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
10 see file "COPYING" for more information. Applies to this package
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
11 except for the parts listed below:
1939
e525c390da03 Add copyright/license information for the included font.
Matti Hamalainen <ccr@tnsp.org>
parents: 1924
diff changeset
12
2075
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
13 - th-utils library
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
14 Programmed and designed by Matti 'ccr' Hämäläinen <ccr@tnsp.org>
2573
397f8c487cf2 Bump copyright years.
Matti Hamalainen <ccr@tnsp.org>
parents: 2515
diff changeset
15 (C) Copyright 2002-2024 Tecnic Software productions (TNSP)
2075
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
16 Licensed under 3-clause BSD style license, see th-libs/COPYING
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
17
2070
8d41b9055858 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2030
diff changeset
18 - The raw ASCII map data in *.map files originate directly
8d41b9055858 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2030
diff changeset
19 or indirectly from BatMUD(tm) <http://www.bat.org/> and are
2573
397f8c487cf2 Bump copyright years.
Matti Hamalainen <ccr@tnsp.org>
parents: 2515
diff changeset
20 (C) Copyright 2002-2024 Balanced Alternative Techniques Ry.
83
95bfef502aae Added some legalese
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
21
2070
8d41b9055858 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2030
diff changeset
22 Those files are distributed here under the belief that since
8d41b9055858 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2030
diff changeset
23 the data is publicly available, it can be freely distributed
8d41b9055858 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2030
diff changeset
24 under "fair-use" paradigm when used non-commercially.
83
95bfef502aae Added some legalese
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
25
2512
d51a44e3b7ae Reorder copyright information.
Matti Hamalainen <ccr@tnsp.org>
parents: 2511
diff changeset
26 - world/MonospaceBold.ttf TrueType font
d51a44e3b7ae Reorder copyright information.
Matti Hamalainen <ccr@tnsp.org>
parents: 2511
diff changeset
27 Copyright (C) 1990-2001 George Williams. See the license
d51a44e3b7ae Reorder copyright information.
Matti Hamalainen <ccr@tnsp.org>
parents: 2511
diff changeset
28 information in file world/MonospaceBold.copyright
d51a44e3b7ae Reorder copyright information.
Matti Hamalainen <ccr@tnsp.org>
parents: 2511
diff changeset
29
2511
9973f78f8291 Add svn2cl.xsl and note the copyright in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2508
diff changeset
30 - world/svn2cl.xsl
9973f78f8291 Add svn2cl.xsl and note the copyright in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2508
diff changeset
31 Copyright (C) 2004, 2005 Arthur de Jong. See the license
9973f78f8291 Add svn2cl.xsl and note the copyright in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2508
diff changeset
32 information in file world/svn2cl.xsl
9973f78f8291 Add svn2cl.xsl and note the copyright in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2508
diff changeset
33
84
7e1339136222 Added thanks to Ooga
Matti Hamalainen <ccr@tnsp.org>
parents: 83
diff changeset
34
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
35 Requirements
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
36 ============
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
37 The compilation and usage of these utilities requires following
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
38 software packages or functional equivalents installed:
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
39
2659
b05a75d273bd Update build instructions a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2573
diff changeset
40 - GCC or Clang or possibly other C11 compatible compiler
2444
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
41 - GNU wget or curl
2075
c065c2c2b86e Make some more clarifications to licensing and few others adjustments to
Matti Hamalainen <ccr@tnsp.org>
parents: 2070
diff changeset
42 - ImageMagick (GraphicsMagick might not work)
675
783b93434676 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 658
diff changeset
43 - GNU diff, patch, make and sed
2444
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
44 - GNU bash
2389
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
45 - TNSP "th-libs" C utility code library, usually you need the latest
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
46 one for the latest maputils, available as Mercurial repository at
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
47 https://tnsp.org/hg/th-libs/
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
48
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
49 Optional:
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
50
2508
4ffa5c4181aa Add note about GIMP in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2489
diff changeset
51 - GIMP 2.x or newer for best quality worldmap PNG color reduction.
2659
b05a75d273bd Update build instructions a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2573
diff changeset
52 Without GIMP the worldmap PNG files will be 32-bit RGBA (and
b05a75d273bd Update build instructions a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2573
diff changeset
53 rather large, for that matter.)
2508
4ffa5c4181aa Add note about GIMP in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2489
diff changeset
54
2464
e0bd4cb0903a Add xsltproc to optional dependencies.
Matti Hamalainen <ccr@tnsp.org>
parents: 2445
diff changeset
55 - xsltproc for generating changelog.txt
e0bd4cb0903a Add xsltproc to optional dependencies.
Matti Hamalainen <ccr@tnsp.org>
parents: 2445
diff changeset
56
2445
0a79ef6f1467 Add mention of old/mapref.pl
Matti Hamalainen <ccr@tnsp.org>
parents: 2444
diff changeset
57 - Perl 5.10 or later for regenerating old/hcbat.loc via old/mapref.pl
2444
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
58
2515
d4f5f1000acb Improve some notes about deps.
Matti Hamalainen <ccr@tnsp.org>
parents: 2512
diff changeset
59 - libpng 1.6 and development headers for PNG output support
2389
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
60 in map2ppm.
9a95ee5f48ae Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2368
diff changeset
61
2291
e048668abaed Update notes about tested libwebsockets versions.
Matti Hamalainen <ccr@tnsp.org>
parents: 2267
diff changeset
62 - libwebsockets, libuv and perhaps some other depencies
e048668abaed Update notes about tested libwebsockets versions.
Matti Hamalainen <ccr@tnsp.org>
parents: 2267
diff changeset
63 if you want the "mapsearch" server. Only following versions
2310
d820fe9268da Slightly update README for requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2309
diff changeset
64 of libwebsockets have been tested: 2.0.3, 2.2.0, 3.2.1 and
d820fe9268da Slightly update README for requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2309
diff changeset
65 4.0.20 .. I can't guarantee compatibility with all versions.
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
66
2444
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
67 - PHP 7.x or 8.x for src/genbcxml.php in order to generate
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
68 Batclient markers.xml
1666
cb92f01c5dcb Update README regarding th-libs dependency and where to get it from.
Matti Hamalainen <ccr@tnsp.org>
parents: 1650
diff changeset
69
2444
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
70 - Stuff under www/ requires PHP 7.x or 8.x, but it's not really
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
71 even meant for public consumption, this repository just works as
c2a52df64cca Update the list of dependencies / requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 2443
diff changeset
72 a storage medium for it.
568
6d2fd9fbdc4d Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 566
diff changeset
73
1217
f5f04be91b0e Add Perl 5.10 to the requirements list.
Matti Hamalainen <ccr@tnsp.org>
parents: 1216
diff changeset
74
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
75 Usage
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
76 =====
1371
7a08f3d53d1a Add newlines.
Matti Hamalainen <ccr@tnsp.org>
parents: 1359
diff changeset
77
568
6d2fd9fbdc4d Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 566
diff changeset
78 1) Verify that your system fulfills the requirements stated above.
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
79
1666
cb92f01c5dcb Update README regarding th-libs dependency and where to get it from.
Matti Hamalainen <ccr@tnsp.org>
parents: 1650
diff changeset
80 2) In maputils root directory, clone th-libs under it:
cb92f01c5dcb Update README regarding th-libs dependency and where to get it from.
Matti Hamalainen <ccr@tnsp.org>
parents: 1650
diff changeset
81
2489
390c4f5fecbd Update README slightly.
Matti Hamalainen <ccr@tnsp.org>
parents: 2476
diff changeset
82 $ hg clone https://tnsp.org/hg/th-libs/
1666
cb92f01c5dcb Update README regarding th-libs dependency and where to get it from.
Matti Hamalainen <ccr@tnsp.org>
parents: 1650
diff changeset
83
2659
b05a75d273bd Update build instructions a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 2573
diff changeset
84 2) Edit 'Makefile' and/or 'config.mak' in top directory, if needed.
568
6d2fd9fbdc4d Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 566
diff changeset
85
6d2fd9fbdc4d Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 566
diff changeset
86 3) In the main directory, type 'make' or 'gmake' to compile.
1460
950e141621eb Language.
Matti Hamalainen <ccr@tnsp.org>
parents: 1405
diff changeset
87 If compilation succeeds, you can move to step 4.
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
88
491
17c8caee4140 Added note about what not to do.
Matti Hamalainen <ccr@tnsp.org>
parents: 490
diff changeset
89 If compilation fails, you are on your own. If you don't know what
17c8caee4140 Added note about what not to do.
Matti Hamalainen <ccr@tnsp.org>
parents: 490
diff changeset
90 the problem is, then please DON'T ask me (Ggr). I am not interested.
17c8caee4140 Added note about what not to do.
Matti Hamalainen <ccr@tnsp.org>
parents: 490
diff changeset
91
2489
390c4f5fecbd Update README slightly.
Matti Hamalainen <ccr@tnsp.org>
parents: 2476
diff changeset
92 4) To build the HTML/PNG/etc worldmaps:
390c4f5fecbd Update README slightly.
Matti Hamalainen <ccr@tnsp.org>
parents: 2476
diff changeset
93
390c4f5fecbd Update README slightly.
Matti Hamalainen <ccr@tnsp.org>
parents: 2476
diff changeset
94 $ cd world/ && make
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
95
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
96
1216
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
97 Map updating and building procedure
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
98 ===================================
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
99
1626
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
100 1) In world/ directory, to fetch new raw ASCII map data
1216
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
101
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
102 $ make fetch
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
103
1359
b639f6566f7c Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 1217
diff changeset
104 2) In order to automatically find any changes in raw ASCII maps,
b639f6566f7c Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 1217
diff changeset
105 and update the location files with templates of new locations.
b639f6566f7c Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 1217
diff changeset
106 Also updates the ASCII map data in the repository with terrain
1216
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
107 changes. New pcities and markers are only stored in loc files.
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
108
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
109 $ make diff
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
110
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
111 3) If there were new locations, manually edit changed loc files
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
112 with relevant information. This part requires running around
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
113 in BatMUD to retrieve names for the new places (pcities, areas).
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
114
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
115 4) Make a test build of maps, to see if the new markers look okay:
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
116
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
117 $ make maps
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
118
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
119 5) Check maps visually, adjust loc files (location marker label
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
120 alignment etc.) if necessary.
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
121
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
122 6) Repeat 4-5 until satisfied.
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
123
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
124 7) Commit changes to repository (hg ci, hg push)
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
125
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
126 8) At this point I use GIMP (http://www.gimp.org/) to compress
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
127 the PNG format map images better, by converting them to Indexed
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
128 color, using 64 colors max. GIMP's quantization algo is the
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
129 best I've seen, and unfortunately ImageMagick, pngcrush etc.
1359
b639f6566f7c Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 1217
diff changeset
130 don't come even close, making this part require manual work.
1216
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
131
1613
0ca0fe178d31 Slightly update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 1612
diff changeset
132 $ make gimp
0ca0fe178d31 Slightly update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 1612
diff changeset
133
1216
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
134 9) Upload files to server:
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
135
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
136 $ make upload
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
137
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
138 The city maps and hcbat maps have somewhat similar procedures, except
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
139 they do not require the GIMP step as no PNG maps are generated.
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
140
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
141
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
142 NOTICE! For changing HCBat map locations, you do NOT edit hcbat.loc,
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
143 but hcbat.ref instead! It is a loc file, but with special syntax for
1626
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
144 referencing the new world loc files under world/. Location name
1216
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
145 prefixed with @ ("at" character) will expand to the matching location
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
146 information in the new maps loc files.
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
147
918592dd357d Add in the general procedure of how to update maps using these tools.
Matti Hamalainen <ccr@tnsp.org>
parents: 1198
diff changeset
148
83
95bfef502aae Added some legalese
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
149 Included utilities
95bfef502aae Added some legalese
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
150 ==================
9
3e7eb65281f4 Shitzor
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
151
839
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
152 * mkloc
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
153 Perhaps the most important tool in this package, a multi-purpose
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
154 utility for converting, manipulating and updating location files.
1
b9c6775d0889 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
155
839
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
156 Can also combine an ASCII map with location data to produce output
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
157 with location information (which can be further converted to different
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
158 formats via 'colormap').
41
7d91562486b4 Updates
Matti Hamalainen <ccr@tnsp.org>
parents: 24
diff changeset
159
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
160 * colormap
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
161 Transforms given input BatMUD ASCII maps (also some sub-area maps)
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
162 into various formats, including coloured XHTML+CSS, HTML and ANSI
551
b8d778e0d3c7 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 533
diff changeset
163 text.
9
3e7eb65281f4 Shitzor
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
164
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
165 * diffmap
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
166 Computes a 'diff' between two ASCII maps of equivalent size. Output
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
167 is a specially formatted binary file, which can be converted to
551
b8d778e0d3c7 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 533
diff changeset
168 bitmap images via 'map2ppm', or used as patches for 'patchmap'.
9
3e7eb65281f4 Shitzor
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
169
551
b8d778e0d3c7 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 533
diff changeset
170 * patchmap
b8d778e0d3c7 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 533
diff changeset
171 Patches a given ASCII map with a patch produced by diffmap.
9
3e7eb65281f4 Shitzor
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
172
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
173 * map2ppm
1067
2c43290e0de8 Updated copyrights, added some notes.
Matti Hamalainen <ccr@tnsp.org>
parents: 1020
diff changeset
174 Similar to 'colormap', converts ASCII map to a PPM or PNG format
2c43290e0de8 Updated copyrights, added some notes.
Matti Hamalainen <ccr@tnsp.org>
parents: 1020
diff changeset
175 image file, which can be then further converted/manipulated with
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
176 ImageMagick or netpbm utils, or other image processing software.
1067
2c43290e0de8 Updated copyrights, added some notes.
Matti Hamalainen <ccr@tnsp.org>
parents: 1020
diff changeset
177 Is able to upscale the image by integer values if wanted.
551
b8d778e0d3c7 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 533
diff changeset
178 Can also use output of 'diffmap' to create images with differences
b8d778e0d3c7 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 533
diff changeset
179 highlighted.
301
bee9674c9faf Updated, added descriptions for few utilities.
Matti Hamalainen <ccr@tnsp.org>
parents: 265
diff changeset
180
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
181 * combine
839
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
182 Combines several ASCII maps into a bigger one, based on coordinate
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
183 offsets.
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
184
2088
a0eb0ccd6458 Rename mkspecial -> stitchmap.
Matti Hamalainen <ccr@tnsp.org>
parents: 2075
diff changeset
185 * stitchmap
839
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
186 Given an input with "map pieces" (generated with help of TF scripts)
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
187 and sufficient parameters for interpreting, this utility stitches
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
188 together a bigger ASCII map from the pieces.
24
cab9ffa3962e Documented old/
Matti Hamalainen <ccr@tnsp.org>
parents: 16
diff changeset
189
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
190 * mapstats
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
191 Generate simple statistics about different "terrain" types used
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
192 in a given ASCII map.
301
bee9674c9faf Updated, added descriptions for few utilities.
Matti Hamalainen <ccr@tnsp.org>
parents: 265
diff changeset
193
1198
2e4449813a85 Update documentation, replace mkbcmap with mkcitymap.
Matti Hamalainen <ccr@tnsp.org>
parents: 1130
diff changeset
194 * mkcitymap
1085
8e59e5ed695c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1067
diff changeset
195 Specialized utility for generating HTML format maps from city maps.
8e59e5ed695c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1067
diff changeset
196
1924
3a81ab3ba6f8 Add few bits of information about mapsearch.
Matti Hamalainen <ccr@tnsp.org>
parents: 1903
diff changeset
197 * mapsearch
3a81ab3ba6f8 Add few bits of information about mapsearch.
Matti Hamalainen <ccr@tnsp.org>
parents: 1903
diff changeset
198 A map search server that uses WebSockets to communicate with Javascript-
3a81ab3ba6f8 Add few bits of information about mapsearch.
Matti Hamalainen <ccr@tnsp.org>
parents: 1903
diff changeset
199 based front-end (see www/search.js and www/search.php). Can be used to
2097
2a0dd44ccbdd Add tiny note about scripts/ in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2088
diff changeset
200 search the maps and locations. See also scripts/ directory for some
2a0dd44ccbdd Add tiny note about scripts/ in README.
Matti Hamalainen <ccr@tnsp.org>
parents: 2088
diff changeset
201 related SysV init scripts etc.
1924
3a81ab3ba6f8 Add few bits of information about mapsearch.
Matti Hamalainen <ccr@tnsp.org>
parents: 1903
diff changeset
202
1
b9c6775d0889 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
203
301
bee9674c9faf Updated, added descriptions for few utilities.
Matti Hamalainen <ccr@tnsp.org>
parents: 265
diff changeset
204 Miscellaneous information
bee9674c9faf Updated, added descriptions for few utilities.
Matti Hamalainen <ccr@tnsp.org>
parents: 265
diff changeset
205 =========================
1371
7a08f3d53d1a Add newlines.
Matti Hamalainen <ccr@tnsp.org>
parents: 1359
diff changeset
206
1626
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
207 world/ map data for continents and associated Makefiles for generating
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
208 the output maps.
839
cc2e6e293ceb Updated documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 787
diff changeset
209
1626
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
210 misc/ map data for various city and area type locations, e.g.
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
211 Arelium, Lorenchia, etc.
301
bee9674c9faf Updated, added descriptions for few utilities.
Matti Hamalainen <ccr@tnsp.org>
parents: 265
diff changeset
212
1626
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
213 old/ contains maps and data from the Old BatWorld, before the Age of
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
214 Exiles and new continents. Also the HardCore BatMUD map / location
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
215 data can be found here.
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
216
1626
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
217 tf/ few utility scripts for mapping for TinyFugue MUD client.
490
67a94c55a97c Updates.
Matti Hamalainen <ccr@tnsp.org>
parents: 407
diff changeset
218
2267
0f770344051a Few minor touchups in the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 2236
diff changeset
219 www/ PHP-glue and data files used for https://tnsp.org/maps/ site.
1626
cee38bf8e9d5 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 1613
diff changeset
220