PennMUSH Community
Show
Ignore:
Timestamp:
07/08/07 20:50:12 (1 year ago)
Author:
shawnw
Message:

Merged 1.8.3p4 into trunk

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • 1.8.3/trunk/game/README

    r515 r1032  
    44PennMUSH as described in the main PennMUSH README file. 
    55 
    6 The next step is to create your configuration file. In the game directory 
    7 is a file called "mush.cnf". If you don't have mush.cnf, but you have 
    8 mushcnf.dst, you can copy mushcnf.dst to mush.cnf.  This file is a list 
    9 of all runtime configuration options with their default settting. Change 
    10 them as you see fit.  IMPORTANT: do not _delete_ any parameters. They 
    11 all need to be there. 
     6The next step is to create your configuration file. In the game 
     7directory is a file called "mush.cnf". If you don't have mush.cnf, but 
     8you have mushcnf.dst, you can copy mushcnf.dst to mush.cnf.  This file 
     9is a list of all runtime configuration options with their default 
     10settting. Change them as you see fit.  IMPORTANT: do not _delete_ any 
     11parameters. They all need to be there. 
    1212 
    1313WIN32 WITH MSVC++: 
    …… 
    2121  containing mush.cnf. Read about the optional settings in that file. 
    2222  The restart script is written for sh, and assumes a fairly standard 
    23   Berkeley UNIX setup. If you're on a HP-UX or SysV machine, for example, 
    24   you may need to change the restart script a bit (the ps options, 
    25   for example). Then run it. 
     23  Berkeley UNIX setup. If you're on a HP-UX or SysV machine, for 
     24  example, you may need to change the restart script a bit. Then run 
     25  it, with 'sh restart' or './restart'. 
    2626 
    27 You should now be ready to start the game.  This distribution can 
     27You should now be able to log into the game.  This distribution can 
    2828general a minimal database - a God character, starting room, and 
    2929master room.  The server will generate this database if it doesn't 
    …… 
    3232If you're starting with the minimal database, the god character "One" 
    3333has no password, so you can log in without one. Of course, you should 
    34 immediately set one (via @newpasswd).  options.h has the Master Room as 
    35 #2 by default; in the minimal database, this room is created for you. 
     34immediately set one (via @newpasswd).  options.h has the Master Room 
     35as #2 by default; in the minimal database, this room is created for 
     36you. 
    3637 
    37 Now you should be set -- all you have to do now is customize the 
    38 .txt files in the game directory. 
     38Now you should be set -- all you have to do now is customize the .txt 
     39files in the game directory. 
    3940 
    4041The logfiles in the "log" directory generally contain useful 
    41 information. You will probably want to read your error logfile (defined 
    42 in mush.cnf) every time, since errors and other important messages get 
    43 printed to that logfile. 
     42information. You will probably want to read your error logfile 
     43(defined in mush.cnf) every time, since errors and other important 
     44messages get printed to that logfile. 
    4445 
    45 After your first startup, it's a good idea to make some small 
    46 change to the database (e.g., @create an object) and then 
    47 do an @shutdown. Restart the game again and ensure that your 
    48 object is still present - this verifies that the server is 
    49 successfully dumping. 
     46After your first startup, it's a good idea to make some small change 
     47to the database (e.g., @create an object) and then do an 
     48@shutdown. Restart the game again and ensure that your object is still 
     49present - this verifies that the server is successfully dumping. 
    5050 
    5151============================================================================ 
    …… 
    7575 
    7676To attempt to fix the problem, do a @dbck to take care of any possible 
    77 minor weirdness in the database, then try doing a "@dump/paranoid", and 
    78 reading the checkpoint logfile (default is log/checkpt.log). This is 
    79 slow, but it will write out an uncorrupted database, and tell you what 
    80 it fixed. Back up that database and indb.Z, then figure out what you're 
    81 going to do next: you can take the game down with a kill -9, or attempt 
    82 to manually fix the problem by either @destroying the offending object, 
    83 or attempting to reset the attributes on the object that are causing a 
    84 problem.  If "@dump/paranoid" dies, you are more or less out of luck. 
     77minor weirdness in the database, then try doing a "@dump/paranoid", 
     78and reading the checkpoint logfile (default is log/checkpt.log). This 
     79is slow, but it will write out an uncorrupted database, and tell you 
     80what it fixed. Back up that database and indb.Z, then figure out what 
     81you're going to do next: you can take the game down with a kill -9, or 
     82attempt to manually fix the problem by either @destroying the 
     83offending object, or attempting to reset the attributes on the object 
     84that are causing a problem.  If "@dump/paranoid" dies, you are more or 
     85less out of luck. 
    8586 
    8687The game may crash from time to time. It will generate a core file, 
    …… 
    9192your source code, and type 
    9293    <name of debugger> netmud ../game/core 
    93 If you don't call your executable "netmud", substitute in whatever  
    94 you do call it. 
     94If you don't call your executable "netmud", substitute in whatever you 
     95do call it. 
    9596 
    9697You are looking for variables set to bizarre values - attempts to 
    …… 
    109110name>" to see the value of a variable at the time the game crashed. 
    110111The "gdb" debugger is similar to "dbx"; with that, you can abbreviate 
    111 "print" as "p". 
     112"print" as "p". It is the reccomended debugger to use; when gdb is 
     113present on your system and you're using gcc as the compiler, gcc is 
     114told to use a gdb-specific debugging format. 
    112115 
    113 Javelin appreciates news of any bugs found, and any patches that have 
    114 been written to deal with them. He is also interested in any extensions 
    115 that people make to the code, and requests that ones that are of more 
    116 than just local interest be sent to him for inclusion in the next 
    117 release of this code. 
     116If you want to start PennMUSH running under a debugger, instead of 
     117attaching to an already-running process, it'll need two arguments: 
     118--no-session, and the name of your config file if it is different than 
     119mush.cnf. Without --no-session, the server will immediately fork off a 
     120detatched child process, and the debugger will tell you that the 
     121process exited normally.. 
    118122 
    119 One important thing to remember is, if the MUSH refuses to start, there 
    120 is probably a good reason. Check the MUSH log, and the core file, if 
    121 there is one. Make sure to back up your database before attempting to 
    122 restart -- remember that every time it restarts, it overwrites 
    123 indb.Z.old. If you restart three times and somehow manage to trash your 
    124 database each time (for example, a full process table zero'ing out your 
    125 files), you won't have a backup to restart from, unless you've backed 
    126 up your database before trying! 
     123The PennMUSH developers appreciate news of any bugs found, and any 
     124patches that have been written to deal with them. We are also 
     125interested in any extensions that people make to the code, and 
     126requests that ones that are of more than just local interest be sent 
     127to us for inclusion in the next release of this code. See 
     128http://dev.pennmush.org. 
     129 
     130One important thing to remember is, if the MUSH refuses to start, 
     131there is probably a good reason. Check the MUSH log, and the core 
     132file, if there is one. Make sure to back up your database before 
     133attempting to restart -- remember that every time it restarts, it 
     134overwrites indb.Z.old. If you restart three times and somehow manage 
     135to trash your database each time (for example, a full process table 
     136zero'ing out your files), you won't have a backup to restart from, 
     137unless you've backed up your database before trying! 
    127138 
    128139You can also find helpful tips in Javelin's Guide for Gods, 
    129140which is available on the WWW as 
    130     http://pennmush.org/~alansz/guide.html 
    131 and by ftp from pennmush.org as  
    132     /pub/DuneMUSH/Guide/guide-single.txt 
     141    http://javelin.pennmush.org/~alansz/guide.html 
     142and by ftp from ftp.pennmush.org as  
     143    /PennMUSH/Guide/guide-single.txt 
    133144