files.doc
1 /************************************************************************** 2 * Copyright (C) 1993 - see 'license.doc' for complete information. * 3 **************************************************************************/ 4 5 CircleMUD File Manifest 6 7 8 The main circle directory has the following subdirectories and files: 9 10 README - Information for the new CircleMudder 11 automaint - shell script to perform maintenance .. see running.doc 12 autorun - shell script to run the MUD .. see running.doc 13 bin/ - directory of all the compiled programs (binaries) 14 doc/ - documentation 15 lib/ - MUD data (playerfile, world files, etc.) 16 log/ - system logs 17 src/ - source code 18 syslog - the current system log 19 20 The bin/ directory contains only binaries: 'circle' (the main MUD) and 21 its utilities, which are described in utils.doc. 22 23 The doc/ directory has its own README file, describing the contents of 24 each of the documentation files. 25 26 The lib/ directory contains the following subdirectories: 27 28 etc - Files which the MUD uses internally (playerfile, mail, etc.) 29 misc - Misc. database files meant to be changed (i.e. socials) 30 plrobjs - Player object hierarchy and utility scripts 31 text - Text files such as MOTD, news, help, etc. 32 world - The world hierarchy 33 34 35 The lib/etc directory contains the following files (the MUD actively maintains 36 these files while it is running; they should not be modified unless the game 37 is down): 38 39 Board.* - Binary files with the contents of the bulletin boards 40 badsites - List of banned sites 41 hcontrol - Binary file with the state of the house control system 42 players - Binary file containing data on all players 43 plrmail - Binary file containing player mail 44 45 The lib/misc directory contains the following files: 46 47 bugs - Bugs reported by players with the 'bug' command 48 ideas - Ideas from players from 'idea' command 49 messages - Spell and skill damage messages 50 socials - Text file with text of the socials 51 typos - Typos reported by players with the 'typo' command 52 xnames - Text file of invalid names 53 54 The lib/plrobjs contains the following files and directories: 55 56 a-e \ 57 f-j \ 58 k-o \ Subdirectories where player objects files are stored 59 p-t / 60 u-z / 61 zzz/ 62 purgedir - Script to purge an object dir (meant for use by purgeobjs) 63 purgeobjs - Script to purge player objects (see utils.doc) 64 searchfor - Script to search for objects in obj files (see utils.doc) 65 66 The lib/text directory contains the following files: 67 68 background - Background story (for option 3 from main menu) 69 credits - Text for 'credits' command 70 handbook - Text for Immortal Handbook ('handbook' command) 71 help - Text for 'help' command with no arguments 72 help_table - File of all help entries for 'help' command 73 immlist - Text for 'immlist' command 74 imotd - Immortal MOTD -- seen by immortals on login 75 info - Text for 'info' command 76 motd - MOTD -- seen by mortals on login 77 news - Text for 'news' command 78 policies - Text for 'policy' command 79 wizlist - Text for 'wizlist' command 80 81 The lib/world directory contains the following subdirectories: 82 83 mob - Contains *.mob files (mobile files) 84 obj - Contains *.obj files (object files) 85 shp - Contains *.shp files (shop files) 86 wld - Contains *.wld files (world files) 87 zon - Contains *.zon files (zone files) 88 89 Each of the 5 subdirectories in the lib/world directory also contains 90 two additional files -- one called 'index', which specifies which files 91 in that directory should be loaded when the MUD boots, and 'index.mini', 92 which specifies which files should be loaded if the MUD is booted with 93 the -m (mini-mud) option. 94 95 The log/ directory contains several files of the form syslog.n, where n 96 is a small number. These are the most recent CircleMUD syslogs. 97 98 In addition, it contains the following more permanent system logs: 99 100 badpws - Records of bad password attempts 101 delete - Players who have self-deleted 102 dts - Players who have hit death traps 103 errors - MUD system errors ("SYSERR" messages) 104 levels - Records of all levels gained by all players 105 newplayers - Records of the creation of new players 106 rentgone - Players who have lost their items in rent 107 restarts - List of times at which the MUD rebooted 108 rip - Player deaths 109 usage - Mud system usage (player load & memory usage info) 110 111 112 The src directory contains all of the C and header files for the MUD, 113 along with a Makefile. The src/util directory contains source for 114 CircleMUD's utility programs. See running.doc for more information 115 on how to compile the MUD. See utils.doc for more information on how 116 to use CircleMUD's utilities. 117