mirror of
https://github.com/evennia/evennia.git
synced 2026-03-22 07:46:30 +01:00
Convert master docs to use MyST
This commit is contained in:
parent
6e03216cd9
commit
d229ff024c
359 changed files with 3275 additions and 4567 deletions
|
|
@ -6,98 +6,98 @@ library itself.
|
|||
|
||||
### General Evennia development information
|
||||
|
||||
- [Introduction to coding with Evennia](./Coding-Introduction)
|
||||
- [Evennia Licensing FAQ](./Licensing)
|
||||
- [Contributing to Evennia](./Contributing)
|
||||
- [Introduction to coding with Evennia](./Coding-Introduction.md)
|
||||
- [Evennia Licensing FAQ](./Licensing.md)
|
||||
- [Contributing to Evennia](./Contributing.md)
|
||||
- [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)
|
||||
- [Policy for 'MUX-like' default commands](./Using-MUX-as-a-Standard.md)
|
||||
- [Setting up a Git environment for coding](./Version-Control.md)
|
||||
- [Getting started with Travis and Github for continuous integration testing](./Using-Travis.md)
|
||||
- [Planning your own Evennia game](./Game-Planning.md)
|
||||
- [First steps coding Evennia](./First-Steps-Coding.md)
|
||||
- [Translating Evennia](./Internationalization.md#translating-evennia)
|
||||
- [Evennia Quirks](./Quirks.md) to keep in mind.
|
||||
- [Directions for configuring PyCharm with Evennia on Windows](./Setting-up-PyCharm.md)
|
||||
|
||||
### Evennia API
|
||||
|
||||
- [Directory Overview](./Directory-Overview)
|
||||
- [evennia - the flat API](./Evennia-API)
|
||||
- [Running and Testing Python code](./Execute-Python-Code)
|
||||
- [Directory Overview](./Directory-Overview.md)
|
||||
- [evennia - the flat API](./Evennia-API.md)
|
||||
- [Running and Testing Python code](./Execute-Python-Code.md)
|
||||
|
||||
#### 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)
|
||||
- [Unit Testing](./Unit-Testing)
|
||||
- [Running profiling](./Profiling)
|
||||
- [Debugging your code](./Debugging)
|
||||
- [Server and Portal](./Portal-And-Server.md)
|
||||
- [Sessions](./Sessions.md)
|
||||
- [Configuration and module plugins](./Server-Conf.md)
|
||||
- [The message path](./Messagepath.md)
|
||||
- [OOB](./OOB.md) - Out-of-band communication
|
||||
- [Inputfuncs](./Inputfuncs.md)
|
||||
- [Adding new protocols (client APIs) and services](./Custom-Protocols.md)
|
||||
- [Adding new database models](./New-Models.md)
|
||||
- [Unit Testing](./Unit-Testing.md)
|
||||
- [Running profiling](./Profiling.md)
|
||||
- [Debugging your code](./Debugging.md)
|
||||
|
||||
#### In-game Commands
|
||||
|
||||
- [Command System overview](./Command-System)
|
||||
- [Commands](./Commands)
|
||||
- [Command Sets](./Command-Sets)
|
||||
- [Command Auto-help](./Help-System#command-auto-help-system)
|
||||
- [Command System overview](./Command-System.md)
|
||||
- [Commands](./Commands.md)
|
||||
- [Command Sets](./Command-Sets.md)
|
||||
- [Command Auto-help](./Help-System.md#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)
|
||||
- [General about Typeclasses](./Typeclasses.md)
|
||||
- [Objects](./Objects.md)
|
||||
- [Characters](./Objects.md#characters)
|
||||
- [Rooms](./Objects.md#rooms)
|
||||
- [Exits](./Objects.md#exits)
|
||||
- [Accounts](./Accounts.md)
|
||||
- [Communications](./Communications.md)
|
||||
- [Channels](./Communications.md#channels)
|
||||
- [Scripts](./Scripts.md)
|
||||
- [Global Scripts](./Scripts.md#global-scripts)
|
||||
- [TickerHandler](./TickerHandler.md)
|
||||
- [utils.delay](./Coding-Utils.md#utilsdelay)
|
||||
- [MonitorHandler](./MonitorHandler.md)
|
||||
- [Attributes](./Attributes.md)
|
||||
- [Nicks](./Nicks.md)
|
||||
- [Tags](./Tags.md)
|
||||
- [Tags for Aliases and Permissions](./Tags.md#using-aliases-and-permissions)
|
||||
|
||||
#### Web
|
||||
|
||||
- [Web features overview](./Web-Features)
|
||||
- [The Webclient](./Webclient)
|
||||
- [Web tutorials](./Web-Tutorial)
|
||||
- [Web features overview](./Web-Features.md)
|
||||
- [The Webclient](./Webclient.md)
|
||||
- [Web tutorials](./Web-Tutorial.md)
|
||||
|
||||
#### 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)
|
||||
- [Locks](./Locks.md)
|
||||
- [Permissions](./Locks.md#permissions)
|
||||
- [Help System](./Help-System.md)
|
||||
- [Signals](./Signals.md)
|
||||
- [General coding utilities](./Coding-Utils.md)
|
||||
- [Utils in evennia.utils.utils](evennia.utils.utils)
|
||||
- [Game time](./Coding-Utils.md#game-time)
|
||||
- [Game Menus](./EvMenu.md) (EvMenu)
|
||||
- [Text paging/scrolling](./EvMore.md) (EvMore)
|
||||
- [Text Line Editor](./EvEditor.md) (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)
|
||||
- [Spawner and Prototypes](./Spawner-and-Prototypes.md)
|
||||
- [Inlinefuncs](./TextTags.md#inline-functions)
|
||||
- [Asynchronous execution](./Async-Process.md)
|
||||
|
||||
### Developer brainstorms and whitepages
|
||||
|
||||
- [API refactoring](./API-refactoring), discussing what parts of the Evennia API needs a
|
||||
- [API refactoring](./API-refactoring.md), 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
|
||||
- [Docs refactoring](./Docs-refactoring.md), 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
|
||||
- [Webclient brainstorm](./Webclient-brainstorm.md), some ideas for a future webclient gui
|
||||
- [Roadmap](./Roadmap.md), a tentative list of future major features
|
||||
- [Change log](https://github.com/evennia/evennia/blob/master/CHANGELOG.md) of big Evennia updates
|
||||
over time
|
||||
|
||||
|
|
@ -108,7 +108,7 @@ zY1RoZGc6MQ#gid=0
|
|||
[issues]: https://github.com/evennia/evennia/issues
|
||||
|
||||
|
||||
```toctree::
|
||||
```{toctree}
|
||||
:hidden:
|
||||
|
||||
Coding-Introduction
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue