This document describes how the loading, storing, and editing of clans, guilds, and orders work on the SmaugWizard mud server, starting with version 1.03.

There are a set of commands which operate on the clans, guilds, and orders.  The commands work mostly the same way no matter which type file you are working with, so in the following paragraphs, the clan commands will be discussed, and any differences will be explained.  But remember that you need to use the guild version of the command to work on guilds, and the order version of the command to work on orders.  The commands are:

MAKECLAN, MAKEGUILD, MAKEORDER
SETCLAN,  SETGUILD,  SETORDER
SHOWCHAN, SHOWGUILD, SHOWORDER

To create a clan use makeclan <clan name>.  'clan name' may be more than one word.  This will create a clan with the extension ".clan".  Makeguild will create a guild with extension ".guild", and makeorder will create an order with extension ".order".  The filename will also be added to the clan.lst file.

To change the filename of a loaded clan, use setclan <clan name> <filename>.  (Note: If you change the name of a clan, guild, or order file, the file is copied to the new name.  The old file will still be in the clans directory.)

If you have existing clan files which you wish to add to your mud, just put the files in the clans directory, and add their file names to the clan.lst file.  Be sure that the type field in the files being added manually is set right.  It should be zero for clans, 13 for orders, and 14 for guilds.  Also, if there are vault files, the filename must be the same as the clan file name plus the additional extension ".vault".  So, for example, if the Guild of Mages file is named "mages.guild", the storeroom file will be "mages.guild.vault".

The setclan commands are documented in the mud help file, and below.  Note that changing the type is no longer supported (since there are now separate commands for each type).  Also note that there is a new 'delete' parameter which can be used to remove a clan, guild, or order.

If the name of the organization is more than one word, it must be enclosed in single or double quotes.

SETCLAN SETGUILD SETORDER
These commands are used to define Clan, Guild, and Order Organizations.
 
Syntax:  setclan <clan name> <field>
         setguild <guild name> <field>
         setorder <order name> <field>
Field being one of:
 name    - Name of the organization
 filename- Filename of the clan, guild or Order
 delete  - Used to delete the organization.
 class   - Class # accepted by the clan (for use with Guilds, leave 0 if
             all classes are accepted)
 motto   - Motto of the organization
 desc    - Description of the Organization
 favour  - Favour bestowed by the gods (not currently supported)
 strikes - Displeasure of the gods toward the clan (not currently
             supported)
 deity   - Name of the organization's Deity
 leader  - Name of the organization's Leader
 number1 - Name of the organization's Number One
 number2 - Name of the organization's Number Two
 members - Manually set the number of members
 board   - Roomvnum of the Organization's board
 recall  - Roomvnum to which members of the organization recall
 storage - Roomvnum of the storage room of the organization
            (so that items in the room will save over reboot/crash; use the
             clanstoreroom roomflag in this room as well)
 align   - Alignment to which members must adhere (commented out in code)
 obj1, obj2, obj3 - Vnums of the objects which the Leader can 'make'
 guard1, guard2   - Mobvnums of the organization's primary guardians
 
See SHOWCLAN, MAKECLAN


The show functions are used to display the clan data:

SHOWCLAN SHOWGUILD SHOWORDER
Syntax:  showclan <clan name>
         showguild <guild name>
         showorder <order name>
Example: showclan guild of mages, showclan Retribution
 
Used to display statistics for any clan, guild, or order.
 
See SETCLAN, MAKECLAN and CLANS, GUILDS, ORDERS


When SmaugWizard boots, it tries to load the clan, guild, or order files specified in clan.lst.  If the files are not found, an error will be logged, but the mud will still run.  Also, clan, guild and order storerooms will be attempted to be loaded, and errors will be logged if these files are not found.

In order to create a clan, guild or order storeroom, several conditions have to be met:

1. The room to be used must be set as a 'clanstoreroom'.

2. The clan file must have the vnum of the storeroom set in the storage field.

3. There must be at least one object in the storeroom, and that object must have the 'clanobject' flag or the 'clancorpse' flag.

If all of the above are met, the vault file will be created when the item is dropped in the room, and the item will be placed back in the room whenever the mud is rebooted.

*eof*  Rustry