|
Table of Contents
|
Help
Our Mush-system has it's own online help facility that can be accessed via typing 'help'. This database covers all normal commands common to all MUSHes that use this code.
| Command | Usage |
| help <topic> | provides a help-file on <topic> |
| help topics | to get a list topics |
Notes on help descriptions:
| [text] | Text enclosed in []'s is optional. The []'s are never typed in as part of the command. |
| <parameter> | Information parameter for a command. The <>'s are never typed in as part of the command. |
+Help and +News
Staff of Los Angeles installed and designed additional commands specifically for Los Angeles. Details on LAmush code and commands can be found by typing +help. +news files provide additional files on theme, setting and policies.
Most of the files in +news and +help are also available on this website, and more. However, due to different formatting options, the +news and +help files on the MUSH are organized in slightly different structure.
The current +news and +help structure of the LAmush is provided below. This may change in the future.
Available +News Areas
| Area | Description |
| Introduction | What is this all about anyway? |
| CharGen | Step by Step Character Generation |
| Theme | The theme, mood and texture of the MUSH |
| Policies | Items on staff structure, policies, etc. |
| Staff | Staff Only-files on various news-topics |
| Systems | The game system and rules used on this MUSH |
| FAQ | Frequently Asked Questions |
| Lores | Knowledge locked to lores |
| Domains | Information about Los Angeles' vampire territories. |
| Mortal L.A. | Los Angeles history as mortals understand it. |
| Undead L.A. | The 'other' history. |
| Outside L.A. | Information about places near Los Angeles |
| Menu | Lore-locked News Files relating to hunting grounds |
| Applications | Everything you wanted to know about apps |
| Combat | System Rules for Combat |
| Government | A primer for vampire politics in Los Angeles |
| Building | Building policies and guidelines |
| MUSHing | Some starting points for those new to MUSHing |
Available +Help Areas
| Area | Description |
| +help and +news | reading and installing +news and +help files |
| OOC | Out of character commands (+who, +finger, and etc) |
| IC | In Character commands (i.e. for travel) |
| Social | Commands to manage social relationships and contests. |
| Character | Commands which show and set character stats, etc. |
| Jobs | Commands for managing the jobs queue |
| Commands for MUSH Mail | |
| BBS | Bulletin Board System commands (+bbpost, +bblist, etc.) |
| Admin | Restricted commands for staff only |
| Functions | Soft-coded functions of general utility |
Commands for Accessing +News
| Command | Usage |
| +news | List news areas and area descriptions |
| +news <area> | List news items within <area> |
| +news <area>/<item> | Show news <item> from <area> |
| +news <item> | Show news <item> from last referenced area |
| +news/next, +nn | Show next page in current news item |
| +news/prev, +np | Show previous page in current news item |
| +news/first | Show first page in current news item |
| +news/last | Show last page in current news item |
| +news/again | Show current page again |
| +search news for <word> | This will show all places in news where <word> occurs. E.g.: +search news for frenzy (This command is Staff only) |
Commands for Accessing +Help
| Command | Usage |
| +help | List help areas and area descriptions |
| +help <area> | List help items within <area> |
| +help <area>/<item> | Show help <item> from <area> |
| +help <item> | Show help <item> from last referenced area |
| +help/next, +hn | Show next page in current help item |
| +help/prev, +hp | Show previous page in current help item |
| +help/first | Show first page in current help item |
| +help/last | Show last page in current help item |
| +help/again | Show current page again |
| +search help for <word> | This will show all places in news where <word> occurs. E.g.: +search help for combat (This command is Staff only) |
Installing News & Help (Staff Only)
This item talks about news. However, installing help is exactly the same, except that the object is stored in the +help system and not the +news system.News is stored in a number of areas, each of which comprises a number of items. News items may have multiple pages.In addition, some items may be withheld from the index, and individual pages can be locked so that only certain players can see them.
A few commands have been added to fix a shortcoming in the TinyMUSH 3.x security model.The news objects must now be wizard-owned, so non-wizard staff should use the following to modify news:
| Command | Usage |
| +addnews <area>/<topic>/<p>=<text> | Adds a new <p> (page) with the entered <text> to a (new) +news-<topic> in the specified +news <area> |
| +addhelp <area>/<topic>/<p>=<text> | Adds a new <page> with the entered <text> to a (new) +help-<topic> in the specified +help <area> |
| +ednews <area>/<topic>/<p>=<old>/<new> | Replaces <old> text by <new> text on the specified +news <area>, +news <topic> and <p> (page-number). |
| +edhelp <area>/<topic>/<p>=<old>/<new> | Replaces <old> text by <new> text on the specified +help <area>, +help <topic> and <p> (page-number). |
| +locknews <area>/<topic>/<p>=<lock> | Sets <lock> to the specified +news <area>, +news <topic> and <p> (page-number). |
| +lockhelp <area>/<topic>/<p>=<lock> | Sets <lock> to the specified +help <area>, +help <topic> and <p> (page-number). |
| +undonews | Undoes previous change to +news |
| +undohelp | Undoes previous change to +help |
Notes & Definitions:
| <area> is the news/help category (E.g. 'admin') |
| <topic> is - well - the topic (E.g. 'nowho') |
| <p> is the sequenced page number |
| <text> is content to overwrite |
| <old> is text to change |
| <new> is text replacing <old> |
| <lock> will require double-percents - e.g.: +locknews lore/vampire/1=gte(stat(%%0,vampire lore),1) +lockhelp admin/steal/1=hasaccess(%%0,STEAL) An empty <text> or <lock> will remove said item.The following pages go into the implementation details for TechArchs. |
Extended Configuration (Wizard Only)
Adding a new +news Area
To add a new area, an object containing that areas news file is placed inside the +news System object (which is located in the Master Room). The name of the object forms the name of that area, so keep it short.
The description of the object forms the area description. This should be short also.
NOTE: The news editor caches areas, so you will need to @trigger the @startup on the news editor after installing a new object.
Adding new items
News items are stored in attributes on the area object. Each page of news is stored in a single attribute. The pages of an item are stored in attributes named: ITEM_<item name>+<page reference>where <item name> is the name of the news item with all spaces changed to underbar characters '_'. The <page reference> is normally a single character.
The Index Page
The index page is automatically generated. The @succ of the object is shown first, then an index of items.If a news item contains a page with no page reference, that item will show in the index for the area. The pages are sorted into alphabetical order, so normally it makes sense to number pages something like..
ITEM_INSTALLING_NEWS+
ITEM_INSTALLING_NEWS+1
ITEM_INSTALLING_NEWS+2..
ITEM_INSTALLING_NEWS+9
ITEM_INSTALLING_NEWS+A..
To prevent a news item showing in the index, simply do not install a page with no page reference.
If a news object has a MAIN attribute set, then that will be used to display a news item, rather than show the index. Be careful with this, it stops the index being seen at all.E.g.&MAIN area=installing news
Locking Pages
Locking PagesIndividual pages can be hidden from users by locking them. A locked page will not form part of that item for a user who fails the lock. To lock a page, set an attribute of the form:LOCK_<item name>+<page reference>and the equivalent page will be locked. The lock attribute should evaluate to zero when the item is to be withheld. The user is passed in as %0E.g,&LOCK_INSTALLING_NEWS+3 help=hasflag(%0,WIZARD)
Locking Areas
To lock an entire area, simply @lock the area object.
Alternate Pages
Alternate PagesAlternative pages can be set upby providing two pages with opposite locks,eg:
&ITEM_INSTALLING_NEWS+3A help=Page for wizards..
&LOCK_INSTALLING_NEWS+3A help=hasflag(%0,WIZARD)
&ITEM_INSTALLING_NEWS+3B help=Page for non-wizards..
&LOCK_INSTALLING_NEWS+3B help=not(hasflag(%0,WIZARD))
