mirror of
https://github.com/evennia/evennia.git
synced 2026-03-31 04:57:16 +02:00
Updated HTML docs
This commit is contained in:
Evennia docbuilder action
parent
92402ccca7
commit
f3dcfa1076
194 changed files with 4234 additions and 3189 deletions
|
|
@ -363,7 +363,7 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="p">((</span><span class="s2">"typeclasses"</span><span class="p">,</span> <span class="s2">"defaultplayer"</span><span class="p">),</span> <span class="p">(</span><span class="s2">"typeclasses"</span><span class="p">,</span> <span class="s2">"defaultaccount"</span><span class="p">)),</span>
|
||||
<span class="p">]</span>
|
||||
<span class="c1"># Default type of autofield (required by Django)</span>
|
||||
<span class="n">DEFAULT_AUTO_FIELD</span> <span class="o">=</span> <span class="s1">'django.db.models.AutoField'</span>
|
||||
<span class="n">DEFAULT_AUTO_FIELD</span> <span class="o">=</span> <span class="s2">"django.db.models.AutoField"</span>
|
||||
|
||||
<span class="c1">######################################################################</span>
|
||||
<span class="c1"># Evennia webclient options</span>
|
||||
|
|
@ -378,7 +378,7 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="c1"># Shows notifications of new messages as popup windows</span>
|
||||
<span class="s2">"notification_popup"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<span class="c1"># Plays a sound for notifications of new messages</span>
|
||||
<span class="s2">"notification_sound"</span><span class="p">:</span> <span class="kc">False</span>
|
||||
<span class="s2">"notification_sound"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="c1">######################################################################</span>
|
||||
|
|
@ -549,7 +549,7 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="c1"># input. By default the command-name should end with a space or / (since the</span>
|
||||
<span class="c1"># default commands uses MuxCommand and /switches). Note that the extra \n</span>
|
||||
<span class="c1"># is necessary for use with batchprocessor.</span>
|
||||
<span class="n">COMMAND_DEFAULT_ARG_REGEX</span> <span class="o">=</span> <span class="sa">r</span><span class="s1">'^[ /]|\n|$'</span>
|
||||
<span class="n">COMMAND_DEFAULT_ARG_REGEX</span> <span class="o">=</span> <span class="sa">r</span><span class="s2">"^[ /]|\n|$"</span>
|
||||
<span class="c1"># By default, Command.msg will only send data to the Session calling</span>
|
||||
<span class="c1"># the Command in the first place. If set, Command.msg will instead return</span>
|
||||
<span class="c1"># data to all Sessions connected to the Account/Character associated with</span>
|
||||
|
|
@ -723,9 +723,9 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="c1"># This changes the start-symbol for the funcparser callable. Note that</span>
|
||||
<span class="c1"># this will make a lot of documentation invalid and there may also be</span>
|
||||
<span class="c1"># other unexpected side effects, so change with caution.</span>
|
||||
<span class="n">FUNCPARSER_START_CHAR</span> <span class="o">=</span> <span class="s1">'$'</span>
|
||||
<span class="n">FUNCPARSER_START_CHAR</span> <span class="o">=</span> <span class="s2">"$"</span>
|
||||
<span class="c1"># The symbol to use to escape Func</span>
|
||||
<span class="n">FUNCPARSER_ESCAPE_CHAR</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">'</span>
|
||||
<span class="n">FUNCPARSER_ESCAPE_CHAR</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span>
|
||||
<span class="c1"># This is the global max nesting-level for nesting functions in</span>
|
||||
<span class="c1"># the funcparser. This protects against infinite loops.</span>
|
||||
<span class="n">FUNCPARSER_MAX_NESTING</span> <span class="o">=</span> <span class="mi">20</span>
|
||||
|
|
@ -738,8 +738,10 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="n">FUNCPARSER_OUTGOING_MESSAGES_MODULES</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"evennia.utils.funcparser"</span><span class="p">,</span> <span class="s2">"server.conf.inlinefuncs"</span><span class="p">]</span>
|
||||
<span class="c1"># Prototype values are also parsed with FuncParser. These modules</span>
|
||||
<span class="c1"># define which $func callables are available to use in prototypes.</span>
|
||||
<span class="n">FUNCPARSER_PROTOTYPE_PARSING_MODULES</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"evennia.prototypes.protfuncs"</span><span class="p">,</span>
|
||||
<span class="s2">"server.conf.prototypefuncs"</span><span class="p">]</span>
|
||||
<span class="n">FUNCPARSER_PROTOTYPE_PARSING_MODULES</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s2">"evennia.prototypes.protfuncs"</span><span class="p">,</span>
|
||||
<span class="s2">"server.conf.prototypefuncs"</span><span class="p">,</span>
|
||||
<span class="p">]</span>
|
||||
|
||||
<span class="c1">######################################################################</span>
|
||||
<span class="c1"># Global Scripts</span>
|
||||
|
|
@ -807,7 +809,7 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="c1"># since they can be exploitative. This list defines Account-level permissions</span>
|
||||
<span class="c1"># (and higher) that bypass this stripping. It is used as a fallback if a</span>
|
||||
<span class="c1"># specific list of perms are not given to the helper function.</span>
|
||||
<span class="n">INPUT_CLEANUP_BYPASS_PERMISSIONS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Builder'</span><span class="p">]</span>
|
||||
<span class="n">INPUT_CLEANUP_BYPASS_PERMISSIONS</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Builder"</span><span class="p">]</span>
|
||||
|
||||
|
||||
<span class="c1">######################################################################</span>
|
||||
|
|
@ -960,8 +962,8 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="c1"># Where to find locales (no need to change this, most likely)</span>
|
||||
<span class="n">LOCALE_PATHS</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">EVENNIA_DIR</span><span class="p">,</span> <span class="s2">"locale/"</span><span class="p">)]</span>
|
||||
<span class="c1"># How to display time stamps in e.g. the admin</span>
|
||||
<span class="n">SHORT_DATETIME_FORMAT</span> <span class="o">=</span> <span class="s1">'Y-m-d H:i:s.u'</span>
|
||||
<span class="n">DATETIME_FORMAT</span> <span class="o">=</span> <span class="s1">'Y-m-d H:i:s'</span> <span class="c1"># ISO 8601 but without T and timezone</span>
|
||||
<span class="n">SHORT_DATETIME_FORMAT</span> <span class="o">=</span> <span class="s2">"Y-m-d H:i:s.u"</span>
|
||||
<span class="n">DATETIME_FORMAT</span> <span class="o">=</span> <span class="s2">"Y-m-d H:i:s"</span> <span class="c1"># ISO 8601 but without T and timezone</span>
|
||||
<span class="c1"># This should be turned off unless you want to do tests with Django's</span>
|
||||
<span class="c1"># development webserver (normally Evennia runs its own server)</span>
|
||||
<span class="n">SERVE_MEDIA</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
|
|
@ -1027,16 +1029,14 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="c1"># Django cache settings</span>
|
||||
<span class="c1"># https://docs.djangoproject.com/en/dev/topics/cache/#setting-up-the-cache</span>
|
||||
<span class="n">CACHES</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'default'</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s1">'BACKEND'</span><span class="p">:</span> <span class="s1">'django.core.cache.backends.locmem.LocMemCache'</span><span class="p">,</span>
|
||||
<span class="s2">"default"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"BACKEND"</span><span class="p">:</span> <span class="s2">"django.core.cache.backends.locmem.LocMemCache"</span><span class="p">,</span>
|
||||
<span class="p">},</span>
|
||||
<span class="s2">"throttle"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"BACKEND"</span><span class="p">:</span> <span class="s2">"django.core.cache.backends.locmem.LocMemCache"</span><span class="p">,</span>
|
||||
<span class="s2">"TIMEOUT"</span><span class="p">:</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">5</span><span class="p">,</span>
|
||||
<span class="s2">"OPTIONS"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"MAX_ENTRIES"</span><span class="p">:</span> <span class="mi">2000</span><span class="p">},</span>
|
||||
<span class="p">},</span>
|
||||
<span class="s1">'throttle'</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s1">'BACKEND'</span><span class="p">:</span> <span class="s1">'django.core.cache.backends.locmem.LocMemCache'</span><span class="p">,</span>
|
||||
<span class="s1">'TIMEOUT'</span><span class="p">:</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">5</span><span class="p">,</span>
|
||||
<span class="s1">'OPTIONS'</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s1">'MAX_ENTRIES'</span><span class="p">:</span> <span class="mi">2000</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
<span class="c1"># MiddleWare are semi-transparent extensions to Django's functionality.</span>
|
||||
<span class="c1"># see http://www.djangoproject.com/documentation/middleware/ for a more detailed</span>
|
||||
|
|
@ -1101,8 +1101,14 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="c1"># Username validation plugins</span>
|
||||
<span class="n">AUTH_USERNAME_VALIDATORS</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">{</span><span class="s2">"NAME"</span><span class="p">:</span> <span class="s2">"django.contrib.auth.validators.ASCIIUsernameValidator"</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"NAME"</span><span class="p">:</span> <span class="s2">"django.core.validators.MinLengthValidator"</span><span class="p">,</span> <span class="s2">"OPTIONS"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"limit_value"</span><span class="p">:</span> <span class="mi">3</span><span class="p">},},</span>
|
||||
<span class="p">{</span><span class="s2">"NAME"</span><span class="p">:</span> <span class="s2">"django.core.validators.MaxLengthValidator"</span><span class="p">,</span> <span class="s2">"OPTIONS"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"limit_value"</span><span class="p">:</span> <span class="mi">30</span><span class="p">},},</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"NAME"</span><span class="p">:</span> <span class="s2">"django.core.validators.MinLengthValidator"</span><span class="p">,</span>
|
||||
<span class="s2">"OPTIONS"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"limit_value"</span><span class="p">:</span> <span class="mi">3</span><span class="p">},</span>
|
||||
<span class="p">},</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"NAME"</span><span class="p">:</span> <span class="s2">"django.core.validators.MaxLengthValidator"</span><span class="p">,</span>
|
||||
<span class="s2">"OPTIONS"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"limit_value"</span><span class="p">:</span> <span class="mi">30</span><span class="p">},</span>
|
||||
<span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"NAME"</span><span class="p">:</span> <span class="s2">"evennia.server.validators.EvenniaUsernameAvailabilityValidator"</span><span class="p">},</span>
|
||||
<span class="p">]</span>
|
||||
|
||||
|
|
@ -1121,7 +1127,9 @@ to change into <code class="docutils literal notranslate"><span class="pre">myga
|
|||
<span class="s2">"DEFAULT_PAGINATION_CLASS"</span><span class="p">:</span> <span class="s2">"rest_framework.pagination.LimitOffsetPagination"</span><span class="p">,</span>
|
||||
<span class="s2">"PAGE_SIZE"</span><span class="p">:</span> <span class="mi">25</span><span class="p">,</span>
|
||||
<span class="c1"># require logged in users to call API so that access checks can work on them</span>
|
||||
<span class="s2">"DEFAULT_PERMISSION_CLASSES"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"rest_framework.permissions.IsAuthenticated"</span><span class="p">,],</span>
|
||||
<span class="s2">"DEFAULT_PERMISSION_CLASSES"</span><span class="p">:</span> <span class="p">[</span>
|
||||
<span class="s2">"rest_framework.permissions.IsAuthenticated"</span><span class="p">,</span>
|
||||
<span class="p">],</span>
|
||||
<span class="c1"># These are the different ways people can authenticate for API requests - via</span>
|
||||
<span class="c1"># session or with user/password. Other ways are possible, such as via tokens</span>
|
||||
<span class="c1"># or oauth, but require additional dependencies.</span>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue