Free Hero Mesh

=== Documentation ===

Free Hero Mesh includes the following documentation files (plain text):

* ARCHITECTURE: Describes the source code of Free Hero Mesh. This is only
relevant if you wish to modify Free Hero Mesh, or if you want to look up
something in the code and want to know what file to look at.



* README: This file. Describes how to find the Fossil repository, the
installation, documentation, discussion/community.

* bindings.doc: Describes the configuration of key/mouse bindings.

* class.doc: This document describes the Free Hero Mesh programming

(Note: I have not tried the Matrix chat and I do not know if it works.)


=== License ===

Free Hero Mesh is public domain. See the LICENSE file for details.


=== Frequently asked questions ===

(If you have any more questions, please ask.)

** Is it any good?

 I suppose it is a matter of opinion, isn't it?

** It says "FATAL: Failed to open xclass file (No such file or directory)"
when trying to load the puzzle set. How to load it correctly?

 You must use the base name. For example, if the puzzle set files are
 named "sokoban.xclass", "sokoban.class", "sokoban.level", and
 "sokoban.solution", then you must type "heromesh sokoban" to load it.
 (This assumes that the file is in the current directory. If it isn't,
 then you must also specify the directory name, in addition to the puzzle
 set base name.)

 You may also use a composite puzzle set. In this case, use the -z switch
 and pass the name including the file name suffix.

** How to access the NNTP?

 You can use a NNTP client program, often called a "newsreader" program.
 Many email programs can also do NNTP, including Mozilla Thunderbird.
 There are also specialized NNTP programs, including Pan and bystand.
 (Some are text, some are binary, and some are hybrid; you will need one
 that supports text or hybrid.)

** Is there documentation with tutorial or introduction?

 I like the kind of documentation that the existing one is, although I
 am aware that some people prefer a different style. Someone who is better
 at writing that different style should do so and contribute please.

** Are any libre puzzle sets currently available?

 Not yet (as of this writing). However, anyone can contribute them; I
 would be interested to see what you can come up with! (I am also working
 on my own puzzle sets, too.)

** Hero Hearts puzzles will cause errors when a Bomb or Missile explodes,
and won't display Roller animations correctly.

 The first problem is a bug in Hero Hearts (which occasionally causes a
 GPF in the Windows version, but not always, due to race conditions). This
 can be corrected by changing the line that says "From =%objFrom" in the
 #EXPLO_ANIM message block of the $Fire class to "From $Grenade is if
 From else 0 then =%objFrom".

 The second problem is not a bug, but a bad design in Hero Hearts, which
 Free Hero Mesh does not emulate. (This problem is purely visual, though.)
 To fix it, add "(Synchronize 0 4 8)" at the beginning of the file, and
 then add ":onoff %off if STOP Image 0 0 Animate else 0 Image Synchronize
 then" to the end of the INIT message block of the $Roller class and then
 add "=:onoff" at the end of the #ENABLE, #DISABLE, and #TOGGLE blocks.

** Some levels of the SANDY1 puzzle set fail with a "Type mismatch" error
before any moves are made.

 This is the fault of the author(s) of those levels. The $SwitchFloor
 class expects Misc1 to be a number, but somehow the level author put a
 class name there instead.

** Level 11 of the CHESSMAZ puzzle set fails with a "Type mismatch" error
before any moves are made.

 It attempts to perform arithmetic on object references to generate random
 numbers. The generation of random numbers is not allowed (as it would
 break the replay feature).

** The provided solutions of some of the Falling Hero levels with Closer
Seekers do not work.

 I have no idea what's wrong, but I can confirm that this is true.

 (If anyone can figure out what is wrong, please tell me.)

** There is a segmentation fault.

 This is a bug in Free Hero Mesh; segmentation faults should never occur.
 Please report it so that it can be fixed. Ensure that your bug report
 includes all information needed for reproducing the bug, including the
 compiler options you used. (If you can fix it yourself, do so and then
 post the patch so that I can review it. You will still need to report
 the bug; a patch does not substitute for a bug report.)

** Can the inventory and move list be displayed at the same time?

 This feature is planned, but has not been implemented yet. (If you can
 help by providing a patch or ideas about it, that might help.)

** Is there a table of contents of the levels?

 This feature is planned, but has not been implemented yet. (If you can
 help by providing a patch or ideas about it, that might help.)

** Why is there both Busy and UserSignal flags even though both flags do
the same thing?

 It is because Everett Kaser designed the MESH engine that way, but I
 don't know why it was designed that way. If you do not like to have
 both flags, then you do not have to use both.

** What is the MIME type and UTI for Free Hero Mesh?

 None is officially assigned, but unofficially, a composite puzzle set
 can use the following MIME type:

 application/freeheromesh.composite+hamarc

 Optional parameters for this MIME type are "codepage" which is a IBM
 code page number, and "version" which is the version of Free Hero Mesh
 (same as the numbers of the {version} macro). Both are optional.

 MIME types for the other file formats are not defined.

 The UTI for a Free Hero Mesh composite puzzle set file is:

 org.zzo38computer.freeheromesh.composite

 This UTI conforms to the following other UTIs:

 com.hamsterrepublic.lumped
 public.data

** If would be very helpful if you could put more information and in
particular screenshots on the Fossil main page, or at the very least link
to screenshots, or create a non-Fossil webpage to show the project. They
say a picture is worth a thousand words, but in this case I think no
number of words will ever substitute for an image.

 You are probably correct. Once suitable screenshots are available, I can
 do this, and also add other information if needed.

** It didn't compile using the script, and/or there are compiler warnings,
and/or some changes were required.

 If the warnings and other issues with compilation are posted on the NNTP,
 then it can be properly discussed, and then a better compilation code can
 be written. Proper packaging for different distributions can also be
 discussed. Please provide the following information:

 - What compiler you used (including the version)

 - What operating system you are using (including the version, and the
 distribution of Linux, if you are using any)

 - What version of SQLite and SDL you are using

 - What changes you made to the program code, if any

 - What warnings you got, if any

 - Whether or not the program worked after doing these things

 One issue is that the version of SQLite in the system package manager
 might (depending on the system) not be updated as often as it should be.
 There is no guarantee that newer versions of Free Hero Mesh will not use
 features of newer versions of SQLite (or depend on bug fixes), although
 it also might not. (However, I think it is unlikely that newer versions
 of SQLite will break it.)

** Apparently in the original you can right click on objects to read
descriptions?

 In Free Hero Mesh, this function is mapped to the middle instead of
 right button by default, but the mapping can be redefined. (By default
 in Free Hero Mesh, the right button accesses the inspection menu,
 allowing inspecting the variables of objects at that location.)

** What's the X resource manager code for? Clipboard access?

 The user configuration settings are in X resource manager format.

 Free Hero Mesh doesn't depend on the X window system; the X resource
 manager is actually not a part of the X window system, just it is
 commonly used with it. Xlib includes a part of the X resource manager,
 but Free Hero Mesh does not use Xlib (and even if it did, Xlib lacks
 an equivalent of the xrm_init_quarks function).

 Clipboard access is done using external programs; if the X window
 system is used, then this will usually be "xclip". This is configured
 in the user configuration file, so if you are not using the X window
 system then you can change it to the appropriate commands for whatever
 you are using on your computer.

** It cannot find sqlite3.o when compiling. Why not use -lsqlite3 instead?

 The version of SQLite in the package manager is not always the newest
 version. Sometimes I use features that are in released versions of SQLite
 but not necessarily in the package manager (and which versions are in the
 package manager may vary according to the distribution). The version in
 the package manager might or might not work; it is untested.

** How to make it to automatically advance to next level if you win?

 Add the following into the .heromeshrc file:
   .?.autoWin: select 'go',-(level()+1) where level()<max_level();

** Trying to run Free Hero Mesh with gdb results in a "No such file or
directory" error, and it won't work.

 If you have not set up Free Hero Mesh for portable mode, then you must
 pass the -h switch to Free Hero Mesh to work with gdb.