Manual:Wizhelp Files
The help texts gods read in the game with wizhelp are kept here, one page for each, named Wizhelp/<Name>. They reach the game the same way as the players' help pages (see Help Files), with their own script, file type and index. To write one, see Editing the Wiki.
Contents
How a page reaches the game
The scripts are in vme/etc/help/:
getwikiwizhelppage.py <Name>fetches the pageWizhelp/<Name>and saves it as<name>.wiz(the name in lower case) in the current directory.fetchwizpages.shruns it for every Wizhelp page, one after the other.
Run it from vme/etc/help/ and move the files into vme/etc/help/strings/, where the game reads them:
cd vme/etc/help sh fetchwizpages.sh mv *.wiz strings/
getwikiwizhelppage.py is getwikihelppage.py for the Wizhelp/ pages, and treats a page the same way: the file is the page as the wiki renders it, in HTML; HTML comments go; the first heading is cleaned; a red link to a Wizhelp/ page becomes {text}; and every {text} becomes <a cmd='#'>text</a>, a link that runs text as a command when clicked. {Wizhelp Goto} runs wizhelp goto. Help Files has the details.
Wizhelp topics: wiz.index
wizhelp <command> (the do_wizhelp program in vme/zone/helpzon.zon) finds the text through vme/etc/help/strings/wiz.index, which works like help.index: lines topic=file, grouped by first letter between :start:a and :end:a, and so on, and the first topic that starts with what you typed is shown. Several commands share a page: nocomm and notell show Wizhelp/Noshout, flick, mash and rock show Wizhelp/Wizsocials, path shows Wizhelp/Wpath, and wizinv finds wizinvisible, Wizhelp/Wizinvisible. Below the text, the game adds a link to the page on this wiki, named after the file.
wizhelp alone does not read the index: it lists the commands in the game's command table from level 200 up to your own level. A page for something that isn't a command of that level, such as Wizhelp/File or Wizhelp/Personal, is only shown when you type its name. wizhelp notes shows the builders' notes of the zone you are in.
As with help, the files are read from disk each time, so a new or changed file needs no reboot.
Adding a wizhelp page
- Write the page here,
Wizhelp/<Name>, with a capital first letter (the part afterWizhelp/is case-sensitive). - Add
python3 getwikiwizhelppage.py <Name>tovme/etc/help/fetchwizpages.sh. - Fetch it into
vme/etc/help/strings/. - Add its topics to
wiz.index, each in its letter's section. - Commit the script, the index and the
.wizfile, and open a pull request.
Each command's level is its minlevel in vme/etc/commands.def; Wizarding 101 lists them all.
The wizhelp pages
- Advance
- At
- Ban
- Boards
- Broadcast
- Cdelete
- Competition
- Copy
- Corpses
- Crash
- Cstat
- Delete
- Echo
- Execute
- File
- Force
- Freeze
- Gmlure
- Gmmem
- Gmquest
- Gmroom
- Gmtrack
- Gmtreasure
- Gmyule
- Gmzap
- Goto
- Jstat
- Load
- Makemoney
- Message
- Noshout
- Nset
- Personal
- Petrify
- Plog
- Purge
- Reboot
- Reset
- Restore
- Seize
- Set
- Setskill
- Shutdown
- Snoop
- Switch
- Title
- Transfer
- Users
- Wedit
- Where
- Wiz
- Wizhelp
- Wizinvisible
- Wizlock
- Wizsocials
- Wpath
- Wstat
- Wtimewarp
- Zap