evennia/evennia/web
2021-05-29 13:53:11 +02:00
..
admin Update HaProxy document, move server/admin to correct place 2021-05-26 20:12:19 +02:00
api Add api customization templates 2021-05-23 18:27:50 +02:00
static Customize api and add redoc autodocs 2021-05-23 13:12:07 +02:00
templates Update localization 2021-05-29 13:22:19 +02:00
templatetags Move and split views 2021-05-16 21:09:38 +02:00
utils Add api customization templates 2021-05-23 18:27:50 +02:00
webclient Change url() to path() 2021-05-22 16:29:13 +02:00
website More admin cleanup and doc writing 2021-05-22 20:12:48 +02: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 Update doc strings 2021-05-29 13:53:11 +02: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.