Skip to content

Commit

Permalink
Documentation: Updated console variable help, fixed generator script
Browse files Browse the repository at this point in the history
The script was still using the old location of net.dengine.base.pack.
  • Loading branch information
skyjake committed Jun 6, 2015
1 parent a738152 commit 9853e9a
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 19 deletions.
36 changes: 29 additions & 7 deletions doomsday/apps/plugins/doom/data/conhelp.txt
Expand Up @@ -38,6 +38,10 @@ desc = Show the Help screens.
[kill]
desc = Kill all the monsters on the map.

[leavemap]
desc = Leave the current map and load the next according to the map progression of the current episode.
inf = USAGE:\nleavemap [(exit)]\nIf (exit) is specified, an exit by this name will be searched for in the defined map progression for the current episode, rather than the default exit; "next".

[loadgame]
desc = Load a game-save or open the load menu.
inf = Params: loadgame (game-save-name|<keyword>|save-slot-num) (confirm)\nKeywords: last, quick\nExamples:\nOpen load menu: 'loadgame'\nLoading named game: 'loadgame "running low on ammo"'\nLoading current "quick" slot, confirmed: 'loadgame quick confirm'\nLoading slot #0: 'loadgame 0'
Expand Down Expand Up @@ -166,9 +170,6 @@ desc = Gives you weapons, ammo, power-ups, etc.
[god]
desc = God mode (cheat).

[leavemap]
desc = Leave the current map.

[setclass]
desc = Set player class.

Expand Down Expand Up @@ -646,11 +647,14 @@ desc = 1=Allow cheating in multiplayer games (god, noclip, give).
[server-game-deathmatch]
desc = 1=Start multiplayer games as deathmatch.

[server-game-episode]
desc = Identifier of the episode to be played in a multiplayer game.

[server-game-jump]
desc = 1=Allow jumping in multiplayer games.

[server-game-map]
desc = Map to use in multiplayer games.
desc = Identifier of the map to be played in a multiplayer game.

[server-game-mapcycle-noexit]
desc = 1=Disable exit buttons during map rotation.
Expand Down Expand Up @@ -694,9 +698,27 @@ desc = Rotation angle for the crosshair [0..1] (1=360 degrees).
[view-cross-b]
desc = Crosshair color blue component.

[view-cross-dead-b]
desc = Crosshair color blue component at no health (dead).

[view-cross-dead-g]
desc = Crosshair color green component at no health (dead).

[view-cross-dead-r]
desc = Crosshair color red component at no health (dead).

[view-cross-g]
desc = Crosshair color green component.

[view-cross-live-b]
desc = Crosshair color blue component at full health.

[view-cross-live-g]
desc = Crosshair color green component at full health.

[view-cross-live-r]
desc = Crosshair color red component at full health.

[view-cross-r]
desc = Crosshair color red component.

Expand All @@ -709,6 +731,9 @@ desc = The current crosshair.
[view-cross-vitality]
desc = Color the crosshair according to how near you are to death.

[view-cross-weight]
desc = Crosshair line weight

[view-filter-strength]
desc = Strength of view filter.

Expand Down Expand Up @@ -925,9 +950,6 @@ desc = 1=Respawn items in co-op games.
[server-game-deathmatch-killmsg]
desc = 1=Announce frags in deathmatch.

[server-game-episode]
desc = Episode to use in multiplayer games.

[server-game-nobfg]
desc = 1=Disable BFG9000 in all netgames.

Expand Down
33 changes: 29 additions & 4 deletions doomsday/apps/plugins/heretic/data/conhelp.txt
Expand Up @@ -38,6 +38,10 @@ desc = Show the Help screens.
[kill]
desc = Kill all the monsters on the map.

[leavemap]
desc = Leave the current map and load the next according to the map progression of the current episode.
inf = USAGE:\nleavemap [(exit)]\nIf (exit) is specified, an exit by this name will be searched for in the defined map progression for the current episode, rather than the default exit; "next".

[loadgame]
desc = Load a game-save or open the load menu.
inf = Params: loadgame (game-save-name|<keyword>|save-slot-num) (confirm)\nKeywords: last, quick\nExamples:\nOpen load menu: 'loadgame'\nLoading named game: 'loadgame "running low on ammo"'\nLoading current "quick" slot, confirmed: 'loadgame quick confirm'\nLoading slot #0: 'loadgame 0'
Expand Down Expand Up @@ -163,9 +167,6 @@ inf = Params: cheat (cheat)\nFor example, 'cheat rambo'.
[chicken]
desc = Turn yourself into a chicken. Go ahead.

[exitmap]
desc = Exit the current map.

[give]
desc = Cheat command to give you various kinds of things.

Expand Down Expand Up @@ -649,11 +650,14 @@ desc = 1=Allow cheating in multiplayer games (god, noclip, give).
[server-game-deathmatch]
desc = 1=Start multiplayer games as deathmatch.

[server-game-episode]
desc = Identifier of the episode to be played in a multiplayer game.

[server-game-jump]
desc = 1=Allow jumping in multiplayer games.

[server-game-map]
desc = Map to use in multiplayer games.
desc = Identifier of the map to be played in a multiplayer game.

[server-game-mapcycle-noexit]
desc = 1=Disable exit buttons during map rotation.
Expand Down Expand Up @@ -697,9 +701,27 @@ desc = Rotation angle for the crosshair [0..1] (1=360 degrees).
[view-cross-b]
desc = Crosshair color blue component.

[view-cross-dead-b]
desc = Crosshair color blue component at no health (dead).

[view-cross-dead-g]
desc = Crosshair color green component at no health (dead).

[view-cross-dead-r]
desc = Crosshair color red component at no health (dead).

[view-cross-g]
desc = Crosshair color green component.

[view-cross-live-b]
desc = Crosshair color blue component at full health.

[view-cross-live-g]
desc = Crosshair color green component at full health.

[view-cross-live-r]
desc = Crosshair color red component at full health.

[view-cross-r]
desc = Crosshair color red component.

Expand All @@ -712,6 +734,9 @@ desc = The current crosshair.
[view-cross-vitality]
desc = Color the crosshair according to how near you are to death.

[view-cross-weight]
desc = Crosshair line weight

[view-filter-strength]
desc = Strength of view filter.

Expand Down
36 changes: 32 additions & 4 deletions doomsday/apps/plugins/hexen/data/conhelp.txt
Expand Up @@ -38,6 +38,10 @@ desc = Show the Help screens.
[kill]
desc = Kill all the monsters on the map.

[leavemap]
desc = Leave the current map and load the next according to the map progression of the current episode.
inf = USAGE:\nleavemap [(exit)]\nIf (exit) is specified, an exit by this name will be searched for in the defined map progression for the current episode, rather than the default exit; "next".

[loadgame]
desc = Load a game-save or open the load menu.
inf = Params: loadgame (game-save-name|<keyword>|save-slot-num) (confirm)\nKeywords: last, quick\nExamples:\nOpen load menu: 'loadgame'\nLoading named game: 'loadgame "running low on ammo"'\nLoading current "quick" slot, confirmed: 'loadgame quick confirm'\nLoading slot #0: 'loadgame 0'
Expand Down Expand Up @@ -425,6 +429,9 @@ desc = Door glow thickness in the automap (with map-door-colors).
[map-episode]
desc = Current episode id.

[map-hub]
desc = Current hub id.

[map-huddisplay]
desc = 0=No HUD when in the automap 1=Current HUD display shown when in the automap 2=Always show Status Bar when in the automap

Expand Down Expand Up @@ -659,11 +666,14 @@ desc = 1=Allow cheating in multiplayer games (god, noclip, give).
[server-game-deathmatch]
desc = 1=Start multiplayer games as deathmatch.

[server-game-episode]
desc = Identifier of the episode to be played in a multiplayer game.

[server-game-jump]
desc = 1=Allow jumping in multiplayer games.

[server-game-map]
desc = Map to use in multiplayer games.
desc = Identifier of the map to be played in a multiplayer game.

[server-game-mapcycle-noexit]
desc = 1=Disable exit buttons during map rotation.
Expand Down Expand Up @@ -707,9 +717,27 @@ desc = Rotation angle for the crosshair [0..1] (1=360 degrees).
[view-cross-b]
desc = Crosshair color blue component.

[view-cross-dead-b]
desc = Crosshair color blue component at no health (dead).

[view-cross-dead-g]
desc = Crosshair color green component at no health (dead).

[view-cross-dead-r]
desc = Crosshair color red component at no health (dead).

[view-cross-g]
desc = Crosshair color green component.

[view-cross-live-b]
desc = Crosshair color blue component at full health.

[view-cross-live-g]
desc = Crosshair color green component at full health.

[view-cross-live-r]
desc = Crosshair color red component at full health.

[view-cross-r]
desc = Crosshair color red component.

Expand All @@ -722,6 +750,9 @@ desc = The current crosshair.
[view-cross-vitality]
desc = Color the crosshair according to how near you are to death.

[view-cross-weight]
desc = Crosshair line weight

[view-filter-strength]
desc = Strength of view filter.

Expand Down Expand Up @@ -770,9 +801,6 @@ desc = Show mana when the status bar is hidden. 1=top, 2=bottom, 0=off
[hud-unhide-pickup-invitem]
desc = 1=Unhide the HUD when player collects an inventory item.

[map-hub]
desc = Current hub id.

[msg-hub-override]
desc = Override the transition hub message.

Expand Down
8 changes: 4 additions & 4 deletions doomsday/build/scripts/makehelp.py
Expand Up @@ -11,7 +11,7 @@
os.chdir(os.path.join(dengRoot, 'doc'))

print "Engine help"
cpHelpTxt = os.path.join(dengRoot, 'net.dengine.base.pack', 'helpstrings.txt')
cpHelpTxt = os.path.join(dengRoot, 'apps', 'libdoomsday', 'net.dengine.base.pack', 'helpstrings.txt')
conhelp.makeHelp(cpHelpTxt, ['engine'])

panel = conhelp.amethyst(file(os.path.join('engine', 'controlpanel.ame')).read())
Expand All @@ -20,15 +20,15 @@

print "libdoom help"
conhelp.makeHelp(
os.path.join(dengRoot, 'plugins', 'doom', 'data', 'conhelp.txt'),
os.path.join(dengRoot, 'apps', 'plugins', 'doom', 'data', 'conhelp.txt'),
['libcommon', 'libdoom'])

print "libheretic help"
conhelp.makeHelp(
os.path.join(dengRoot, 'plugins', 'heretic', 'data', 'conhelp.txt'),
os.path.join(dengRoot, 'apps', 'plugins', 'heretic', 'data', 'conhelp.txt'),
['libcommon', 'libheretic'])

print "libhexen help"
conhelp.makeHelp(
os.path.join(dengRoot, 'plugins', 'hexen', 'data', 'conhelp.txt'),
os.path.join(dengRoot, 'apps', 'plugins', 'hexen', 'data', 'conhelp.txt'),
['libcommon', 'libhexen'])

0 comments on commit 9853e9a

Please sign in to comment.