MapChecker program (Current version V1.8)

[grommit]

I have written a Java program to check entire map trees for problems. This has a different purpose to map validation in the Editor, since in the Editor you can only check one map at a time, and it won't tell you about connection problems between maps etc.

You can run the program either by double-clicking the jar file, which brings up a dialog where you can browse for directories, or for pontikiphobes (ποντικι - mouse, φοβια - phobia), you can run it from the command line

In the dialog, in the top window, just browse to the maps folder in your working copy to check all the maps from top level downwards. To just check a subset (like demon_plane, or your own unofficial map set), browse down to that directory.

Then browse in the second window to select the directory and file name for the log file. Then just click the Check Maps button and it will check all those maps and output warnings and errors to the log file.

To exclude warnings of missing floors, check the appropriate box.

If you prefer to use the command line, it's

Code: [Select]

$ java -jar MapChecker.jar map-directory [logfile-directory]
If you omit the logfile-directory, all the output will go to the command window.

Whichever way you run it, the program checks the following (E = error, W = warning):

• Map tiles (each direction):
(E) Referenced map does not exist
(E) Referenced map does not connect back to this one
(E) Referenced map connects to a different map

• Exits:
(E) Referenced map does not exist
(W) Reference is absolute

• Events:
(E) Script file does not exist
(W) Script path is absolute (does not apply to /scripts or /scripts_private)

• Waypoints:
(E) Referenced map does not exist
(W) Reference is absolute (may be intentional, though)

• For each square on each map:
(W) Object(s) on square, but no floor
(E) More than one floor
(W) Empty spawn point
(W) Mob/NPC not in spawn point
(W) More than one object on same layer at map level (ignores layers 0 and 1)

You can download V1.7 from here.

Future versions may check more things as I think of them, or people suggest them. Please reply with comments, suggestions and bugs.

NOTE: You can't check SVN directories (like daiserv and mapserv) directly as the program needs to find the archetypes file - it must be a properly set up working area, such as you run your local server on.

[smacky]

Nice job Grommit.

But why does it ignore layer 1 for more than one object on same layer?

Smacky the pontikiphobe

[grommit]

Because layer 1 is floors and it has already checked the floor count (0 is warning, >1 is error).

Which brings me to bug #1 I just found: it doesn't see shop floor (type 68) as a valid floor type.

Thought you'd like the neologism  Have you run it from the command line on Linux yet? I'd like to know if it worked as advertised.

Grommit the pontikiphile.

[smacky]

Hm, I'm having difficulty:

Code: [Select]


julian@louie:~/daimonin/local$ java -jar MapChecker.jar maps/
Usage: java -jar mapchecker.jar top_level_directory log_file_path
julian@louie:~/daimonin/local$ java -jar MapChecker.jar maps/planes/
Usage: java -jar mapchecker.jar top_level_directory log_file_path
julian@louie:~/daimonin/local$ java -jar MapChecker.jar maps/ log
Map path must contain 'maps' directory
julian@louie:~/daimonin/local$ java -jar MapChecker.jar ./ log
Map path must contain 'maps' directory
julian@louie:~/daimonin/local$ java -jar MapChecker.jar . log
Map path must contain 'maps' directory
log does not exist. I wanted to run it to stdout. Can I? Will it mkdir log if it does not exist?

Gridarta had the not seeing shop floors as proper floors error until recently too. I think Gridarta determines floors by type though. What about shop mats (69)?

[tehill]

If you look at the beginning of the server log you shall see that the server reports an error with the shop floors, and has been reporting that error for months.

[grommit]

Hmm - shop mats are like exits and should be on a floor anyway.

Re the command line interface - I think the trailing / is confusing it. Are you running the jar file in your top level working directory (i.e. the one containing the maps directory)?

Try a cd to that directory.
It won't mkdir the log directory. (atm)

[smacky]

@Tehill: a warning. But IIUC Grommit's map checker identifies anything on layer 1 as a floor. Shop floors are layer 1. That warning is that they are also sys_objects.

Perhaps the server/client (not sure which) could be changed to treat shop floors as normal floors (ie, not show them in the below window)? Then there would be no need for them being sys_object.

[grommit]

As far as I understand the layer system, 0 is invisible system objects, 1 is floors, 2 is floor masks, then anything above is something on top. (Yes I know there is more detail in the definition, like 7 is flying objects but I am not really concerned with anything above).

Oh, and my program uses the type to determine a floor, not the level. That's why it missed shop floors. It's debatable which it should use.

[smacky]

It works with ./maps. maps/ or ./maps/ causes the above failure. Also, the logfile has nasty ^M characters in it.

[grommit]

V1.1 fixes 2 bugs:

#1: Not recognising shop floor as a floor. Now checks layer = 1 for a floor (instead of type).
#2: If an exit or waypoint references a map outside the sub-tree being checked, it reported that the map does not exist, even though it does.

Re ctrl/M in log file: this is a carriage return. Windows line ends are '\r\n', Unix line ends are '\n'. I will see how to determine the operating system and set line ends accordingly.

Re trailing '/' on file spec.: I will check for this and strip it off.

[grommit]

As of today, we are now up to V1.4. It is now a zip file as it requires another jar file in its lib folder for a wizzy directory tree thingy.

Download http://www.enborne.f2s.com/_daimonin/MapChecker.zip and unzip the whole thing into an empty folder.

[grommit]

MapChecker has been updated. The latest version is V1.6, dowloaded from the same link as in the previous post.

The short-lived V1.5 adds checks for the integrity of archetypes and artifacts files and also checks each map for references to missing archetypes/artifacts.

V1.6 was a quick addition on top of V1.5, to ignore .svn directories, so you can now run MapChecker directly on SVN repositories without exporting.

If you do this, you will need to take some of the reports with a pinch of salt, since you'll probably get errors saying a script file is missing and so on - which would not happen with a properly-exported working copy. However it does provide a quick check of map validity in situ.

[ThePlaneskeeper]

i'll have to try this after the new year.  I'm always appreciative of things that tell me i screwed up =)

[grommit]

Updated today to V1.7

Bug fixed: not adding missing object errors to total error count.

[grommit]

I have re-organised the SVN distribution by putting the sources in a src directory and adding the pre-built jar file with its required library.

Copy the jar file together with its lib directory and then run the jar file.