@Sparks said in Coming Soon: Arx, After the Reckoning:
Specifically, Evennia generates a lot of the documentation automatically for each command; in a lot of ways, this is great; you include the documentation in the command source code, and a helpfile is made for it. No worries about documentation being out-of-date; you edit the command, you edit the description RIGHT THERE. I wish more things supported this.
Thanks, the auto-help system is helped a lot by me myself always writing documentation whenever I write code - so me documenting my commands and then immediately converting that to an in-game help entry alleviates duplicate work. Many Evennia devs have taken up on this premise. While it doesn't write the docs for you, it at least makes it more likely that your code actually does what the help file says. It's certainly true that this may well lead to "dev-written help" though. While developer and staffer is often the same, that is something each Evennia game needs to consider.
But conversely, if you alias a command to another command then 'help' for both commands will give you the same help text; this leads to the home/+home, time/@time versus guards/@guards/+guards situation you describe. And additionally, since the coder is writing the documentation right there in the command, you... well, are getting coder-written documentation. Which (as a coder) I must admit is not always the ideal; sometimes you want an editing pass by someone who doesn't think in terms of code. 
If you just alias one command to another (that is, create a command @alias
with aliases +alias
and alias
), then they will get the same auto-help (since they are all actually just the same Command). My impression from the original question was however that there are multiple different Commands, each with a (slightly) different key - that means they are completely separate Commands and thus each get their own auto-help. How a game organizes their commands is up to them.
(That said, I object on general design principle to having command, +command, and @command do different things.)
Evennia itself is guilty of this in a few cases in its default command set (@desc
/desc
is the one that comes to mind), but our convention is that the @
is then the more capable builder-only version. This duplicity (in the default command set at least) is going away in Evennia 0.7 when we start allowing the developer to specify which prefixes (@
, +
, &
, ...) Evennia will simply ignore (making @desc
and desc
effectively the same command even without an alias).
.
Griatch