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/INSTALL

    r919 r1032  
    88 
    99If you are upgrading from a previous PennMUSH release, this is 
    10 probably not the file you want to start with. Read the UPGRADING 
    11 file first. 
     10probably not the file you want to start with. Read the UPGRADING file 
     11first. 
    1212 
    13 DISCLAIMER: Before attempting to run a MUD of any sort, you should have 
    14 some reasonable knowledge of UNIX and C.  If you do not, it is _strongly_ 
    15 suggested that you learn UNIX and C to some reasonable level of competency 
    16 before attempting to set up a MUSH.  (Note that even people using the 
    17 Windows ports are encouraged to know UNIX, because that's the paradigm 
    18 that PennMUSH was built with, and most resources will be written with 
    19 UNIX is mind.) 
     13DISCLAIMER: Before attempting to run a MUD of any sort, you should 
     14have some reasonable knowledge of UNIX and C.  If you do not, it is 
     15_strongly_ suggested that you learn UNIX and C to some reasonable 
     16level of competency before attempting to set up a MUSH.  (Note that 
     17even people using the Windows ports are encouraged to know UNIX, 
     18because that's the paradigm that PennMUSH was built with, and most 
     19resources will be written with UNIX is mind.) 
    2020 
    21 You may also want to take a look at Javelin's Guide for PennMUSH Gods, 
    22 at http://pennmush.org/~alansz/guide.html 
    23 or by ftp from pennmush.org, /pub/PennMUSH/Guide 
     21You may also want to take a look at the Managing PennMUSH book at 
     22http://community.pennmush.org and at Javelin's Guide for PennMUSH 
     23Gods, at http://javelin.pennmush.org/~alansz/guide.html or by ftp from 
     24pennmush.org, /pub/PennMUSH/Guide 
    2425============================================================================ 
    2526  
    …… 
    2829Here's a quick picture of the organization of the MUSH directory tree. 
    2930The "src" directory contains C source code.  The "hdrs" directory 
    30 contains header files for the source code.  The files used by a running 
    31 MUSH are in the "game" directory, which includes subdirectories "data" 
    32 (current databases), "txt" (text files and directories for building them), 
    33 "log" (log files), and "save" (backup databases).  Finally, the "hints" 
    34 directory is used during the installation process, the "po" directory 
    35 holds translation message files. 
     31contains header files for the source code.  The files used by a 
     32running MUSH are in the "game" directory, which includes 
     33subdirectories "data" (current databases), "txt" (text files and 
     34directories for building them), "log" (log files), and "save" (backup 
     35databases).  Finally, the "hints" directory is used during the 
     36installation process, the "po" directory holds translation message 
     37files. 
    3638 
    3739 pennmush--+-> src 
    …… 
    5860        Microsoft Windows 
    5961          
    60 There's no real reason why PennMUSH shouldn't compile on any 32-bit 
    61 or better BSD, System V, or POSIX operating system.  Development is 
     62There's no real reason why PennMUSH shouldn't compile on any 32-bit or 
     63better BSD, System V, or POSIX operating system.  Development is 
    6264primarily done on GNU/Linux and Mac OS X systems. 
    6365 
    …… 
    7072     The quickstart version of the installation is: 
    7173 
    72 1. On win32 only, install proper tools or read win32/README*. 
    73 2. ./configure or some variant 
     741a. On win32 only, install proper tools or read win32/README*. 
     751b. On Unix systems, you need: A C compiler, perl, the minimum development 
     76    packages required to compile programs (Linux distributions that don't 
     77    come with gcc in the base install often need a package named glibc-dev) 
     782. Run ./configure or some variant 
    74793. create options.h, or make update 
    75804. make install 
    …… 
    8388 
    84892. On Unix systems, unpack the code and: 
    85         cd pennmush 
    86     ./configure  
     90        % cd pennmush 
     91    % ./configure  
    8792 
    8893   Useful arguments to configure: 
    …… 
    1051103. EITHER: 
    106111 
     112Type 'make update', and answer all the questions about which MUSH 
     113options you want. 
     114 
     115OR 
     116 
    107117Copy options.h.dist to options.h. Note that these files stay in the 
    108118pennmush directory. 
    …… 
    112122Also, cp game/mushcnf.dst to game/mush.cnf and edit.  
    113123 
    114 OR: 
    115  
    116 Type 'make update', and answer all the questions about which MUSH 
    117 options you want. 
    118124 
    119125You should not need to change any of the other header files. 
    …… 
    124130 
    1251315. If you plan to run multiple MUSHes, you may want to do a "make 
    126 customize" which will run a script to help set up a separate customized 
    127 game subdirectory for each MUSH (run it once per MUSH you plan to run). 
    128 Files in these subdirectories will already be customized in many ways, 
    129 so what follows may be slightly different. :) This is probably broken. 
     132customize" which will run a script to help set up a separate 
     133customized game subdirectory for each MUSH (run it once per MUSH you 
     134plan to run).  Files in these subdirectories will already be 
     135customized in many ways, so what follows may be slightly different. :) 
     136This is probably broken. 
    130137 
    1311386. Read game/README and follow those instructions.  
    132139 
    133140A final thing you may want to think about is compiling announce.c or 
    134 portmsg.c. These are port announcers; if your MUSH ever goes down, you can 
    135 set one up, and a message will be given to a person attempting to connect 
    136 to that port.  Read that file for details. It is not an official MUSH 
    137 piece of code; rather, it is a freely distributable program available 
    138 via anonymous FTP that is included in this code because it happens to 
    139 be fairly useful.  Javelin suggests using portmsg - it appears to be 
    140 more stable. 
     141portmsg.c. These are port announcers; if your MUSH ever goes down, you 
     142can set one up, and a message will be given to a person attempting to 
     143connect to that port.  Read that file for details. It is not an 
     144official MUSH piece of code; rather, it is a freely distributable 
     145program available via anonymous FTP that is included in this code 
     146because it happens to be fairly useful.  Javelin suggests using 
     147portmsg - it appears to be more stable. 
    141148 
    142149============================================================================ 
    …… 
    150157Configure) from the pennmush directory.  It does include the options.h 
    151158that it was built with, as an aid to those who decide later that they 
    152 want to customize the server; they are useful as a baseline to work from. 
     159want to customize the server; they are useful as a baseline to work 
     160from. 
    153161 
    154162Using the pre-built binary is fairly simple; adjust your configuration 
    …… 
    156164PennMUSH.exe (you may need to use PennMUSH /run or PennMUSH /start). 
    157165Alternately, if you want the MUSH to automatically start each time you 
    158 turn on your machine, you can install it as a system service by running 
    159 'PennMUSH /install'.  PennMUSH can be removed from service status via 
    160 'PennMUSH /remove'. 
     166turn on your machine, you can install it as a system service by 
     167running 'PennMUSH /install'.  PennMUSH can be removed from service 
     168status via 'PennMUSH /remove'. 
    161169