evennia/docs/source/Developer-Central.md

Developer Central

This page serves as a central nexus for information on using Evennia as well as developing the library itself.

General Evennia development information

• Introduction to coding with Evennia
• Evennia Licensing FAQ
• Contributing to Evennia
• Code Style Guide (Important!)
• Policy for 'MUX-like' default commands
• Setting up a Git environment for coding
• Getting started with Travis and Github for continuous integration testing
• Planning your own Evennia game
• First steps coding Evennia
• Translating Evennia
• Evennia Quirks to keep in mind.
• Directions for configuring PyCharm with Evennia on Windows

Evennia API

• Directory Overview
• evennia - the flat API
  • Running and Testing Python code

Core components and protocols

• Server and Portal
  • Sessions
  • Configuration and module plugins
• The message path
  • OOB - Out-of-band communication
  • Inputfuncs
  • Adding new protocols (client APIs) and services
• Adding new database models
• Running and writing unit tests
• Running profiling
• Debugging your code

In-game Commands

• Command System overview
• Commands
• Command Sets
• Command Auto-help

Typeclasses and related concepts

• General about Typeclasses
• Objects
  • Characters
  • Rooms
  • Exits
• Accounts
• Communications
  • Channels
• Scripts
  • Global Scripts
  • TickerHandler
  • utils.delay
  • MonitorHandler
• Attributes
• Nicks
• Tags
  • Tags for Aliases and Permissions

Web

• Web features overview
• The Webclient
• Web tutorials

Other systems

• Locks
  • Permissions
• Help System
• Signals
• General coding utilities
  • Utils in evennia.utils.utils
• Game time
• Game Menus (EvMenu)
• Text paging/scrolling (EvMore)
• Text Line Editor (EvEditor)
• Text Tables (EvTable)
• Text Form generation (EvForm)
• Spawner and Prototypes
• Inlinefuncs
• Asynchronous execution

Developer brainstorms and whitepages

• API refactoring, discussing what parts of the Evennia API needs a refactoring/cleanup/simplification
• Docs refactoring, discussing how to reorganize and structure this wiki/docs better going forward
• Webclient brainstorm, some ideas for a future webclient gui
• Roadmap, a tentative list of future major features
• Change log of big Evennia updates over time