evennia/docs/source/Components/Components-Overview.md

79 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

# 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.md).
2022-11-26 23:18:11 +01:00
## Base components
2022-11-19 20:24:11 +01:00
These are base pieces used to make an Evennia game. Most are long-lived and are persisted in the database.
```{toctree}
:maxdepth: 2
2022-11-26 23:18:11 +01:00
Portal-And-Server.md
Sessions.md
2022-11-26 23:18:11 +01:00
Typeclasses.md
Accounts.md
Objects.md
Characters.md
Rooms.md
Exits.md
Scripts.md
Channels.md
Msg.md
Attributes.md
Nicks.md
Tags.md
Prototypes.md
Help-System.md
Permissions.md
2022-11-26 23:18:11 +01:00
Locks.md
```
## Commands
2022-11-19 20:24:11 +01:00
Evennia's Command system handle everything sent to the server by the user.
```{toctree}
:maxdepth: 2
Commands.md
Command-Sets.md
Default-Commands.md
Batch-Processors.md
2022-11-19 20:24:11 +01:00
Inputfuncs.md
```
## Utils and tools
2022-11-19 20:24:11 +01:00
Evennia provides a library of code resources to help the creation of a game.
```{toctree}
:maxdepth: 2
Coding-Utils.md
EvEditor.md
EvForm.md
EvMenu.md
EvMore.md
EvTable.md
FuncParser.md
MonitorHandler.md
OnDemandHandler.md
TickerHandler.md
Signals.md
```
## Web components
2022-11-19 20:24:11 +01:00
Evennia is also its own webserver, with a website and in-browser webclient you can expand on.
```{toctree}
:maxdepth: 2
Website.md
2022-11-19 20:24:11 +01:00
Webclient.md
Web-Admin.md
Webserver.md
2022-11-19 20:24:11 +01:00
Web-API.md
Web-Bootstrap-Framework.md
2022-11-19 20:24:11 +01:00
```