# 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` = ['co', 'con', 'conn']
  `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': 'co con conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' co con conn', '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', 'no_prefix': ' cre cr', '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', 'no_prefix': ' q qu', '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` = ['l', 'look']
  `locks` = 'cmd:all()'
  `func`()

    Show the connect screen.

  `help_category` = 'general'
  `lock_storage` = 'cmd:all()'
  `search_index_entry` = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', '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', 'no_prefix': ' h ?', '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 '}

class `evennia.commands.default.unloggedin.``CmdUnconnectedEncoding`(**kwargs)

  Bases: `evennia.commands.default.muxcommand.MuxCommand`

  set which text encoding to use in unconnected-in state

  Usage:

    encoding/switches [<encoding>]

  Switches:

    clear - clear your custom encoding

  This sets the text encoding for communicating with Evennia. This is mostly an issue only if you want to use non-ASCII characters (i.e. letters/symbols not found in English). If you see that your characters look strange (or you get encoding errors), you should use this command to set the server encoding to be the same used in your client program.

  Common encodings are utf-8 (default), latin-1, ISO-8859-1 etc.

  If you don’t submit an encoding, the current encoding will be displayed instead.

  `key` = 'encoding'
  `aliases` = ['encode']
  `locks` = 'cmd:all()'
  `func`()

    Sets the encoding.

  `help_category` = 'general'
  `lock_storage` = 'cmd:all()'
  `search_index_entry` = {'aliases': 'encode', 'category': 'general', 'key': 'encoding', 'no_prefix': ' encode', 'tags': '', 'text': "\n set which text encoding to use in unconnected-in state\n\n Usage:\n encoding/switches [<encoding>]\n\n Switches:\n clear - clear your custom encoding\n\n\n This sets the text encoding for communicating with Evennia. This is mostly\n an issue only if you want to use non-ASCII characters (i.e. letters/symbols\n not found in English). If you see that your characters look strange (or you\n get encoding errors), you should use this command to set the server\n encoding to be the same used in your client program.\n\n Common encodings are utf-8 (default), latin-1, ISO-8859-1 etc.\n\n If you don't submit an encoding, the current encoding will be displayed\n instead.\n "}

class `evennia.commands.default.unloggedin.``CmdUnconnectedInfo`(**kwargs)

  Bases: `evennia.commands.default.muxcommand.MuxCommand`

  Provides MUDINFO output, so that Evennia games can be added to Mudconnector and Mudstats. Sadly, the MUDINFO specification seems to have dropped off the face of the net, but it is still used by some crawlers. This implementation was created by looking at the MUDINFO implementation in MUX2, TinyMUSH, Rhost, and PennMUSH.

  `key` = 'info'
  `locks` = 'cmd:all()'
  `func`()

    This is the hook function that actually does all the work. It is called by the cmdhandler right after self.parser() finishes, and so has access to all the variables defined therein.

  `aliases` = []
  `help_category` = 'general'
  `lock_storage` = 'cmd:all()'
  `search_index_entry` = {'aliases': '', 'category': 'general', 'key': 'info', 'no_prefix': ' ', 'tags': '', 'text': '\n Provides MUDINFO output, so that Evennia games can be added to Mudconnector\n and Mudstats. Sadly, the MUDINFO specification seems to have dropped off the\n face of the net, but it is still used by some crawlers. This implementation\n was created by looking at the MUDINFO implementation in MUX2, TinyMUSH, Rhost,\n and PennMUSH.\n '}

class `evennia.commands.default.unloggedin.``CmdUnconnectedScreenreader`(**kwargs)

  Bases: `evennia.commands.default.muxcommand.MuxCommand`

  Activate screenreader mode.

  Usage:

    screenreader

  Used to flip screenreader mode on and off before logging in (when logged in, use option screenreader on).

  `key` = 'screenreader'
  `func`()

    Flips screenreader setting.

  `aliases` = []
  `help_category` = 'general'
  `lock_storage` = 'cmd:all();'
  `search_index_entry` = {'aliases': '', 'category': 'general', 'key': 'screenreader', 'no_prefix': ' ', 'tags': '', 'text': '\n Activate screenreader mode.\n\n Usage:\n screenreader\n\n Used to flip screenreader mode on and off before logging in (when\n logged in, use option screenreader on).\n '}