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