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

Updated ReST docs, fixed some things in Swedish translation.

Browse source
This commit is contained in:
Griatch 2012-02-19 10:49:59 +01:00
parent 11e61255da
commit c4f2c493d9
19 changed files with 937 additions and 745 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/sphinx/source/wiki/DirectoryOverview.rst
View file

@ -1,8 +1,17 @@
Evennia directory overview
==========================
::
evennia/
contrib/
docs/
game/
locale/
src/
Evennia's main directory (``evennia``) is divided into five sub
directories - ``src/``, ``game/``, ``contrib/``, ``locale`` and
directories - ``src/``, ``game/``, ``contrib/`` , ``locale`` and
``doc/``. The first two are the most important ones. ``game/`` is the
place where you will create your own game, whereas ``src/`` is the home
of the Evennia server itself. Your code should usually just import
@ -35,8 +44,8 @@ create a nice browsable web-index of all the sources and comments. In
the same way you could in theory also create nice ``LaTeX``-formatted
PDFs of the Evennia source (all 400+ pages of it ...).
The ``locale`` directory
------------------------
The ``locale/`` directory
-------------------------
This contains internationalization strings for translating the Evennia
core server to different languages. See
@ -217,8 +226,8 @@ point to your copy.
~~~~~~~~~~~~~~
``src/comms/`` defines all aspects of OOC
`communication <Communications.html>`_, notably *channels* and the basic
operations for storing listeners to channels.
`communication <Communications.html>`_, notably *channels*, *messages*
and the basic operators for connecting external listeners to channels.
``src/help/``
~~~~~~~~~~~~~
@ -244,8 +253,8 @@ lock functions are found here.
~~~~~~~~~~~~~~~~
The `Player <Players.html>`_ is the OOC-represention of the person
behind the game character. This directory defines the database handling
and methods acting on the Player object.
connected to the game. This directory defines the database handling and
methods acting on the Player object.
``src/scripts/``
~~~~~~~~~~~~~~~~
@ -259,9 +268,10 @@ connection timeouts) are also defined here.
~~~~~~~~~~~~~~~
This directory is the heart of Evennia. It holds the server process
itself (started from ``game/evennia.py``) and all `sessions and
protocols <SessionProtocols.html>`_ that allow users to connect to it.
It also knows how to store dynamic server info in the database.
itself (started from ``game/evennia.py``), the portal and all `sessions
and protocols <SessionProtocols.html>`_ that allow users to connect to
the game. It also knows how to store dynamic server info in the
database.
``src/typeclasses/``
~~~~~~~~~~~~~~~~~~~~
@ -300,10 +310,13 @@ Assorted notes
Whereas ``game/gamesrc/`` contains a set of directories already, you
might find that another structure suits your development better. For
example, it could sometimes easier to put all the commands and scripts a
certain object needs in the same module as that object, rather than
slavishly split them out into their respective directories and import.
Don't be shy to define your own directory structure as needed. A basic
rule of thumb should nevertheless be to avoid code-duplication. So if a
certain script or command could be useful for other objects, break it
out into its own module and import from it.
example, it could sometimes be easier to put all the commands and
scripts a certain object needs in the same module as that object, rather
than slavishly split them out into their respective directories and
import. Don't be shy to define your own directory structure as needed. A
basic rule of thumb should nevertheless be to avoid code-duplication. So
if a certain script or command could be useful for other objects, break
it out into its own module and import from it. Don't forget that if you
add a new directory, it must contain an ``__init__.py`` file (it can be
empty) in order for Python to recognize it as a place it can import
modules from.