We're currently working on integrating descriptions for vars and commands into both the on-screen help in RE:
And into these wiki pages:
- http://redeclipse.net/wiki/Game_Vars
- http://redeclipse.net/wiki/Engine_Vars
- http://redeclipse.net/wiki/Weapon_Vars
- http://redeclipse.net/wiki/Commands
Since it's a major task, I thought it would be great if the wider community could also submit suggestions for descriptions
To submit descriptions via the forums
- Check here and the wiki that you are not adding a duplicate
- Please follow the format, again see the wiki and the example reply below
- Please use a good clarification for parameters (e.g. <clientnum>) where appropriate
- Please use <value> as a generic description otherwise
Submit your descriptions in a reply to this thread looking something like this:
Hello, here is a variable (and an alias) which I use all the time which does not yet have a description!
- {l Code}: {l Select All Code}
setdesc "firstpersonfov" "determines the size of the field of view in first person mode" "<angle>"
setdesc "fov" "determines the size of the field of view in first or third person mode, depending on the current camera mode" "<angle>"
If you are a wiki editor you may also submit descriptions directly on the wiki.
I will be adding your descriptions continuously to Red Eclipse SVN