Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cleaned up the menu_system.py contrib docstring a little.

Browse source
This commit is contained in:
Griatch 2016-10-18 23:32:32 +02:00
parent d4ee0e487a
commit 8561e3de23
1 changed files with 17 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

38
evennia/contrib/menu_login.py
View file

@ -3,36 +3,32 @@ A login menu using EvMenu.
Contribution - Vincent-lg 2016 Contribution - Vincent-lg 2016
This module defines a simple login system, similar to the one This module contains the functions (nodes) of the EvMenu, with the
defined in 'menu_login.py". This present menu system, however, CmdSet and UnloggedCommand called when a user logs in. In other
uses EvMenu (hence the name). This module contains the words, instead of using the 'connect' or 'create' commands once on the
functions (nodes) of the menu, with the CmdSet and login screen, players navigates through a simple menu asking them to
UnloggedCommand called when a user logs in. In other words, enter their username followed by password, or to type 'new' to create
instead of using the 'connect' or 'create' commands once on the a new one. You will need to change update your login screen if you use
login screen, players have to navigate through a simple menu this system.
asking them to enter their username (then password), or to type
'new' to create one. You may want to update your login screen
if you use this system.
In order to install, to your settings file, add/edit the line: In order to install, to your settings file, add/edit the line:
CMDSET_UNLOGGEDIN = "contrib.menu_login.UnloggedinCmdSet" CMDSET_UNLOGGEDIN = "contrib.menu_login.UnloggedinCmdSet"
When you'll reload the server, new sessions will connect to the When you'll reload the server, new sessions will connect to the new
new login system, where they will be able to: login system, where they will be able to:
* Enter their username, assuming they have an existing player. * Enter their username, assuming they have an existing player.
* Enter 'NEW' to create a new player. * Enter 'NEW' to create a new player.
The top-level functions in this file are menu nodes (as The top-level functions in this file are menu nodes (as described in
described in EvMenu). Each one of these functions is evennia.utils.evmenu.py). Each one of these functions is responsible
responsible for prompting the user with a specific information for prompting the user for a specific piece of information (username,
(username, password and so on). At the bottom of the file are password and so on). At the bottom of the file is defined the CmdSet
defined the CmdSet for Unlogging users, which adds a new command for Unlogging users. This adds a new command that is called just after
(defined below) that is called just after a new session has been a new session has been created, in order to create the menu. See the
created, in order to create the menu. See the specific specific documentation on functions (nodes) to see what each one
documentation on functions (nodes) to see what each one should should do.
do.
""" """