evennia.commands.default.unloggedin

Commands that are available from the connect screen.

class evennia.commands.default.unloggedin.CmdUnconnectedConnect(**kwargs)

Bases: evennia.commands.default.muxcommand.MuxCommand

connect to the game

Usage (at login screen):

connect accountname password connect “account name” “pass word”

Use the create command to first create an account before logging in.

If you have spaces in your name, enclose it in double quotes.

key = 'connect'

aliases = ['conn', 'co', 'con']

locks = 'cmd:all()'

arg_regex = re.compile('\\s.*?|$', re.IGNORECASE)

func()

Uses the Django admin api. Note that unlogged-in commands have a unique position in that their func() receives a session object instead of a source_object like all other types of logged-in commands (this is because there is no object yet before the account has logged in)

help_category = 'general'

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}

class evennia.commands.default.unloggedin.CmdUnconnectedCreate(**kwargs)

Bases: evennia.commands.default.muxcommand.MuxCommand

create a new account account

Usage (at login screen):

create <accountname> <password> create “account name” “pass word”

This creates a new account account.

If you have spaces in your name, enclose it in double quotes.

key = 'create'

aliases = ['cre', 'cr']

locks = 'cmd:all()'

arg_regex = re.compile('\\s.*?|$', re.IGNORECASE)

func()

Do checks and create account

help_category = 'general'

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname> <password>\n create "account name" "pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}

class evennia.commands.default.unloggedin.CmdUnconnectedQuit(**kwargs)

Bases: evennia.commands.default.muxcommand.MuxCommand

quit when in unlogged-in state

Usage:

quit

We maintain a different version of the quit command here for unconnected accounts for the sake of simplicity. The logged in version is a bit more complicated.

key = 'quit'

aliases = ['q', 'qu']

locks = 'cmd:all()'

func()

Simply close the connection.

help_category = 'general'

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}

class evennia.commands.default.unloggedin.CmdUnconnectedLook(**kwargs)

Bases: evennia.commands.default.muxcommand.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. All it does is display the connect screen.

key = '__unloggedin_look_command'

aliases = ['look', 'l']

locks = 'cmd:all()'

func()

Show the connect screen.

help_category = 'general'

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}

class evennia.commands.default.unloggedin.CmdUnconnectedHelp(**kwargs)

Bases: evennia.commands.default.muxcommand.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.

key = 'help'

aliases = ['?', 'h']

locks = 'cmd:all()'

func()

Shows help

help_category = 'general'

lock_storage = 'cmd:all()'

search_index_entry = {'aliases': '? h', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}