Fixed command auto-help strings to make it look better in the cmdhelp wiki page

This commit is contained in:
Griatch 2014-02-12 15:05:17 +01:00
parent ee269d13cf
commit bc8ce9f394
10 changed files with 108 additions and 94 deletions

View file

@ -7,10 +7,9 @@ Admin commands
import time
import re
from django.conf import settings
from django.contrib.auth.models import User
from src.server.sessionhandler import SESSIONS
from src.server.models import ServerConfig
from src.utils import utils, prettytable, search
from src.utils import prettytable, search
from src.commands.default.muxcommand import MuxCommand
PERMISSION_HIERARCHY = [p.lower() for p in settings.PERMISSION_HIERARCHY]
@ -22,7 +21,7 @@ __all__ = ("CmdBoot", "CmdBan", "CmdUnban", "CmdDelPlayer",
class CmdBoot(MuxCommand):
"""
@boot
kick a player from the server.
Usage
@boot[/switches] <player obj> [: reason]
@ -210,7 +209,7 @@ class CmdBan(MuxCommand):
class CmdUnban(MuxCommand):
"""
remove a ban
remove a ban from a player
Usage:
@unban <banid>
@ -255,7 +254,7 @@ class CmdUnban(MuxCommand):
class CmdDelPlayer(MuxCommand):
"""
delplayer - delete player from server
delete a player from the server
Usage:
@delplayer[/switch] <name> [: reason]
@ -325,7 +324,7 @@ class CmdDelPlayer(MuxCommand):
class CmdEmit(MuxCommand):
"""
@emit
admin command for emitting message to multiple objects
Usage:
@emit[/switches] [<obj>, <obj>, ... =] <message>
@ -404,7 +403,7 @@ class CmdEmit(MuxCommand):
class CmdNewPassword(MuxCommand):
"""
@userpassword
change the password of a player
Usage:
@userpassword <user obj> = <new password>
@ -439,7 +438,7 @@ class CmdNewPassword(MuxCommand):
class CmdPerm(MuxCommand):
"""
@perm - set permissions
set the permissions of a player/object
Usage:
@perm[/switch] <object> [= <permission>[,<permission>,...]]
@ -539,7 +538,7 @@ class CmdPerm(MuxCommand):
class CmdWall(MuxCommand):
"""
@wall
make an announcement to all
Usage:
@wall <message>

View file

@ -216,7 +216,7 @@ def purge_processor(caller):
class CmdBatchCommands(MuxCommand):
"""
Build from batch-command file
build from batch-command file
Usage:
@batchcommands[/interactive] <python.path.to.file>
@ -317,7 +317,7 @@ class CmdBatchCommands(MuxCommand):
class CmdBatchCode(MuxCommand):
"""
Build from batch-code file
build from batch-code file
Usage:
@batchcode[/interactive] <python path to file>

View file

@ -90,7 +90,7 @@ class ObjManipCommand(MuxCommand):
class CmdSetObjAlias(MuxCommand):
"""
Adding permanent aliases
adding permanent aliases for object
Usage:
@alias <obj> [= [alias[,alias,alias,...]]]
@ -162,7 +162,7 @@ class CmdSetObjAlias(MuxCommand):
class CmdCopy(ObjManipCommand):
"""
@copy - copy objects
copy an object and its properties
Usage:
@copy[/reset] <original obj> [= new_name][;alias;alias..][:new_location] [,new_name2 ...]
@ -236,7 +236,7 @@ class CmdCopy(ObjManipCommand):
class CmdCpAttr(ObjManipCommand):
"""
@cpattr - copy attributes
copy attributes between objects
Usage:
@cpattr[/switch] <obj>/<attr> = <obj1>/<attr1> [,<obj2>/<attr2>,<obj3>/<attr3>,...]
@ -336,7 +336,7 @@ class CmdCpAttr(ObjManipCommand):
class CmdMvAttr(ObjManipCommand):
"""
@mvattr - move attributes
move attributes between objects
Usage:
@mvattr[/switch] <obj>/<attr> = <obj1>/<attr1> [,<obj2>/<attr2>,<obj3>/<attr3>,...]
@ -376,7 +376,7 @@ class CmdMvAttr(ObjManipCommand):
class CmdCreate(ObjManipCommand):
"""
@create - create new objects
create new objects
Usage:
@create[/drop] objname[;alias;alias...][:typeclass], objname...
@ -448,7 +448,7 @@ class CmdCreate(ObjManipCommand):
class CmdDesc(MuxCommand):
"""
@desc - describe an object or room
describe an object
Usage:
@desc [<obj> =] >description>
@ -486,7 +486,7 @@ class CmdDesc(MuxCommand):
class CmdDestroy(MuxCommand):
"""
@destroy - remove objects from the game
permanently delete objects
Usage:
@destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]
@ -566,7 +566,7 @@ class CmdDestroy(MuxCommand):
class CmdDig(ObjManipCommand):
"""
@dig - build and connect new rooms to the current one
build new rooms and connect them to the current location
Usage:
@dig[/switches] roomname[;alias;alias...][:typeclass]
@ -701,7 +701,7 @@ class CmdDig(ObjManipCommand):
class CmdTunnel(MuxCommand):
"""
dig in often-used directions
create new rooms in cardinal directions only
Usage:
@tunnel[/switch] <direction> [= roomname[;alias;alias;...][:typeclass]]
@ -781,7 +781,7 @@ class CmdTunnel(MuxCommand):
class CmdLink(MuxCommand):
"""
@link - connect objects
link existing rooms together with exits
Usage:
@link[/switches] <object> = <target>
@ -868,7 +868,7 @@ class CmdLink(MuxCommand):
class CmdUnLink(CmdLink):
"""
@unlink - unconnect objects
remove exit-connections between rooms
Usage:
@unlink <Object>
@ -903,7 +903,7 @@ class CmdUnLink(CmdLink):
class CmdSetHome(CmdLink):
"""
@home - control an object's home location
set an object's home location
Usage:
@home <obj> [= home_location]
@ -955,7 +955,7 @@ class CmdSetHome(CmdLink):
class CmdListCmdSets(MuxCommand):
"""
list command sets on an object
list command sets defined on an object
Usage:
@cmdsets [obj]
@ -984,7 +984,7 @@ class CmdListCmdSets(MuxCommand):
class CmdName(ObjManipCommand):
"""
cname - change the name and/or aliases of an object
change the name and/or aliases of an object
Usage:
@name obj = name;alias1;alias2
@ -1036,7 +1036,7 @@ class CmdName(ObjManipCommand):
class CmdOpen(ObjManipCommand):
"""
@open - create new exit
open a new exit from the current room
Usage:
@open <new exit>[;alias;alias..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] = <destination>
@ -1167,7 +1167,7 @@ class CmdOpen(ObjManipCommand):
class CmdSetAttribute(ObjManipCommand):
"""
@set - set attributes
set attribute on an object or player
Usage:
@set <obj>/<attr> = <value>
@ -1329,7 +1329,7 @@ class CmdSetAttribute(ObjManipCommand):
class CmdTypeclass(MuxCommand):
"""
@typeclass - set object typeclass
set or change an object's typeclass
Usage:
@typclass[/switch] <object> [= <typeclass.path>]
@ -1430,7 +1430,7 @@ class CmdTypeclass(MuxCommand):
class CmdWipe(ObjManipCommand):
"""
@wipe - clears attributes
clear all attributes from an object
Usage:
@wipe <object>[/attribute[/attribute...]]
@ -1482,7 +1482,7 @@ class CmdWipe(ObjManipCommand):
class CmdLock(ObjManipCommand):
"""
lock - assign a lock definition to an object
assign a lock definition to an object
Usage:
@lock <object>[ = <lockstring>]
@ -1566,7 +1566,7 @@ class CmdLock(ObjManipCommand):
class CmdExamine(ObjManipCommand):
"""
examine - detailed info on objects
get detailed information about an object
Usage:
examine [<object>[/attrname]]
@ -1819,7 +1819,7 @@ class CmdExamine(ObjManipCommand):
class CmdFind(MuxCommand):
"""
find objects
search the database for objects
Usage:
@find[/switches] <name or dbref or *player> [= dbrefmin[-dbrefmax]]
@ -2030,7 +2030,7 @@ class CmdTeleport(MuxCommand):
class CmdScript(MuxCommand):
"""
attach scripts
attach a script to an object
Usage:
@script[/switch] <obj> [= <script.path or scriptkey>]
@ -2122,7 +2122,7 @@ class CmdScript(MuxCommand):
class CmdTag(MuxCommand):
"""
handles tagging
handles the tags of an object
Usage:
@tag[/del] <obj> [= <tag>[:<category>]]

View file

@ -48,7 +48,7 @@ def find_channel(caller, channelname, silent=False, noaliases=False):
class CmdAddCom(MuxPlayerCommand):
"""
addcom - subscribe to a channel with optional alias
add a channel alias and/or subscribe to a channel
Usage:
addcom [alias=] <channel>
@ -117,7 +117,7 @@ class CmdAddCom(MuxPlayerCommand):
class CmdDelCom(MuxPlayerCommand):
"""
delcom - unsubscribe from channel or remove channel alias
remove a channel alias and/or unsubscribe from channel
Usage:
delcom <alias or channel>
@ -174,7 +174,7 @@ class CmdDelCom(MuxPlayerCommand):
class CmdAllCom(MuxPlayerCommand):
"""
allcom - operate on all channels
perform admin operations on all channels
Usage:
allcom [on | off | who | destroy]
@ -240,7 +240,7 @@ class CmdAllCom(MuxPlayerCommand):
class CmdChannels(MuxPlayerCommand):
"""
@clist
list all channels available to you
Usage:
@channels
@ -309,7 +309,7 @@ class CmdChannels(MuxPlayerCommand):
class CmdCdestroy(MuxPlayerCommand):
"""
@cdestroy
destroy a channel you created
Usage:
@cdestroy <channel>
@ -346,7 +346,7 @@ class CmdCdestroy(MuxPlayerCommand):
class CmdCBoot(MuxPlayerCommand):
"""
@cboot
kick a player from a channel you control
Usage:
@cboot[/quiet] <channel> = <player> [:reason]
@ -407,7 +407,7 @@ class CmdCBoot(MuxPlayerCommand):
class CmdCemit(MuxPlayerCommand):
"""
@cemit - send a message to channel
send an admin message to a channel you control
Usage:
@cemit[/switches] <channel> = <message>
@ -455,7 +455,7 @@ class CmdCemit(MuxPlayerCommand):
class CmdCWho(MuxPlayerCommand):
"""
@cwho
show who is listening to a channel
Usage:
@cwho <channel>
@ -493,8 +493,8 @@ class CmdCWho(MuxPlayerCommand):
class CmdChannelCreate(MuxPlayerCommand):
"""
@ccreate
channelcreate
create a new channel
Usage:
@ccreate <new channel>[;alias;alias...] = description
@ -543,7 +543,7 @@ class CmdChannelCreate(MuxPlayerCommand):
class CmdClock(MuxPlayerCommand):
"""
@clock - changes channel access restrictions
change channel locks of a channel you control
Usage:
@clock <channel> [= <lockstring>]
@ -589,7 +589,7 @@ class CmdClock(MuxPlayerCommand):
class CmdCdesc(MuxPlayerCommand):
"""
@cdesc - set channel description
describe a channel you control
Usage:
@cdesc <channel> = <description>
@ -627,7 +627,7 @@ class CmdCdesc(MuxPlayerCommand):
class CmdPage(MuxPlayerCommand):
"""
page - send private message
send a private message to another player
Usage:
page[/switches] [<player>,<player>,... = <message>]
@ -758,7 +758,7 @@ class CmdPage(MuxPlayerCommand):
class CmdIRC2Chan(MuxCommand):
"""
@irc2chan - link evennia channel to an IRC channel
link an evennia channel to an external IRC channel
Usage:
@irc2chan[/switches] <evennia_channel> = <ircnetwork> <port> <#irchannel> <botname>
@ -853,7 +853,7 @@ class CmdIRC2Chan(MuxCommand):
class CmdIMC2Chan(MuxCommand):
"""
imc2chan - link an evennia channel to imc2
link an evennia channel to an external IMC2 channel
Usage:
@imc2chan[/switches] <evennia_channel> = <imc2_channel>
@ -931,7 +931,7 @@ class CmdIMC2Chan(MuxCommand):
class CmdIMCInfo(MuxCommand):
"""
imcinfo - package of imc info commands
get various IMC2 information
Usage:
@imcinfo[/switches]
@ -1031,7 +1031,7 @@ class CmdIMCInfo(MuxCommand):
# unclear if this is working ...
class CmdIMCTell(MuxCommand):
"""
imctell - send a page to a remote IMC player
send a page to a remote IMC player
Usage:
imctell User@MUD = <msg>
@ -1073,7 +1073,7 @@ class CmdIMCTell(MuxCommand):
# RSS connection
class CmdRSS2Chan(MuxCommand):
"""
@rss2chan - link evennia channel to an RSS feed
link an evennia channel to an external RSS feed
Usage:
@rss2chan[/switches] <evennia_channel> = <rss_url>

View file

@ -16,7 +16,7 @@ AT_SEARCH_RESULT = utils.variable_from_module(*settings.SEARCH_AT_RESULT.rsplit(
class CmdHome(MuxCommand):
"""
home
move to your character's home location
Usage:
home
@ -42,7 +42,7 @@ class CmdHome(MuxCommand):
class CmdLook(MuxCommand):
"""
look
look at location or object
Usage:
look
@ -88,7 +88,7 @@ class CmdLook(MuxCommand):
class CmdNick(MuxCommand):
"""
Define a personal alias/nick
define a personal alias/nick
Usage:
nick[/switches] <nickname> = [<string>]
@ -178,7 +178,7 @@ class CmdNick(MuxCommand):
class CmdInventory(MuxCommand):
"""
inventory
view inventory
Usage:
inventory
@ -207,7 +207,7 @@ class CmdInventory(MuxCommand):
class CmdGet(MuxCommand):
"""
get
pick up something
Usage:
get <obj>
@ -257,7 +257,7 @@ class CmdGet(MuxCommand):
class CmdDrop(MuxCommand):
"""
drop
drop something
Usage:
drop <obj>
@ -300,7 +300,7 @@ class CmdDrop(MuxCommand):
class CmdGive(MuxCommand):
"""
give away things
give away something to someone
Usage:
give <inventory obj> = <target>
@ -336,7 +336,7 @@ class CmdGive(MuxCommand):
class CmdSay(MuxCommand):
"""
say
speak as your character
Usage:
say <message>
@ -374,7 +374,7 @@ class CmdSay(MuxCommand):
class CmdPose(MuxCommand):
"""
pose - strike a pose
strike a pose
Usage:
pose <pose text>
@ -417,7 +417,7 @@ class CmdPose(MuxCommand):
class CmdAccess(MuxCommand):
"""
access - show access groups
show your current game access
Usage:
access

View file

@ -62,7 +62,7 @@ def format_help_list(hdict_cmds, hdict_db):
class CmdHelp(Command):
"""
The main help command
view help or a list of topics
Usage:
help <topic or command>
@ -158,7 +158,7 @@ class CmdHelp(Command):
class CmdSetHelp(MuxCommand):
"""
@help - edit the help database
edit the help database
Usage:
@help[/switches] <topic>[,category[,locks]] = <text>

View file

@ -44,7 +44,7 @@ PERMISSION_HIERARCHY_LOWER = [perm.lower() for perm in PERMISSION_HIERARCHY]
class CmdOOCLook(MuxPlayerCommand):
"""
ooc look
look while out-of-character
Usage:
look
@ -151,7 +151,7 @@ class CmdOOCLook(MuxPlayerCommand):
class CmdCharCreate(MuxPlayerCommand):
"""
Create a character
create a new character
Usage:
@charcreate <charname> [= desc]
@ -202,7 +202,7 @@ class CmdCharCreate(MuxPlayerCommand):
class CmdIC(MuxPlayerCommand):
"""
Switch control to an object
control an object you have permission to puppet
Usage:
@ic <character>
@ -272,7 +272,7 @@ class CmdIC(MuxPlayerCommand):
class CmdOOC(MuxPlayerCommand):
"""
go ooc
stop puppeting and go ooc
Usage:
@ooc
@ -311,7 +311,7 @@ class CmdOOC(MuxPlayerCommand):
class CmdSessions(MuxPlayerCommand):
"""
check connected session(s)
check your connected session(s)
Usage:
@sessions
@ -346,7 +346,7 @@ class CmdSessions(MuxPlayerCommand):
class CmdWho(MuxPlayerCommand):
"""
who
list who is currently online
Usage:
who
@ -417,7 +417,7 @@ class CmdWho(MuxPlayerCommand):
class CmdEncoding(MuxPlayerCommand):
"""
encoding - set a custom text encoding
set which text encoding to use
Usage:
@encoding/switches [<encoding>]
@ -478,7 +478,7 @@ class CmdEncoding(MuxPlayerCommand):
class CmdPassword(MuxPlayerCommand):
"""
@password - set your password
change your password
Usage:
@password <old password> = <new password>
@ -509,7 +509,7 @@ class CmdPassword(MuxPlayerCommand):
class CmdQuit(MuxPlayerCommand):
"""
quit
quit the game
Usage:
@quit
@ -546,7 +546,7 @@ class CmdQuit(MuxPlayerCommand):
class CmdColorTest(MuxPlayerCommand):
"""
testing colors
testing which colors your client support
Usage:
@color ansi|xterm256
@ -628,7 +628,7 @@ class CmdColorTest(MuxPlayerCommand):
class CmdQuell(MuxPlayerCommand):
"""
Quelling permissions
use character's permissions instead of player's
Usage:
quell

View file

@ -7,7 +7,6 @@ System commands
import traceback
import os
import datetime
import time
import sys
import django
import twisted
@ -36,7 +35,7 @@ __all__ = ("CmdReload", "CmdReset", "CmdShutdown", "CmdPy",
class CmdReload(MuxCommand):
"""
Reload the system
reload the server
Usage:
@reload [reason]
@ -62,7 +61,7 @@ class CmdReload(MuxCommand):
class CmdReset(MuxCommand):
"""
Reset and reboot the system
reset and reboot the server
Usage:
@reset
@ -88,7 +87,7 @@ class CmdReset(MuxCommand):
class CmdShutdown(MuxCommand):
"""
@shutdown
stop the server completely
Usage:
@shutdown [announcement]
@ -118,7 +117,7 @@ class CmdShutdown(MuxCommand):
class CmdPy(MuxCommand):
"""
Execute a snippet of python code
execute a snippet of python code
Usage:
@py <cmd>
@ -242,7 +241,7 @@ def format_script_list(scripts):
class CmdScripts(MuxCommand):
"""
Operate and list global scripts, list all scrips.
list and manage all running scripts
Usage:
@scripts[/switches] [#dbref, key, script.path or <obj>]
@ -338,7 +337,7 @@ class CmdScripts(MuxCommand):
class CmdObjects(MuxCommand):
"""
@objects - Give a summary of object types in database
statistics on objects in the database
Usage:
@objects [<nr>]
@ -403,7 +402,7 @@ class CmdObjects(MuxCommand):
class CmdPlayers(MuxCommand):
"""
@players - give a summary of all registed Players
list all registered players
Usage:
@players [nr]
@ -447,7 +446,7 @@ class CmdPlayers(MuxCommand):
class CmdService(MuxCommand):
"""
@service - manage services
manage system services
Usage:
@service[/switch] <service>
@ -544,7 +543,7 @@ class CmdService(MuxCommand):
class CmdAbout(MuxCommand):
"""
@about - game engine info
show Evennia info
Usage:
@about
@ -592,12 +591,13 @@ class CmdAbout(MuxCommand):
class CmdTime(MuxCommand):
"""
@time
show server time statistics
Usage:
@time
Server time statistics.
List Server time statistics such as uptime
and the current time stamp.
"""
key = "@time"
aliases = "@uptime"
@ -617,7 +617,7 @@ class CmdTime(MuxCommand):
class CmdServerLoad(MuxCommand):
"""
server load and memory statistics
show server load and memory statistics
Usage:
@serverload

View file

@ -187,7 +187,7 @@ class TestSystem(CommandTest):
# we are not testing CmdReload, CmdReset and CmdShutdown, CmdService or CmdTime
# since the server is not running during these tests.
self.call(system.CmdPy(), "1+2", ">>> 1+2|<<< 3")
self.call(system.CmdScripts(), "", "id ")
self.call(system.CmdScripts(), "", "dbref ")
self.call(system.CmdObjects(), "", "Object subtype totals")
self.call(system.CmdAbout(), "", None)
self.call(system.CmdServerLoad(), "", "Server CPU and Memory load:")
@ -198,10 +198,10 @@ class TestAdmin(CommandTest):
CID = 4
def test_cmds(self):
# not testing CmdBoot, CmdDelPlayer, CmdNewPassword
self.call(admin.CmdEmit(), "Char4b = Test", "Emitted to Char4b.")
self.call(admin.CmdPerm(), "Obj4 = Builders", "Permission 'Builders' given to Obj4.")
self.call(admin.CmdEmit(), "Char4b = Test", "Emitted to Char4b:\nTest")
self.call(admin.CmdPerm(), "Obj4 = Builders", "Permission 'Builders' given to Obj4 (the Object/Character).")
self.call(admin.CmdWall(), "Test", "Announcing to all connected players ...")
self.call(admin.CmdPerm(), "Char4b = Builders","Permission 'Builders' given to Char4b.")
self.call(admin.CmdPerm(), "Char4b = Builders","Permission 'Builders' given to Char4b (the Object/Character).")
self.call(admin.CmdBan(), "Char4", "NameBan char4 was added.")

View file

@ -30,7 +30,7 @@ if not CONNECTION_SCREEN:
class CmdUnconnectedConnect(MuxCommand):
"""
Connect to the game.
connect to the game
Usage (at login screen):
connect playername password
@ -103,7 +103,7 @@ class CmdUnconnectedConnect(MuxCommand):
class CmdUnconnectedCreate(MuxCommand):
"""
Create a new account.
create a new player account
Usage (at login screen):
create <playername> <password>
@ -223,6 +223,11 @@ class CmdUnconnectedCreate(MuxCommand):
class CmdUnconnectedQuit(MuxCommand):
"""
quit when in unlogged-in state
Usage:
quit
We maintain a different version of the quit command
here for unconnected players for the sake of simplicity. The logged in
version is a bit more complicated.
@ -240,6 +245,11 @@ class CmdUnconnectedQuit(MuxCommand):
class CmdUnconnectedLook(MuxCommand):
"""
look when in unlogged-in state
Usage:
look
This is an unconnected version of the look command for simplicity.
This is called by the server and kicks everything in gear.
@ -256,6 +266,11 @@ class CmdUnconnectedLook(MuxCommand):
class CmdUnconnectedHelp(MuxCommand):
"""
get help when in unconnected-in state
Usage:
help
This is an unconnected version of the help command,
for simplicity. It shows a pane of info.
"""