evennia/evennia/web
2022-06-01 12:48:18 -06:00
..
admin Run black reformatter on code 2022-02-08 13:03:52 +01:00
api Run black reformatter on code 2022-02-08 13:03:52 +01:00
static check if cmdid has callback 2022-06-01 12:48:18 -06:00
templates Clean up admin frontpage 2022-02-05 01:13:41 +01:00
templatetags Move and split views 2021-05-16 21:09:38 +02:00
utils Run black reformatter on code 2022-02-08 13:03:52 +01:00
webclient Run black reformatter on code 2022-02-08 13:03:52 +01:00
website Run black reformatter on code 2022-02-08 13:03:52 +01:00
__init__.py Move and split views 2021-05-16 21:09:38 +02:00
README.md Continue documentation of web components 2021-05-22 16:11:48 +02:00
urls.py Fix all unit tests for contribs 2021-12-19 20:39:46 +01:00

Web resources

This folder holds the functioning code, html, js and css files for use by the Evennia website and -client. This is a standard Django web application.

  1. When a user enters an url (or clicks a link) in their web browser, Django will use this incoming request to refer to the urls.py file.
  2. The urls.py file will use regex to match the url to a view - a Python function or callable class. The incoming request data will be passed to this code.
  3. The view will (usually) refer to a template, which is a html document with templating slots that allows the system to replace parts of it with dynamic content (like how many users are currently in-game).
  4. The view will render the template with any context into a final HTML page that is returned to the user to view.

I many ways this works like an Evennia Command, with input being the browser's request and the view being the Command's function body for producing a result.

In the case of the webclient, the html page is rendered once and when doing so it loads a Javascript application in the browser that opens a websocket to communicate with the server.