D 2018-10-21T00:22:28.558
L .heromeshrc
P 255978149e07333462598b58b4ad3713e57efa61
U zzo38
W 8022
This document describes the current plan (part of which is implemented), and may be altered if it changes.
The <tt>.heromeshrc</tt> file is a file in [https://tronche.com/gui/x/xlib/resource-manager/file-syntax.html|X resource manager] format, except that <tt>#include</tt> isn't (currently) implemented. It should be placed in your home directory. If the environment variable <tt>HOME</tt> is not set, the current directory is used. (Note: The X server is not queried for resources, nor are any other files queried; this resource database is entirely local to Free Hero Mesh.)
The first component if all resource settings is the puzzle set name, ignoring any directory path components (omit the first component when specifying a setting as a command-line argument). If the puzzle set includes a <tt>.name</tt> file, its contents are used as the puzzle set name for this purpose.
Some options are boolean. In this case, a true value is anything that starts with "t", "T", "y", "Y", or "1", while a false value is anything that starts with "f", "F", "n", "N", or "0". If neither is the case, the default setting is used.
<h2>altImage</h2>
A nonnegative integer (default zero). If more than one picture is available of the selected picture size, this is used to determine which one to load.
For example, it can be used to select which player character you want (e.g. male or female or monsters or whatever); however, other uses are possible (the puzzle set should hopefully include documentation to explain its meaning).
<h2>class</h2>
Define overrides for classes. The next component is the class name (without the initial <tt>$</tt>), and the next component after that is the option to set. So far the only option is:
* <tt>quiz</tt>: If true, hides the MiscVars of objects of this class from the player. The default setting is defined by the puzzle set.
<h2>editClick</h2>
Define mouse bindings for the level editor (only applies to clicks on the playfield). See [keybindings].
<h2>editKey</h2>
Define key bindings for the level editor. See [keybindings].
<h2>editTitle</h2>
Window title to display for editor. If it contains a tilde, the first tilde is replaced by the file base name.
Window titles are only displayed if supported by the window manager.
<h2>gameClick</h2>
Define mouse bindings for the game (only applies to clicks on the playfield). See [keybindings].
<h2>gameKey</h2>
Define key bindings for the game. See [keybindings].
<h2>gameTitle</h2>
Window title to display for game. If it contains a tilde, the first tilde is replaced by the file base name.
Window titles are only displayed if supported by the window manager.
<h2>gamma</h2>
If set, all colours in the palette are modified by raising them to the given exponent (which is a positive number given in decimal notation, which does not need to be an integer).
Numbers greater than 1.0 darken the colours while numbers less than 1.0 will lighten the colours.
<h2>imageSize</h2>
Specify picture size. This should be one to thirty-two integers in the range from 1 to 255. The pictures are always square. It tries to use the picture sizes with the first number given first priority. It will terminate with the puzzle set does not contain any pictures of the specified sizes and the pictures cannot be integer scaled to meet the given sizes either.
Sometimes a puzzle set may contain multiple pictures of the same size in a picture set. In this case, use the <tt>altImage</tt> setting to select which one you want.
<h2>margin</h2>
How much space (in pixels) is available to the left of the playfield, to display the move list, inventory, editor MRU, status, etc.
<h2>maxObjects</h2>
Maximum number of objects that can be created. The default and maximum value is 4294901760. Puzzles with more than this many objects will not work; you will automatically lose if the game attempts to create more objects than that. (If there is a solution that does not require creating that many objects all existing at the same time, then you can still win.)
<h2>palette</h2>
If set, the name of a file to use as the palette instead of using the built-in palette. The file consists of 256 colours, separated by white space, where each colour is given as six hex digits (two each for red, green, and blue).
<h2>screenFlags</h2>
A list of zero or more of the following characters:
* <tt>-</tt> - A placeholder that does nothing and can be used if you do not want any of these flags. This is the default setting if you do not specify any other flags.
* <tt>d</tt> - Enable double buffering.
* <tt>f</tt> - Run in full screen mode.
* <tt>h</tt> - Use video memory.
* <tt>n</tt> - Tell the window manager not to draw window decorations.
* <tt>p</tt> - Use exclusive palette access.
* <tt>r</tt> - Tell the window manager to allow resizing the window.
* <tt>y</tt> - Enable asynchronous updates of the display surface.
<h2>screenHeight</h2>
The height of the main window (a decimal number). Default is 800 pixels.
<h2>screenWidth</h2>
The width of the main window (a decimal number). Default is 600 pixels.
<h2>sqlCoveringIndexScan</h2>
Boolean; set true to enable covering index scans in SQLite. It is true by default.
<h2>sqlExtensions</h2>
A list of SQLite extensions, with spaces in between. They are loaded in the order given.
<h2>sqlFile</h2>
The file to use to store the user cache database. If this is set to <tt>:memory:</tt> then it is created in RAM and will not persist. The default setting is to use the file named <tt>.heromeshsession</tt> in your home directory.
<h2>sqlInit</h2>
Any number of [http://sqlite.org/lang.html|SQL statements], which will be executed during initialization. If there are any result rows, the result rows are ignored.
Use this if you need any temporary tables/views/triggers, to set database connection options with pragmas, to configure any extensions that may have been loaded, to attach any additional databases you may be using, etc.
(Note: Recursive triggers are automatically enabled and you need not add commands to enable it in this resource setting.)
<h2>sqlMemStatus</h2>
Boolean; set true to collect memory statistics for SQLite. (Not all memory allocation in Free Hero Mesh uses SQLite, however.) Currently this does not do anything in Free Hero Mesh itself, although an extension might use it.
<h2>sqlSmallAllocations</h2>
Boolean; if true, SQLite tries to avoid large memory allocations. False by default.
<h2>stackProtection</h2>
Control stack overflow protection. If omitted or if a C compiler that does not support GNU extensions is used, then no stack protection is implemented. Otherwise, it may be one of the following:
* <tt>?</tt> sets stack protection test mode. This mode collects statistics of the lowest, highest, and initial frame addresses, and will display the data when the program ends.
* <tt><</tt> and then a number will cause an error message if the frame address is less than the initial frame address plus the specified number of bytes.
* <tt>></tt> and then a number will cause an error message if the frame address is greater than the initial frame address plus the specified number of bytes.
Note: The stack overflow protection is only implemented for functions that may call themself recursively (either directly or indirectly). Also, some operating systems may try to implement stack protection automatically, but it has been found to not always work; this resource makes Free Hero Mesh to use its own implementation of stack protection (in addition to that of the operating system, if any).
<h2>tracePrefix</h2>
If message tracing is enabled, then many events within the game (including a Trace instruction) will write a line to stdout with the details of the event; this setting defines a prefix to add to each line of trace events.
You may then use external programs to filter the output by this prefix.
Z af74bb718af73a47fb2c897530813207