https://wiki.tinymux.org/index.php?title=Game_documentation&feed=atom&action=historyGame documentation - Revision history2024-03-29T13:03:03ZRevision history for this page on the wikiMediaWiki 1.41.0https://wiki.tinymux.org/index.php?title=Game_documentation&diff=3844&oldid=prevScratch-n-sniff: /* Adding a New File */2008-12-31T09:19:08Z<p><span dir="auto"><span class="autocomment">Adding a New File</span></span></p>
<p><b>New page</b></p><div>Traditionally the server developers package [[Player_Documentation|help]] and a minimal 'news' file system with the server download. Game developers then add their game specific information into the news files, in +help files, or other files with a different name than the server-specific 'help'.<br />
<br />
News files usually contain information about the theme, setting, game mechanics, and rules and policies. News is sometimes called +news, +theme, +rules, and so on. <br />
<br />
+Help files typically contain all the [[softcode|softcoded]] commands written or installed especially for a specific game. <br />
<br />
<br />
== News systems ==<br />
<br />
By default, the news system is based off of text files that reside on the shell. These text files include news, plushelp, help, wiznews, and wizhelp. Depending on the platform, there are also others that may exist. Most current day server platforms also allow the definition of custom text files. Many games use these for files such as 'theme' or 'policy'.<br />
<br />
=== Setting up ===<br />
<br />
Initially, the news files are empty or come pre-populated with a command system such as [[SGP]] on [[TinyMUX]]. A file appears as follows:<br />
<br />
& help<br />
<br />
This is the main index displayed when typing the command online. <br />
It is always & help regardless of whether the file is news, +help, or other.<br />
<br />
& file name<br />
<br />
The text information goes here for '<whatever> file name'.<br />
<br />
=== Tricks ===<br />
<br />
The MU [[parser]] for these files displays them, by default, without ansi or function evaluation. This can be changed in the configuration files by using the [[helpfile]] config parameter on most platforms.<br />
<br />
Any line that needs to appear blank on the MU must have a space in it. Without this extra 'invisible' space, the line will be treated as though it is not there and run together.<br />
<br />
& help<br />
(blank space)<br />
This is the main index<br />
<br />
=== Adding a New File ===<br />
<br />
To add a new help file, open your netmux.conf file and find the helpfile section, usually located towards the end.<br />
<br />
There, you should see something like this :<br />
<br />
helpfile +help text/plushelp<br />
helpfile +shelp text/staffhelp<br />
access +shelp staff<br />
<br />
Simply add your new help file (for example, the help file for Anomaly Jobs) in the same format as the above, like so :<br />
<br />
helpfile +jhelp text/plusjhelp<br />
<br />
where 'plusjhelp' is the name and 'text/' is the location of the help file. Following this, issue a @restart command inside the game, and your new help file will be in place, ready for access by anyone typing '+jhelp'.<br />
<br />
== +Help systems ==</div>Scratch-n-sniff