Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up admin frontpage

Browse source
This commit is contained in:
Griatch 2022-02-05 01:13:41 +01:00
parent b76c5d2bab
commit f7c01c2ee4
3 changed files with 137 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

233
evennia/web/templates/admin/frontpage.html
View file

@ -7,109 +7,146 @@
<div class="col">
<div class="card">
<div class="card-body">
<h1 class="card-title">Admin</h1>
<p class="card-text">
The Evennia admin allows for modifying database entities using a
graphical interface. This bypasses in-game locks and permissions.
</p>
<hr />
<h3>Game entities</h3>
<div class="row">
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:accounts_accountdb_changelist" %}">Accounts</a></h4>
<small class="text-muted">
hold a player's configuration and password. An account can
control one or more in-game characters (Objects).
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:objects_objectdb_changelist" %}">Objects</a></h4>
<small class="text-muted">
include everything inside the game-world, from Characters
to Rooms, Exits, swords and monsters.
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:scripts_scriptdb_changelist" %}">Scripts</a></h4>
<small class="text-muted">
are 'Objects without an in-game existence'. They are used to store game
information and state, handle special functionality or perform timed actions.
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:typeclasses_tag_changelist" %}">Tags</a></h4>
<small class="text-muted">
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.
</small>
</p>
</div>
</div>
<div class="row">
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:comms_channeldb_changelist" %}">Channels</a></h4>
<small class="text-muted">
redirect communication between subscribers, chat-room style. The
channel object holds subscriptions, options and access. The
text itself is logged to file.
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:comms_msg_changelist" %}">Msgs</a></h4>
<small class="text-muted">
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.
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:help_helpentry_changelist" %}">Help Topics</a></h4>
<small class="text-muted">
store help entries. Dynamic command-help (based on source code) and file-based
help entries (stored in modules defined by <code>FILEHELP_MODULES</code> setting)
are not possible to edit from this admin.
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:server_serverconfig_changelist" %}">ServerConfigs</a></h4>
<small class="text-muted">
store variables set by the running server. These are maintained
by the server and should usually never need to be edited manually.
</small>
</p>
</div>
</div>
<div class="row">
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:sites_site_changelist" %}">Site-Domains</a></h4>
<small class="text-muted">
define domains for <code>Flat Pages</code>. For local-only testing, create a
domain named <code>localhost:4001</code>. Then manually add
<code>SITE_ID=&lt;id&gt;</code> to your settings, where &lt;id&gt;
is the database-id of the domain you just created.
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:flatpages_flatpage_changelist" %}">Flat Pages</a></h4>
<small class="text-muted">
Create, edit and publish new web pages without needing to know how to
code. Make sure to assign to a <code>Site-Domain</code> created previously.
</small>
</p>
</div>
<div class="col-sm border">
<p class="card-text">
<p class="lead"><a href="{% url "admin:auth_group_changelist" %}">Groups</a></h4>
<small class="text-muted">
are permission groups used only by the admin. You usually don't
need to modify these.
</small>
</p>
</div>
</div>
<p class="card-text">
<h4><a href="{% url "admin:accounts_accountdb_changelist" %}">Accounts</a></h4>
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).
<p class="card-text text-center">
<small class="text-muted">
The Evennia admin allows for modifying database entities using a
graphical interface. This bypasses in-game locks and permissions.
<br>You can disable this front page and use the base
<a href="{% url "django_admin" %}">django admin panel page</a>
by adding <code>EVENNIA_ADMIN=False</code> to
<code>server/conf/settings.py</code> and reload.
</small>
</p>
<p class="card-text">
<h4><a href="{% url "admin:objects_objectdb_changelist" %}">Objects</a></h4>
Objects include everything with an in-game location, from characters
to rooms, exits, swords and monsters.
</p>
<p class="card-text">
<h4><a href="{% url "admin:scripts_scriptdb_changelist" %}">Scripts</a></h4>
Scripts are meta objects used to store game information and state,
handle special functionality or perform timed actions. They have no
in-game location.
</p>
<p class="card-text">
<h4><a href="{% url "admin:comms_channeldb_changelist" %}">Channels</a></h4>
Channels are used for mass communication, chat-room style. The
channel object holds subscriptions, options and access. The
communications themselves are logged to disk.
</p>
<p class="card-text">
<h4><a href="{% url "admin:comms_msg_changelist" %}">Msgs</a></h4>
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.
</p>
<p class="card-text">
<h4><a href="{% url "admin:help_helpentry_changelist" %}">Help Topics</a></h4>
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.
</p>
<p class="card-text">
<h4><a href="{% url "admin:typeclasses_tag_changelist" %}">Tags</a></h4>
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.
</p>
<p class="card-text">
<h4><a href="{% url "admin:server_serverconfig_changelist" %}">ServerConfig</a></h4>
ServerConfigs store variables set by the running server. While
possibly interesting for debugging, you should usually not modify
these manually unless you <i>really</i> know what you are doing. For
example, the <i>BASE_*_TYPECLASS</i> fields are stored in order to
auto-update when their setting changes; they must <i>not</i> be
changed manually here.
</p>
<hr />
<h3>Website-only</h3>
<p class="card-text">
<h4><a href="{% url "admin:sites_site_changelist" %}">Sites (domains)</a></h4>
Configure domain name for your pages. For local-only testing, create a
domain named <I>localhost:4001</I>. Then manually add
<strong>SITE_ID=&lt;id&gt;</strong> to your settings, where &lt;id&gt;
is the database-id of the domain you created (the &lt;id&gt; can be
found from the url of the domain in the admin, so
<I>/admin/sites/site/3/change</I> means that &lt;id&gt; is 3).
</p>
<p class="card-text">
<h4><a href="{% url "admin:flatpages_flatpage_changelist" %}">Flat Pages</a></h4>
Create, edit and publish new web pages without needing to know how to
code. Make sure to assign to a domain created above.
</p>
<p class="card-text">
<h4><a href="{% url "admin:auth_group_changelist" %}">Groups</a></h4>
These are permission groups used only by the admin. You usually don't
need to modify these.
</p>
<hr />
<p class="card-text">
When you click on any link above you'll end up in the full
django-based admin panel. You can also get to it
<a href="{% url "django_admin" %}">here</a>. You can make this the default by
changing <code>EVENNIA_ADMIN</code> to <code>False</code> in
<code>settings.py</code> and reload.
</p>
</div>
</div>
</div>

3
evennia/web/templates/website/index.html
View file

@ -20,8 +20,7 @@
</p>
<p>
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.<br>It can be expanded into a full-fledged home for your game.
</p>
{% if webclient_enabled %}
<p>

1
requirements.txt
View file

@ -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