Developer Central
=================

This page serves as a central nexus for useful information regarding
coding using the Evennia codebase or developing the codebase itself.
Everyone is welcome to `help
out <http://code.google.com/p/evennia/wiki/Contributing>`_! If you have
any questions, please feel free to ask them in the `Forum/Discussion
Group <http://www.evennia.com/discussions>`_. If you want more docs on a
particular issue, consider filling out our `online
form <https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZGc6MQ#gid=0>`_
and tell us! Bugs should be reported to the `Issue
tracker <http://code.google.com/p/evennia/issues/list>`_. You can find
more links to Evennia resources from the `Links <Links.html>`_ page.

General Evennia development information
---------------------------------------

-  `Introduction to coding with Evennia <CodingIntroduction.html>`_
-  `Evennia Licensing FAQ <Licensing.html>`_
-  `Contributing to Evennia <Contributing.html>`_
-  `Code Style
   Guide <http://code.google.com/p/evennia/source/browse/CODING_STYLE.txt>`_
   (Important!)
-  `Policy for 'MUX-like' default commands <UsingMUXAsAStandard.html>`_
-  `Setting up a Mercurial environment for
   coding <VersionControl.html>`_
-  `Planning your own Evennia game <GamePlanning.html>`_

Evennia Component Documentation
-------------------------------

-  `ev - the flat API <evAPI.html>`_

-  `Directory Overview <DirectoryOverview.html>`_
-  `Portal and Server <PortalAndServer.html>`_
-  `Commands <Commands.html>`_
-  `Typeclass system <Typeclasses.html>`_

   -  `Objects <Objects.html>`_
   -  `Scripts <Scripts.html>`_
   -  `Players <Players.html>`_
   -  `Attributes <Attributes.html>`_

-  `Locks and Permissions <Locks.html>`_
-  `Communications <Communications.html>`_
-  `Help System <HelpSystem.html>`_
-  `Nicks <Nicks.html>`_
-  `Sessions and Protocols <SessionProtocols.html>`_
-  `Caches <Caches.html>`_
-  `Web features <WebFeatures.html>`_
-  `Configuration and module plugins <ServerConf.html>`_

Programming Evennia
-------------------

-  `Running and Testing Python code from inside the
   game <ExecutePythonCode.html>`_
-  `Useful coding utilities <CodingUtils.html>`_
-  `Running and writing unit tests for Evennia <UnitTesting.html>`_
-  `Running processes asynchronously <AsyncProcess.html>`_

Work in Progress - Developer brainstorms and whitepages
-------------------------------------------------------

*In this section, contributors may suggest, discuss and plan out new
features and ideas. Items here may or may not make it into Evennia down
the road.*

-  `Basic game system implementation <WorkshopDefaultGame.html>`_
   (inactive)
-  `Rtclient protocol <Workshop.html>`_ (deprecated)
-  `Summary of changes <EvenniaDevel.html>`_ of latest version vs old
   Evennia (implemented in aug2010)