From f7c01c2ee456c7a7f5756261fefae2e55a0ff43a Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 5 Feb 2022 01:13:41 +0100 Subject: [PATCH] Clean up admin frontpage --- evennia/web/templates/admin/frontpage.html | 233 ++++++++++++--------- evennia/web/templates/website/index.html | 3 +- requirements.txt | 1 + 3 files changed, 137 insertions(+), 100 deletions(-) diff --git a/evennia/web/templates/admin/frontpage.html b/evennia/web/templates/admin/frontpage.html index d2fafeafda..91c358816b 100644 --- a/evennia/web/templates/admin/frontpage.html +++ b/evennia/web/templates/admin/frontpage.html @@ -7,109 +7,146 @@
-

Admin

-

- The Evennia admin allows for modifying database entities using a - graphical interface. This bypasses in-game locks and permissions. -

-
-

Game entities

+
+ +
+

+

Accounts + + hold a player's configuration and password. An account can + control one or more in-game characters (Objects). + +

+
+ +
+

+

Objects + + include everything inside the game-world, from Characters + to Rooms, Exits, swords and monsters. + +

+
+ +
+

+

Scripts + + are 'Objects without an in-game existence'. They are used to store game + information and state, handle special functionality or perform timed actions. + +

+
+ +
+

+

Tags + + are used to group, organize and quickly find other types of + entities (usually Objects). A tag is unique and 'shared' for each type of entity. + +

+
+ +
+
+ +
+

+

Channels + + redirect communication between subscribers, chat-room style. The + channel object holds subscriptions, options and access. The + text itself is logged to file. + +

+
+ +
+

+

Msgs + + store one unit of communication between a sender and + one or more receivers, like an email or single chat message. It is used by + page/tell and the in-game mail contrib. + +

+
+ +
+

+

Help Topics + + store help entries. Dynamic command-help (based on source code) and file-based + help entries (stored in modules defined by FILEHELP_MODULES setting) + are not possible to edit from this admin. + +

+
+ +
+

+

ServerConfigs + + store variables set by the running server. These are maintained + by the server and should usually never need to be edited manually. + +

+
+ +
+ +
+ +
+

+

Site-Domains + + define domains for Flat Pages. For local-only testing, create a + domain named localhost:4001. Then manually add + SITE_ID=<id> to your settings, where <id> + is the database-id of the domain you just created. + +

+
+ +
+

+

Flat Pages + + Create, edit and publish new web pages without needing to know how to + code. Make sure to assign to a Site-Domain created previously. + +

+
+ +
+

+

Groups + + are permission groups used only by the admin. You usually don't + need to modify these. + +

+ +
+ +

-

Accounts

- Accounts represent an out-of-character player and stores - configurations and password. An account can control/puppet one or - more in-game Objects (usually Characters). +

+ + The Evennia admin allows for modifying database entities using a + graphical interface. This bypasses in-game locks and permissions. +
You can disable this front page and use the base + django admin panel page + by adding EVENNIA_ADMIN=False to + server/conf/settings.py and reload. +

-

-

Objects

- Objects include everything with an in-game location, from characters - to rooms, exits, swords and monsters. -

- -

-

Scripts

- Scripts are meta objects used to store game information and state, - handle special functionality or perform timed actions. They have no - in-game location. -

- -

-

Channels

- Channels are used for mass communication, chat-room style. The - channel object holds subscriptions, options and access. The - communications themselves are logged to disk. -

- -

-

Msgs

- Messages represent a piece of database-base saved communication - between sender(s) and receiver(s). By default they are used by - page/tell but can be used as building blocks for custom in-game - communication systems. -

- -

-

Help Topics

- Database-based Help entries like these can also be added from - in-game. Note that command-auto-help and file-based help entries - (added via FILEHELP_MODULES) cannot be modified or viewed from here. -

- -

-

Tags

- Tags are used to group, organize and quickly find other types of - objects. A given tag is 'shared' between any number of entities - making them very efficient. -

- -

-

ServerConfig

- ServerConfigs store variables set by the running server. While - possibly interesting for debugging, you should usually not modify - these manually unless you really know what you are doing. For - example, the BASE_*_TYPECLASS fields are stored in order to - auto-update when their setting changes; they must not be - changed manually here. -

- -
- -

Website-only

- -

-

Sites (domains)

- Configure domain name for your pages. For local-only testing, create a - domain named localhost:4001. Then manually add - SITE_ID=<id> to your settings, where <id> - is the database-id of the domain you created (the <id> can be - found from the url of the domain in the admin, so - /admin/sites/site/3/change means that <id> is 3). -

- -

-

Flat Pages

- Create, edit and publish new web pages without needing to know how to - code. Make sure to assign to a domain created above. -

- -

-

Groups

- These are permission groups used only by the admin. You usually don't - need to modify these. -

- -
- -

- When you click on any link above you'll end up in the full - django-based admin panel. You can also get to it - here. You can make this the default by - changing EVENNIA_ADMIN to False in - settings.py and reload. -

diff --git a/evennia/web/templates/website/index.html b/evennia/web/templates/website/index.html index 6c3535b44e..365f473a4d 100644 --- a/evennia/web/templates/website/index.html +++ b/evennia/web/templates/website/index.html @@ -20,8 +20,7 @@

You are looking at the start of your game's website, generated out of - the box by Evennia. It has several example pages and can be expanded - into a full-fledged home for your game. + the box by Evennia.
It can be expanded into a full-fledged home for your game.

{% if webclient_enabled %}

diff --git a/requirements.txt b/requirements.txt index 0904ef05b5..efe5a7aade 100644 --- a/requirements.txt +++ b/requirements.txt @@ -13,6 +13,7 @@ inflect >= 5.2.0 autobahn >= 20.7.1, < 21.0.0 lunr == 0.6.0 simpleeval <= 1.0 +uritemplate == 4.1.1 # try to resolve dependency issue in py3.7 attrs >= 19.2.0