Add Component overview

This commit is contained in:
Griatch 2020-06-19 22:46:19 +02:00
parent af5884705e
commit 5dc31f834a
6 changed files with 139 additions and 4 deletions

View file

@ -0,0 +1,28 @@
# Coding and development help
This documentation aims to help you set up a sane development environment to
make your game, also if you never coded before. If you are an experienced coder, much of this will be familiar
to you, but some things may still be useful.
## Find your way
- [Directory-Overview](Directory-Overview)
- [Quirks of Evennia](Quirks)
## Setting up a workflow
- [Setting up PyCharm](Setting-up-PyCharm)
- [Using Version-Control](Version-Control)
- [Updating Evennia sources](Updating-Your-Game)
## Coding away
- [Ways to Debug](Debugging)
- [Adding unit-tests](Unit-Testing)
## Advanced concepts
- [Continuous Integration](Continuous-Integration)
- [Using Travis](Using-Travis)
- [Profiling](Profiling)

View file

@ -0,0 +1,53 @@
# Core Components
These are the 'building blocks' out of which Evennia is built. This documentation is complementary to, and often goes deeper
than, the doc-strings of each component in the [API](../Evennia-API).
## Database entites
- [Typeclasses](Typeclasses)
- [Sessions](Sessions)
- [Acccounts](Accounts)
- [Guests](../Concept/Guest-Logins)
- [Objects](Objects)
- [Scripts](Scripts)
- [Channels and Messages](Communications)
- [Attributes](Attributes)
- [Nicks](Nicks)
- [Tags](Tags)
- [Help system](Help-System)
- [Spawner and prototypes](Spawner-and-Prototypes)
## Commands
- [Command-System](Command system)
- [Command-Sets](Command-Sets)
- [Commands](Commands)
- [The Connection Screen](Connection-Screen)
- [Available default Commands](Default-Command-Help)
- [Batch-Processors](Batch-Processors)
- [Batch-Code-Processor](Batch-Code-Processor)
- [Batch-Command-Processor](Batch-Command-Processor)
## Utils
- [Coding-Utils](Coding-Utils)
- [EvEditor](EvEditor)
- [EvMenu](EvMenu)
- [EvMore](EvMore)
- [MonitorHandler](MonitorHandler)
- [TickerHandler](TickerHandler)
- [Lock system](Locks)
## Server and network
- [Signals](Signals)
- [Portal](Portal-And-Server)
- [Inputfuncs](Inputfuncs)
- [Outputfuncs](Outputfuncs)
- [Protocols](../Concept/Custom-Protocols)
- [Server](Server)
- [Server conf object](Server-Conf)
- [Webserver](Webserver)
- [Webclient](Webclient)
- [Bootstrap](Bootstrap-Components-and-Utilities)

View file

@ -0,0 +1,29 @@
# Core Concepts
This documentation cover more over-arching concepts of Evennia, often involving many [Core Components](../Component/Component-Overview) acting together.
## General concepts
- [Asynchronous processing](Async-Process)
- [On Soft-Code](Soft-Code)
- [Using MUX as standard for default commands](Using-MUX-as-a-Standard)
## Access
- [Permissions](Building-Permissions)
- [Banning](Banning)
## Extending the Server
- [Custom Protocols](Custom-Protocols)
- [Bootstrap](Bootstrap-&-Evennia)
- [Creating new models](New-Models)
## Text processing
- [Change the language of the server](Internationalization)
- [Server text-encoding](Text-Encodings)
- [Text tags](TextTags)
## Web features
- [Web features](Web-Features)

View file

@ -0,0 +1,22 @@
# Contributions
The [evennia/contrib/](api:evennia.contrib) folder holds Game-specific tools, systems and utilities created by the community. This gathers
longer-form documentation associated with particular contribs.
## In-Game-Python
- [A voice-operated elevator using events](A-voice-operated-elevator-using-events)
- [Dialogues using events](Dialogues-in-events)
## Maps
- [Dynamic in-game map](Dynamic-In-Game-Map)
- [Static in-game map](Static-In-Game-Map)
## The tutorial-world
- [The tutorial world introduction](Tutorial-World-Introduction)
## Menu-builder
- [Building Menus](Building-menus)

View file

@ -25,10 +25,10 @@ This is the manual of [Evennia](http://www.evennia.com), the open source Python
- [Server Setup, Maintenance and Life](Setup/Setup-Overview) - how to run, maintain and release
- [Tutorials and Howto's](Howto/Howto-Overview) - projects and hints for reaching particular effects and goals
- [Core components](Components) - the core building blocks of Evennia
- [Concepts](Concepts) - larger-scale concepts and features
- [Coding](Coding) - coding and development hints and resources
- [Contributions](Contrib) - game-specific tools and code added by the community
- [Core components](Component/Component-Overview) - the core building blocks of Evennia
- [Concepts](Concept/Concept-Overview) - larger-scale concepts and features
- [Coding](Coding/Coding-Overview) - coding and development hints and resources
- [Contributions](Contrib/Contrib-Overview) - game-specific tools and code added by the community
- [API](Evennia-API) - the full API-reference, generated from source
- [Table of Contents](toc) - an alphabetical listing of all regular documentation pages

View file

@ -21,6 +21,7 @@
- [Component/Command Sets](Component/Command-Sets)
- [Component/Commands](Component/Commands)
- [Component/Communications](Component/Communications)
- [Component/Component Overview](Component/Component-Overview)
- [Component/Connection Screen](Component/Connection-Screen)
- [Component/Default Command Help](Component/Default-Command-Help)
- [Component/EvEditor](Component/EvEditor)
@ -47,6 +48,7 @@
- [Concept/Bootstrap & Evennia](Concept/Bootstrap-&-Evennia)
- [Concept/Building Permissions](Concept/Building-Permissions)
- [Concept/Command System](Concept/Command-System)
- [Concept/Concept Overview](Concept/Concept-Overview)
- [Concept/Custom Protocols](Concept/Custom-Protocols)
- [Concept/Guest Logins](Concept/Guest-Logins)
- [Concept/Internationalization](Concept/Internationalization)
@ -61,6 +63,7 @@
- [Concept/Zones](Concept/Zones)
- [Contrib/A voice operated elevator using events](Contrib/A-voice-operated-elevator-using-events)
- [Contrib/Building menus](Contrib/Building-menus)
- [Contrib/Contrib Overview](Contrib/Contrib-Overview)
- [Contrib/Dialogues in events](Contrib/Dialogues-in-events)
- [Contrib/Dynamic In Game Map](Contrib/Dynamic-In-Game-Map)
- [Contrib/Static In Game Map](Contrib/Static-In-Game-Map)