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

Updated the ReST documentation.

Browse source
This commit is contained in:
Griatch 2013-05-15 23:49:38 +02:00
parent d30a79386f
commit cc12dc36fa
34 changed files with 935 additions and 759 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/sphinx/source/wiki/ConnectionScreen.rst
View file

@ -24,24 +24,27 @@ Effective, but not very exciting. You will most likely want to change
this to be more unique for your game.
You can customize the connection screen easily. If you look in
``game/gamesrc/world`` you will find a module named
``connection_screens.py``. Evennia looks into this module for globally
defined strings (only). These strings are used as connection screens and
shown to the user at startup. If more than one screen is defined in the
module, a random screen will be picked from among those available.
``game/gamesrc/conf/examples/`` you will find a module named
``connection_screens.py``. Copy this module up one level (to
``game/gamesrc/conf/``) and set ``settings.CONNECTION_SCREEN_MODULE`` to
point to your new module.
Evennia looks into this module for globally defined strings (only).
These strings are used as connection screens and shown to the user at
startup. If more than one screen is defined in the module, a random
screen will be picked from among those available.
Evennia's default screen is imported as ``DEFAULT_SCREEN`` from
``src.commands.connection_screen``. Remove the import or redefine
``DEFAULT_SCREEN`` to get rid of the default. There is a commented-out
example screen in the module that you can start from. You can define and
import things as normal into the module, but remember that *all* global
strings will be picked up and potentially used as a connection screen.
You can change which module Evennia uses by changing
``settings.CONNECTION_SCREEN_MODULE``.
``src.commands.connection_screen``. Remove the import at the top or
redefine ``DEFAULT_SCREEN`` to get rid of the default. There is a
commented-out example screen in the module that you can start from. You
can define and import things as normal into the module, but remember
that *all* global strings will be picked up and potentially used as a
connection screen.
You can also customize the `commands <Commands.html>`_ available during
the connection screen (``connect``, ``create`` etc). These commands are
a bit special since when the screen is running the player is not yet
identified. A command is made available at the login screen by adding
logged in. A command is made available at the login screen by adding
them to the command set specified by settings.CMDSET\_UNLOGGEDIN. The
default commands are found in ``src/commands/default/unloggedin.py``.