evennia/docs/source/Developer-Central.md

103 lines
3.8 KiB
Markdown

# 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](Coding-Introduction)
- [Evennia Licensing FAQ](Licensing)
- [Contributing to Evennia](Contributing)
- [Code Style Guide](https://github.com/evennia/evennia/blob/master/CODING_STYLE.md) (Important!)
- [Policy for 'MUX-like' default commands](Using-MUX-as-a-Standard)
- [Setting up a Git environment for coding](Version-Control)
- [Getting started with Travis and Github for continuous integration testing](Using-Travis)
- [Planning your own Evennia game](Game-Planning)
- [First steps coding Evennia](First-Steps-Coding)
- [Translating Evennia](Internationalization#translating-evennia)
- [Evennia Quirks](Quirks) to keep in mind.
- [Directions for configuring PyCharm with Evennia on Windows](Setting-up-PyCharm)
### Evennia API
- [Directory Overview](Directory-Overview)
- [evennia - the flat API](Evennia-API)
- [Running and Testing Python code](Execute-Python-Code)
#### Core components and protocols
- [Server and Portal](Portal-And-Server)
- [Sessions](Sessions)
- [Configuration and module plugins](Server-Conf)
- [The message path](Messagepath)
- [OOB](OOB) - Out-of-band communication
- [Inputfuncs](Inputfuncs)
- [Adding new protocols (client APIs) and services](Custom-Protocols)
- [Adding new database models](New-Models)
- [Running and writing unit tests](Unit-Testing)
- [Running profiling](Profiling)
- [Debugging your code](Debugging)
#### In-game Commands
- [Command System overview](Command-System)
- [Commands](Commands)
- [Command Sets](Command-Sets)
- [Command Auto-help](Help-System#command-auto-help-system)
#### Typeclasses and related concepts
- [General about Typeclasses](Typeclasses)
- [Objects](Objects)
- [Characters](Objects#characters)
- [Rooms](Objects#rooms)
- [Exits](Objects#exits)
- [Accounts](Accounts)
- [Communications](Communications)
- [Channels](Communications#channels)
- [Scripts](Scripts)
- [Global Scripts](Scripts#Global-Scripts)
- [TickerHandler](TickerHandler)
- [utils.delay](Coding-Utils#utilsdelay)
- [MonitorHandler](MonitorHandler)
- [Attributes](Attributes)
- [Nicks](Nicks)
- [Tags](Tags)
- [Tags for Aliases and Permissions](Tags#using-aliases-and-permissions)
#### Web
- [Web features overview](Web-Features)
- [The Webclient](Webclient)
- [Web tutorials](Web-Tutorial)
#### Other systems
- [Locks](Locks)
- [Permissions](Locks#permissions)
- [Help System](Help-System)
- [Signals](Signals)
- [General coding utilities](Coding-Utils)
- [Utils in evennia.utils.utils](api:evennia.utils.utils)
- [Game time](Coding-Utils#game-time)
- [Game Menus](EvMenu) (EvMenu)
- [Text paging/scrolling](EvMore) (EvMore)
- [Text Line Editor](EvEditor) (EvEditor)
- [Text Tables](github:evennia.utils.evtable) (EvTable)
- [Text Form generation](github:evennia.utils.evform) (EvForm)
- [Spawner and Prototypes](Spawner-and-Prototypes)
- [Inlinefuncs](TextTags#inline-functions)
- [Asynchronous execution](Async-Process)
### Developer brainstorms and whitepages
- [API refactoring](API-refactoring), discussing what parts of the Evennia API needs a refactoring/cleanup/simplification
- [Docs refactoring](Docs-refactoring), discussing how to reorganize and structure this wiki/docs better going forward
- [Webclient brainstorm](Webclient-brainstorm), some ideas for a future webclient gui
- [Roadmap](Roadmap), a tentative list of future major features
- [Change log](https://github.com/evennia/evennia/blob/master/CHANGELOG.md) of big Evennia updates over time
[group]: https://groups.google.com/forum/#!forum/evennia
[online-form]: https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZGc6MQ#gid=0
[issues]: https://github.com/evennia/evennia/issues