[Home] [Downloads] [Search] [Help/forum]

Configuring PennMUSH


Step 1. Set up the MUSH configuration file - MUSH.CNF

One of the first things that the PennMUSH server does is read in the "MUSH configuration" file (MUSH.CNF) to find out important run-time information, such as the name of the MUSH, and the port it is listening on. To get started, you should:

Click on Configuration Directives for a table of some configuration directives that can be placed in the MUSH.CNF file.

A more comprehensive list is provided at the end of FAQ for Win32 PennMUSH.

Minimal changes to make to the MUSH.CNF file

I suggest as a minimum you change the following items in MUSH.CNF...

Directive New value
mud_name (The name of your MUSH)
input_database data/indb
output_database data/outdb
crash_database data/PANIC.db
compress_program
uncompress_program
compress_suffix
use_dns No - if you are running "offline" and do not have access to a domain name server

Step 2. Set up your database

For the MUSH to run you need a database in the "Data" folder. If you are using the "minimal" database (called "minimal.db") then you should rename it to "indb". Make sure you have changed the MUSH.CNF file to specify the name of the input database as "indb" as described in the previous section.

If you are using a database from a previous version, or from the Unix version of PennMUSH, then put that file into the Data folder, called "indb".


Step 3. Amend your "welcome" text files

Various files are automatically sent to the player when they connect, disconnect and so on. You should edit each of these files with a text editor and customise them to your own requirements.

The purpose of each file is as follows ...

File Purpose
txt/connect.txt Shown when players connect
txt/motd.txt Message of the day
txt/wizmotd.txt Wizards message of the day
txt/newuser.txt Shown to new users
txt/register.txt Shown to users if they try to create a character when registration enforced
txt/quit.txt Shown when players quite
txt/down.txt Shown when non-wizard logins disabled
txt/full.txt Shown when maximum players are logged in
txt/guest.txt Shown to guests

For example, here is the default contents of "connect.txt":



<This is where you announce that they've connected to your MUSH>
<It's a good idea to include the version/patchlevel of MUSH you're running>
<It's a good idea to include an email address for questions about the MUSH>
-----------------------------------------------------------------------------
Use create <name> <password> to create a character.
Use connect <name> <password> to connect to your existing character.
Use QUIT to logout.
Use the WHO command to find out who is online currently.
-----------------------------------------------------------------------------
Yell at your local god to personalize this file!

Step 4. Create entries in "news", "rules", and "events" files

When the MUSH server starts up, it automatically creates four "help" files by reading the contents of four subdirectories, and indexing all of the files it finds there (which match the appropriate wildcard). The indexing process allows fast lookup of help during MUSH operation.

You should probably leave the "help" files alone, as they describe the internal operation of PennMUSH (ie. the built-in commands), but you could set up your own "news", "rules" and "events" files.

The appropriate folders and wildcards are:

Folder Wildcard Purpose
Nws *.nws News
Evt *.evt Events
Hlp *.hlp Help
Rul *.rul Rules

You can place as many files are you want in each directory, as the program automatically reads every file that matches the appropriate wildcard. For example, in the "Nws" folder you could have files "a.nws", "b.nws", "c.nws" and so on.

To make a topic entry you should put the topic heading on a line on its own, preceded by the ampersand (&) character.

For example, here is the entry for CHAT:

& CHAT
  CHAT SYSTEM

  The MUSH has a built-in chat system with many different channels.
  These channels vary from MUSH to MUSH; ask at your local site or
  use @channel/list to see which ones are available.

If the player types: "help chat" then they would see the above text.

Each category of file (help, news, rules, and events) should have an entry for "HELP". This is shown to the player if they type the appropriate word in its own. For example, if the player types "EVENTS" then the entry for "HELP" in the "Evt" folder is shown to him/her.


Step 7. Create an ACCESS.CNF file

You can use the file ACCESS.CNF to allow or disallow access to the MUSH from various sites. For details about setting up ACCESS.CNF click on Setting up ACCESS.CNF.


Step 8. Amend NAMES.CNF

The file NAMES.CNF lists (one name per line) all of the names that players may not use for their characters. You may wish to add extra names to this file (it comes with four default ones) if there are other names which your MUSH would find offensive.


[Previous] [Next] [Back] [Home]
Written by Nick Gammon - 5K

Comments to Gammon Software support

[Best viewed with any browser - 2K]    Internet Contents Rating Association (ICRA) - 2K    [Web site powered by FutureQuest.Net]

Page updated on Wednesday, 15 December 2004