Mudsbuilder - gereacreator help
This document is designed to be a brief help for those who seek it:)
Configuration:
as usual run
./configure --prefix=/dir/to/installto/
make
su (optional)
make install
Once installation is complete and upon the first run of the program
config files will be copied into .mudsbuilder/ directory in your home dir.
Those files are:
gereacreator.conf
merentha.mlt
gereacreator.conf
Contains configuration for gereacreator. All entries are of type
VARIABLE=VALUE, i.e MUDLIB_TEMPLATE=merentha.mlt
Modifications will take place upon next run of program.
merentha.mlt
Contains mudlib template (in my case merentha mudlib template).
This template is used to generate code for mudlib your mud is using.
To learn more about this please read below in Templates section
Creating area
In order to start creating area you first have to select starting point.
This is done by clicking anywhere on the grid. After that you are able to click
anywhere else on grid or use controls on the top/right of the form.
Once you have completed your dungeon, you probably want to generate actual lpc code
now:).
Pressing "Generate Area" button will ask you few options, including (IMPORTANT!) which
ROOM TEMPLATE to use. By default it is set to merentha.mlt
Templates
Room Template (aka mudlib template) is used to generate rooms from your map.
gereacreator will search template for special variables, and replace them with an appropriate code.
All variables start with % sign. Currently there are not that many variables, but should be enough
to generate most simple area for most of mudlibs
Variables:
%exits: is replaced with string that has following format:
"name of the exit" : ROOM_PREFIX "AREA_NAME ROOM_NUMBER FILE_EXT",
"another exit" : ... and so on
for example:
"south" : MYROOMS "havart_forest1.c",
"up" : MYROOMS "havart_forest5.c",
etc...
Since in merentha mudlib in order to set exits one has to call
set_exits(([
"south" : MYROOM "havart_forest4.c",
blah blah
]));
i simply create merentha.mlt template and put in there
set_exits(([
%exits
]));
This way all appropriate exits will be filled in (based on map you draw).
List of all variables
%exits: replaces it with all exits in mapping format (see above)
%oexits: same as %exits , but doesnt include misc exits
%mexits: same as %exits, includes only misc exits
%sexits: coma separated list of all exit names
i.e south, north, west, down, my house, enter
%smexits: coma separated list of misc exit names
%soexits: coma separated list of all non-misc exit names
%room_id: id of room as shown on map created
Editing source
gereacreator allows you to edit rooms source before its been generated
In order to do that you must save you area first, then select room you want to edit, and press "Edit Room" button
Once you saved your room, rooms color should change from default one
In order to save changes you area you need
to save it again.
NOTICE: edited rooms obey a bit different rules than all others. For instance if edited room gains or looses
exit it wont reflect in rooms code. You can however press Edit Room and Re-generate, but it will erase changes you
made to it
Once you generate code, edited rooms will be created in the codition you left them at
If you have questions/comments/bug reports/feature requests either mail me (frostedcmos [at] yahoo [dot] com)
or go to mudsbuilder.sourceforge.net and leave your message in one of forums
[Last udpated August 11, 2003]