From 7114aea912929509c3315ddb0b1e34e5b3e4a167 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 26 Nov 2022 00:10:28 +0100 Subject: [PATCH] Update ascii art in docs --- docs/source/Components/Portal-And-Server.md | 24 +++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/source/Components/Portal-And-Server.md b/docs/source/Components/Portal-And-Server.md index 1cded50e3e..c3527e5409 100644 --- a/docs/source/Components/Portal-And-Server.md +++ b/docs/source/Components/Portal-And-Server.md @@ -2,10 +2,26 @@ Evennia consists of two processes, known as *Portal* and *Server*. They can be controlled from -inside the game or from the command line as described [here](../Setup/Running-Evennia.md). +inside the game or from the command line as described [in the Running-Evennia doc](../Setup/Running-Evennia.md). -If you are new to the concept, the main purpose of separating the two is to have accounts connect to the Portal but keep the MUD running on the Server. This way one can restart/reload the game (the Server part) without Accounts getting disconnected. +In short, the Portal knows everything about internet protocols (telnet, websockets etc), but knows very little about the game. -![portal and server layout](https://474a3b9f-a-62cb3a1a-s- sites.googlegroups.com/site/evenniaserver/file-cabinet/evennia_server_portal.png) +In contrast, the Server knows everything about the game. It knows that a player has connected but now _how_ they connected. -The Server and Portal are glued together via an AMP (Asynchronous Messaging Protocol) connection. This allows the two programs to communicate seamlessly. \ No newline at end of file +The effect of this is that you can fully `reload` the Server and have players still connected to the game. One the server comes back up, it will re-connect to the Portal and re-sync all players as if nothing happened. + +``` +Internet│ ┌──────────┐ ┌─┐ ┌─┐ ┌─────────┐ + │ │Portal │ │S│ ┌───┐ │S│ │Server │ + P │ │ ├─┤e├───┤AMP├───┤e├─┤ │ + l ──┼──┤ Telnet │ │s│ │ │ │s│ │ │ + a │ │ Webclient├─┤s├───┤ ├───┤s├─┤ Game │ + y ──┼──┤ SSH │ │i│ │ │ │i│ │ Database│ + e │ │ ... ├─┤o├───┤ ├───┤o├─┤ │ + r ──┼──┤ │ │n│ │ │ │n│ │ │ + s │ │ │ │s│ └───┘ │s│ │ │ + │ └──────────┘ └─┘ └─┘ └─────────┘ + │Evennia +``` + +The Server and Portal are glued together via an AMP (Asynchronous Messaging Protocol) connection. This allows the two programs to communicate seamlessly on the same machine. \ No newline at end of file