Documentation: Console commands and variables as Amethyst sources

Generated an .ame source for each console command and variable based
on the cphelp/conhelp files. These are intended as the new master
copy of this documentation. Later on the console help files will be
generated out of these sources.

Todo: Script for generating categorized wiki pages for commands and
variables, plus index tables.

doomsday/build/scripts/help2ame.py

@@ -0,0 +1,53 @@
+# Reads a cphelp/conhelp file and outputs an .ame source for each
+# command and variable.
+#
+# Arguments:
+# 1 - input file (cphelp/conhelp)
+# 2 - component (engine, libcommon, etc.)
+
+import os
+import sys
+
+def escaped(s):
+    result = ''
+    for c in s:
+        if c == '{': c = '@{'
+        elif c == '}': c = '@}'
+        elif c == '@': c = '@@'
+        result += c
+    return result
+
+source = sys.argv[1]
+component = sys.argv[2]
+mode = None
+name = ''
+path = None
+output = None
+
+print 'Component:', component
+
+for line in file(source).readlines():
+    line = line.strip()
+    if len(line) == 0: continue
+
+    if '# CONSOLE VARIABLE' in line: mode = 'variable'
+    elif '# CONSOLE COMMAND' in line: mode = 'command'
+
+    if mode is None: continue
+
+    if line.startswith('['):
+        name = line[1:-1].strip()        
+        outDir = os.path.join(component, mode)
+        path = os.path.join(outDir, name + '.ame')
+        print path
+        if not os.path.exists(outDir): os.makedirs(outDir)
+        output = file(path, 'w')
+
+    if output != None:
+        if line.startswith('desc'):
+            desc = line[line.index('=') + 1:].strip()
+            print >> output, "@summary{\n    %s\n}" % escaped(desc)
+        elif line.startswith('inf'):
+            info = line[line.index('=') + 1:].strip()
+            print >> output, "@description{\n    %s\n}" % escaped(info)
+

doomsday/build/scripts/unify.py

@@ -0,0 +1,22 @@
+import os, sys
+
+comps = ['libdoom', 'libheretic', 'libhexen']
+
+def unify(mode):
+    for fn in os.listdir('libdoom/'+mode):
+        # Do the others have this?
+        content = file('libdoom/%s/%s' % (mode, fn)).read()
+
+        try:
+            if content == file('libheretic/%s/%s' % (mode, fn)).read() and \
+               content == file('libhexen/%s/%s' % (mode, fn)).read():
+
+               file('libcommon/%s/%s' % (mode, fn), 'w').write(content)
+               for com in comps:
+                   os.remove('%s/%s/%s' % (com, mode, fn))        
+               print 'unified', mode, fn
+        except IOError:
+            pass
+
+unify('variable')
+unify('command')

doomsday/doc/engine/command/add.ame

@@ -0,0 +1,3 @@
+@summary{
+    Add something to a cvar.
+}

doomsday/doc/engine/command/after.ame

@@ -0,0 +1,6 @@
+@summary{
+    Execute the specified command after a delay.
+}
+@description{
+    Params: after (tics) (cmd)\nFor example, 'after 35 "echo End"'.
+}

doomsday/doc/engine/command/alias.ame

@@ -0,0 +1,3 @@
+@summary{
+    Create aliases for a (set of) console commands.
+}

doomsday/doc/engine/command/apropos.ame

@@ -0,0 +1,3 @@
+@summary{
+    Summarize all help containing a search term.
+}

doomsday/doc/engine/command/bindcontrol.ame

@@ -0,0 +1,3 @@
+@summary{
+    Bind an input device to a player control.
+}

doomsday/doc/engine/command/bindevent.ame

@@ -0,0 +1,6 @@
+@summary{
+    Bind a console command to an event.
+}
+@description{
+    Params: bindevent (event-descriptor) (command)\nExamples:\n  bindevent "key-M-down" @{print "M was pressed"@}\n  bindevent "mouse-right-up + key-shift" @{print "RMB released while Shift down"@}
+}

doomsday/doc/engine/command/blc.ame

@@ -0,0 +1,6 @@
+@summary{
+    Set color of light at cursor.
+}
+@description{
+    Params: blc (red) (green) (blue)\nFor example, 'blc 1 0.5 0.2'.
+}

doomsday/doc/engine/command/blclear.ame

@@ -0,0 +1,3 @@
+@summary{
+    Delete all lights.
+}

doomsday/doc/engine/command/bldel.ame

@@ -0,0 +1,3 @@
+@summary{
+    Delete current/specified light.
+}

doomsday/doc/engine/command/bldup.ame

@@ -0,0 +1,3 @@
+@summary{
+    Duplicate current/specified light, grab it.
+}

doomsday/doc/engine/command/bledit.ame

@@ -0,0 +1,3 @@
+@summary{
+    Enter bias light edit mode.
+}

doomsday/doc/engine/command/blgrab.ame

@@ -0,0 +1,3 @@
+@summary{
+    Grab current/specified light, or ubgrab.
+}

doomsday/doc/engine/command/blhue.ame

@@ -0,0 +1,3 @@
+@summary{
+    Show/hide the hue circle for color selection.
+}

doomsday/doc/engine/command/bli.ame

@@ -0,0 +1,3 @@
+@summary{
+    Set intensity of light at cursor.
+}

doomsday/doc/engine/command/bllock.ame

@@ -0,0 +1,3 @@
+@summary{
+    Lock current/specified light.
+}

doomsday/doc/engine/command/blmenu.ame

@@ -0,0 +1,3 @@
+@summary{
+    Show/hide the bias menu.
+}

doomsday/doc/engine/command/blnew.ame

@@ -0,0 +1,3 @@
+@summary{
+    Allocate new light and grab it.
+}

doomsday/doc/engine/command/blquit.ame

@@ -0,0 +1,3 @@
+@summary{
+    Exit bias light edit mode.
+}

doomsday/doc/engine/command/blsave.ame

@@ -0,0 +1,3 @@
+@summary{
+    Write the current lights to a DED file.
+}

doomsday/doc/engine/command/blunlock.ame

@@ -0,0 +1,3 @@
+@summary{
+    Unlock current/specified light.
+}

doomsday/doc/engine/command/chat.ame

@@ -0,0 +1,3 @@
+@summary{
+    Broadcast a chat message.
+}

doomsday/doc/engine/command/chatnum.ame

@@ -0,0 +1,3 @@
+@summary{
+    Send a chat message to the specified player.
+}

doomsday/doc/engine/command/chatto.ame

@@ -0,0 +1,3 @@
+@summary{
+    Send a chat message to the specified player.
+}

doomsday/doc/engine/command/clear.ame

@@ -0,0 +1,3 @@
+@summary{
+    Clear the console buffer.
+}

doomsday/doc/engine/command/clearbinds.ame

@@ -0,0 +1,3 @@
+@summary{
+    Deletes all existing bindings.
+}

doomsday/doc/engine/command/conclose.ame

@@ -0,0 +1,3 @@
+@summary{
+    Close the console prompt.
+}

doomsday/doc/engine/command/conlocp.ame

@@ -0,0 +1,6 @@
+@summary{
+    Connect a local player.
+}
+@description{
+    Params: conlocp (playernum)\nFor example, 'conlocp 1'.
+}

doomsday/doc/engine/command/connect.ame

@@ -0,0 +1,3 @@
+@summary{
+    Connect to a server using TCP/IP.
+}

doomsday/doc/engine/command/conopen.ame

@@ -0,0 +1,3 @@
+@summary{
+    Open the console prompt.
+}

doomsday/doc/engine/command/contoggle.ame

@@ -0,0 +1,3 @@
+@summary{
+    Open/close the console prompt.
+}

doomsday/doc/engine/command/dec.ame

@@ -0,0 +1,3 @@
+@summary{
+    Subtract 1 from a cvar.
+}

doomsday/doc/engine/command/delbind.ame

@@ -0,0 +1,3 @@
+@summary{
+    Deletes all bindings to the given console command.
+}

doomsday/doc/engine/command/demolump.ame

@@ -0,0 +1,6 @@
+@summary{
+    Write a reference lump file for a demo.
+}
+@description{
+    Params: demolump (demofile) (lumpfile)\nFor example, 'demolump demo1.dmo DEMO1'.
+}

doomsday/doc/engine/command/dir.ame

@@ -0,0 +1,6 @@
+@summary{
+    Print contents of directories.
+}
+@description{
+    Params: dir (dirs) ...\nFor example, 'dir data/'.\nVirtual files are listed, too.\nPaths are relative to the base path.
+}

doomsday/doc/engine/command/dump.ame

@@ -0,0 +1,6 @@
+@summary{
+    Dump a data lump currently loaded in memory.
+}
+@description{
+    Params: dump (name)\nFor example, 'dump PLAYPAL'.
+}

doomsday/doc/engine/command/dumpkeymap.ame

@@ -0,0 +1,6 @@
+@summary{
+    Write the current keymap to a file.
+}
+@description{
+    Params: dumpkeymap (file)\nFor example, 'dumpkeymap finnish.dkm'.
+}

doomsday/doc/engine/command/echo.ame

@@ -0,0 +1,6 @@
+@summary{
+    Echo the parameters on separate lines.
+}
+@description{
+    Params: echo (cmd) ...\nFor example, 'echo "hello world"'.
+}

doomsday/doc/engine/command/exec.ame

@@ -0,0 +1,6 @@
+@summary{
+    Loads and executes a file containing console commands.
+}
+@description{
+    Params: exec (file) ...\nFor example, 'exec "myconfig.cfg"'.
+}

doomsday/doc/engine/command/flareconfig.ame

@@ -0,0 +1,3 @@
+@summary{
+    Configure lens flares.
+}

doomsday/doc/engine/command/fog.ame

@@ -0,0 +1,3 @@
+@summary{
+    Modify fog settings.
+}

doomsday/doc/engine/command/font.ame

@@ -0,0 +1,3 @@
+@summary{
+    Modify console font settings.
+}

doomsday/doc/engine/command/help.ame

@@ -0,0 +1,3 @@
+@summary{
+    Show information about the console.
+}

doomsday/doc/engine/command/if.ame

@@ -0,0 +1,3 @@
+@summary{
+    Execute a command if the condition is true.
+}

doomsday/doc/engine/command/inc.ame

@@ -0,0 +1,3 @@
+@summary{
+    Add 1 to a cvar.
+}

doomsday/doc/engine/command/inspectmaterial.ame

@@ -0,0 +1,6 @@
+@summary{
+    Print extended information about a Material to the console.
+}
+@description{
+    Params: inspectmaterial (uri)\nFor example, 'inspectmaterial flats:fwater1'.
+}

doomsday/doc/engine/command/inspecttexture.ame

@@ -0,0 +1,6 @@
+@summary{
+    Print extended information about a Texture to the console.
+}
+@description{
+    Params: inspecttexture (uri)\nFor example, 'inspecttexture flats:fwater1'.
+}

doomsday/doc/engine/command/keymap.ame

@@ -0,0 +1,6 @@
+@summary{
+    Load a DKM keymap file.
+}
+@description{
+    Params: keymap (dkm-file)\nFor example, 'keymap finnish'.
+}

doomsday/doc/engine/command/kick.ame

@@ -0,0 +1,6 @@
+@summary{
+    Kick client out of the game (server only).
+}
+@description{
+    Params: kick (playernum)\nFor example, 'kick 1'.
+}

doomsday/doc/engine/command/lastupdated.ame

@@ -0,0 +1,3 @@
+@summary{
+    Show when the latest check for updates was made.
+}

doomsday/doc/engine/command/listaliases.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all aliases and their expanded forms.
+}

doomsday/doc/engine/command/listbindclasses.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all event binding classes.
+}

doomsday/doc/engine/command/listbindings.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all event bindings.
+}

doomsday/doc/engine/command/listcmds.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all console commands.
+}

doomsday/doc/engine/command/listcontrols.ame

@@ -0,0 +1,3 @@
+@summary{
+    List the names of all player controls.
+}

doomsday/doc/engine/command/listfiles.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all loaded resource files.
+}

doomsday/doc/engine/command/listfonts.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all known fonts.
+}

doomsday/doc/engine/command/listgames.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all games.
+}

doomsday/doc/engine/command/listinputdevices.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all currently active input devices and their controls.
+}

doomsday/doc/engine/command/listlumps.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all loaded virtual resource files from container archives.
+}

doomsday/doc/engine/command/listmaterials.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all known surface materials.
+}

doomsday/doc/engine/command/listmobjtypes.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all known mobj types.
+}

doomsday/doc/engine/command/listtextures.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all known textures.
+}

doomsday/doc/engine/command/listvars.ame

@@ -0,0 +1,3 @@
+@summary{
+    List all console variables and their values.
+}

doomsday/doc/engine/command/load.ame

@@ -0,0 +1,6 @@
+@summary{
+    Load a complete game or one or more data files (e.g., a WAD or a lump).
+}
+@description{
+    Params: load (name) ...\nFor example, 'load (gamename)' or 'load mylevel.wad'.
+}

doomsday/doc/engine/command/login.ame

@@ -0,0 +1,3 @@
+@summary{
+    Log in to server console.
+}

doomsday/doc/engine/command/logout.ame

@@ -0,0 +1,3 @@
+@summary{
+    Terminate remote connection to server console.
+}

doomsday/doc/engine/command/lowres.ame

@@ -0,0 +1,3 @@
+@summary{
+    Select the poorest rendering quality.
+}

doomsday/doc/engine/command/ls.ame

@@ -0,0 +1,6 @@
+@summary{
+    Print contents of directories.
+}
+@description{
+    Params: ls (dirs) ...\nFor example, 'ls data/'.\nVirtual files are listed, too.\nPaths are relative to the base path.
+}