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

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2021-08-06 00:47:51 +02:00
parent 56984e0545
commit 4e45c7fb2f
1272 changed files with 6782 additions and 5842 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/1.0-dev/Setup/Apache-Config.html
View file

@ -100,7 +100,7 @@ modifications <strong>after</strong> copying the file there.</p>
<h3>Enjoy<a class="headerlink" href="#enjoy" title="Permalink to this headline"></a></h3>
<p>With any luck, you’ll be able to point your browser at your domain or subdomain that you set up in
your vhost and see the nifty default Evennia webpage. If not, read the hopefully informative error
message and work from there. Questions may be directed to our <a class="reference external" href="http://evennia.com">Evennia Community
message and work from there. Questions may be directed to our <a class="reference external" href="https://evennia.com">Evennia Community
site</a>.</p>
</section>
<section id="a-note-on-code-reloading">
@ -270,11 +270,11 @@ port but this should be applicable also to other types of proxies (like nginx).<
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

14
docs/1.0-dev/Setup/Choosing-An-SQL-Server.html
View file

@ -46,9 +46,9 @@
<li><p>PostgreSQL</p></li>
<li><p>MySQL / MariaDB</p></li>
</ul>
<p>Since Evennia uses <a class="reference external" href="http://djangoproject.com">Django</a>, most of our notes are based off of what we
<p>Since Evennia uses <a class="reference external" href="https://djangoproject.com">Django</a>, most of our notes are based off of what we
know from the community and their documentation. While the information below may be useful, you can
always find the most up-to-date and “correct” information at Django’s <a class="reference external" href="http://docs.djangoproject.com/en/dev/ref/databases/#ref-databases">Notes about supported
always find the most up-to-date and “correct” information at Django’s <a class="reference external" href="https://docs.djangoproject.com/en/dev/ref/databases/#ref-databases">Notes about supported
Databases</a> page.</p>
<section id="sqlite3">
<h2>SQLite3<a class="headerlink" href="#sqlite3" title="Permalink to this headline"></a></h2>
@ -383,7 +383,7 @@ database.</p>
<section id="others">
<h2>Others<a class="headerlink" href="#others" title="Permalink to this headline"></a></h2>
<p>No testing has been performed with Oracle, but it is also supported through Django. There are
community maintained drivers for <a class="reference external" href="http://code.google.com/p/django-mssql/">MS SQL</a> and possibly a few
community maintained drivers for <a class="reference external" href="https://code.google.com/p/django-mssql/">MS SQL</a> and possibly a few
others. If you try other databases out, consider expanding this page with instructions.</p>
</section>
</section>
@ -442,11 +442,11 @@ others. If you try other databases out, consider expanding this page with instru
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

20
docs/1.0-dev/Setup/Client-Support-Grid.html
View file

@ -78,7 +78,7 @@ new <a class="reference external" href="https://github.com/evennia/evennia/issue
<td><p>5.0+</p></td>
<td><p>No UTF-8 support</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="http://mushclient.com/">MUSHclient</a> (Win)</p></td>
<tr class="row-odd"><td><p><a class="reference external" href="https://mushclient.com/">MUSHclient</a> (Win)</p></td>
<td><p>4.94</p></td>
<td><p>NAWS reports full text area</p></td>
</tr>
@ -90,12 +90,12 @@ new <a class="reference external" href="https://github.com/evennia/evennia/issue
<td><p>v3</p></td>
<td><p><em>UNTESTED</em></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="http://www.potatomushclient.com/">Potato</a></p></td>
<tr class="row-even"><td><p><a class="reference external" href="https://www.potatomushclient.com/">Potato</a></p></td>
<td><p>2.0.0b16</p></td>
<td><p>No MXP, MCCP support. Win 32bit does not understand
“localhost”, must use <cite>127.0.0.1</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="http://www.mudlet.org/">Mudlet</a></p></td>
<tr class="row-odd"><td><p><a class="reference external" href="https://www.mudlet.org/">Mudlet</a></p></td>
<td><p>3.4+</p></td>
<td><p>No known issues. Some older versions showed &lt;&gt; as html
under MXP.</p></td>
@ -104,7 +104,7 @@ under MXP.</p></td>
<td><p>full</p></td>
<td><p>Discontinued. NAWS reports pixel size.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="http://www.riverdark.net/atlantis/">Atlantis</a> (Mac)</p></td>
<tr class="row-odd"><td><p><a class="reference external" href="https://www.riverdark.net/atlantis/">Atlantis</a> (Mac)</p></td>
<td><p>0.9.9.4</p></td>
<td><p>No known issues.</p></td>
</tr>
@ -125,7 +125,7 @@ under MXP.</p></td>
<td><p>1.3.1</p></td>
<td><p><em>UNTESTED</em></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="http://bt.happygoatstudios.com/">BlowTorch</a> (Andr)</p></td>
<tr class="row-even"><td><p><a class="reference external" href="https://bt.happygoatstudios.com/">BlowTorch</a> (Andr)</p></td>
<td><p>1.1.3</p></td>
<td><p>Telnet NOP displays as spurious character.</p></td>
</tr>
@ -143,7 +143,7 @@ fails.</p></td>
<td><p>0.4</p></td>
<td><p>No MXP, OOB support.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="http://jamochamud.org/">JamochaMUD</a></p></td>
<tr class="row-even"><td><p><a class="reference external" href="https://jamochamud.org/">JamochaMUD</a></p></td>
<td><p>5.2</p></td>
<td><p>Does not support ANSI within MXP text.</p></td>
</tr>
@ -224,11 +224,11 @@ parameter to disable it for that Evennia account permanently.</p></li>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

10
docs/1.0-dev/Setup/Evennia-Game-Index.html
View file

@ -100,7 +100,7 @@ earlier version), you can also configure your index entry in your settings file
<span class="c1"># optional </span>
<span class="s1">&#39;long_description&#39;</span><span class="p">:</span>
<span class="s2">&quot;Longer description that can use Markdown like *bold*, _italic_&quot;</span>
<span class="s2">&quot;and [linkname](http://link.com). Use </span><span class="se">\n</span><span class="s2"> for line breaks.&quot;</span>
<span class="s2">&quot;and [linkname](https://link.com). Use </span><span class="se">\n</span><span class="s2"> for line breaks.&quot;</span>
<span class="s1">&#39;telnet_hostname&#39;</span><span class="p">:</span> <span class="s1">&#39;dummy.com&#39;</span><span class="p">,</span>
<span class="s1">&#39;telnet_port&#39;</span><span class="p">:</span> <span class="s1">&#39;1234&#39;</span><span class="p">,</span>
<span class="s1">&#39;web_client_url&#39;</span><span class="p">:</span> <span class="s1">&#39;dummy.com/webclient&#39;</span><span class="p">,</span>
@ -167,11 +167,11 @@ if you are not ready for players yet.</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

38
docs/1.0-dev/Setup/Extended-Installation.html
View file

@ -88,26 +88,26 @@ everything in the following sections.</p>
<li><p>Linux/Unix</p></li>
<li><p>Windows (Vista, Win7, Win8, Win10)</p></li>
<li><p>Mac OSX (&gt;=10.5 recommended)</p></li>
<li><p><a class="reference external" href="http://www.python.org">Python</a> (v3.7, 3.8 and 3.9 are tested)</p>
<li><p><a class="reference external" href="https://www.python.org">Python</a> (v3.7, 3.8 and 3.9 are tested)</p>
<ul>
<li><p><a class="reference external" href="http://pypi.python.org/pypi/virtualenv">virtualenv</a> for making isolated
<li><p><a class="reference external" href="https://pypi.python.org/pypi/virtualenv">virtualenv</a> for making isolated
Python environments. Installed with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">virtualenv</span></code>.</p></li>
</ul>
</li>
<li><p><a class="reference external" href="http://git-scm.com/">GIT</a> - version control software for getting and
<li><p><a class="reference external" href="https://git-scm.com/">GIT</a> - version control software for getting and
updating Evennia itself - Mac users can use the
<a class="reference external" href="http://code.google.com/p/git-osx-installer/">git-osx-installer</a> or the
<a class="reference external" href="http://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac">MacPorts version</a>.</p></li>
<li><p><a class="reference external" href="http://twistedmatrix.com">Twisted</a> (v19.0+)</p>
<a class="reference external" href="https://code.google.com/p/git-osx-installer/">git-osx-installer</a> or the
<a class="reference external" href="https://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac">MacPorts version</a>.</p></li>
<li><p><a class="reference external" href="https://twistedmatrix.com">Twisted</a> (v19.0+)</p>
<ul>
<li><p><a class="reference external" href="http://www.zope.org/Products/ZopeInterface">ZopeInterface</a> (v3.0+) - usually included in
<li><p><a class="reference external" href="https://www.zope.org/Products/ZopeInterface">ZopeInterface</a> (v3.0+) - usually included in
Twisted packages</p></li>
<li><p>Linux/Mac users may need the <code class="docutils literal notranslate"><span class="pre">gcc</span></code> and <code class="docutils literal notranslate"><span class="pre">python-dev</span></code> packages or equivalent.</p></li>
<li><p>Windows users need <a class="reference external" href="https://aka.ms/vs/16/release/vs_buildtools.exe">MS Visual C++</a> and <em>maybe</em>
<a class="reference external" href="https://pypi.python.org/pypi/pypiwin32">pypiwin32</a>.</p></li>
</ul>
</li>
<li><p><a class="reference external" href="http://www.djangoproject.com">Django</a> (v2.2.x), be warned that latest dev
<li><p><a class="reference external" href="https://www.djangoproject.com">Django</a> (v2.2.x), be warned that latest dev
version is usually untested with Evennia)</p></li>
</ul>
</section>
@ -208,17 +208,17 @@ created. Check out <a class="reference external" href="Setup/Getting-Started#whe
<section id="mac-install">
<h2>Mac Install<a class="headerlink" href="#mac-install" title="Permalink to this headline"></a></h2>
<p>The Evennia server is a terminal program. Open the terminal e.g. from
<em>Applications-&gt;Utilities-&gt;Terminal</em>. <a class="reference external" href="http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line">Here is an introduction to the Mac
<em>Applications-&gt;Utilities-&gt;Terminal</em>. <a class="reference external" href="https://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line">Here is an introduction to the Mac
terminal</a>
if you are unsure how it works. If you run into any issues during the
installation, please check out <a class="reference external" href="Setup/Getting-Started#mac-troubleshooting">Mac Troubleshooting</a>.</p>
<ul class="simple">
<li><p>Python should already be installed but you must make sure it’s a high enough version.
(<a class="reference external" href="http://docs.python-guide.org/en/latest/starting/install/osx/">This</a> discusses
(<a class="reference external" href="https://docs.python-guide.org/en/latest/starting/install/osx/">This</a> discusses
how you may upgrade it). Remember that you need Python3.7, not Python2.7!</p></li>
<li><p>GIT can be obtained with
<a class="reference external" href="http://code.google.com/p/git-osx-installer/">git-osx-installer</a> or via
MacPorts <a class="reference external" href="http://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac">as described
<a class="reference external" href="https://code.google.com/p/git-osx-installer/">git-osx-installer</a> or via
MacPorts <a class="reference external" href="https://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac">as described
here</a>.</p></li>
<li><p>If you run into issues with installing <code class="docutils literal notranslate"><span class="pre">Twisted</span></code> later you may need to
install gcc and the Python headers.</p></li>
@ -308,7 +308,7 @@ You should then follow the Linux install instructions above.</p>
</div></blockquote>
<p>The Evennia server itself is a command line program. In the Windows launch
menu, start <em>All Programs -&gt; Accessories -&gt; command prompt</em> and you will get
the Windows command line interface. Here is <a class="reference external" href="http://www.bleepingcomputer.com/tutorials/windows-command-prompt-introduction/">one of many tutorials on using the Windows command
the Windows command line interface. Here is <a class="reference external" href="https://www.bleepingcomputer.com/tutorials/windows-command-prompt-introduction/">one of many tutorials on using the Windows command
line</a>
if you are unfamiliar with it.</p>
<ul class="simple">
@ -321,7 +321,7 @@ to check-mark <em>all</em> install options, especially the one about making Pyth
available on the path (you may have to scroll to see it)</strong>. This allows you to
just write <code class="docutils literal notranslate"><span class="pre">python</span></code> in any console without first finding where the <code class="docutils literal notranslate"><span class="pre">python</span></code>
program actually sits on your hard drive.</p></li>
<li><p>You need to also get <a class="reference external" href="http://git-scm.com/downloads">GIT</a> and install it. You
<li><p>You need to also get <a class="reference external" href="https://git-scm.com/downloads">GIT</a> and install it. You
can use the default install options but when you get asked to “Adjust your PATH
environment”, you should select the second option “Use Git from the Windows
Command Prompt”, which gives you more freedom as to where you can use the
@ -457,7 +457,7 @@ Evennia has no major game systems out of the box, we do supply a range of option
you can use or borrow from. They range from dice rolling and alternative color schemes to barter and
combat systems. You can find the <a class="reference external" href="https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md">growing list of contribs
here</a>.</p>
<p>If you have any questions, you can always ask in <a class="reference external" href="http://webchat.freenode.net/?channels=evennia&amp;uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">the developer
<p>If you have any questions, you can always ask in <a class="reference external" href="https://webchat.freenode.net/?channels=evennia&amp;uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">the developer
chat</a>
<code class="docutils literal notranslate"><span class="pre">#evennia</span></code> on <code class="docutils literal notranslate"><span class="pre">irc.freenode.net</span></code> or by posting to the <a class="reference external" href="https://groups.google.com/forum/#%21forum/evennia">Evennia
forums</a>. You can also join the <a class="reference external" href="https://discord.gg/NecFePw">Discord
@ -584,11 +584,11 @@ you should update the line to the real location.</p></li>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

10
docs/1.0-dev/Setup/Grapevine.html
View file

@ -40,7 +40,7 @@
<section id="grapevine">
<h1>Grapevine<a class="headerlink" href="#grapevine" title="Permalink to this headline"></a></h1>
<p><a class="reference external" href="http://grapevine.haus">Grapevine</a> is a new chat network for <code class="docutils literal notranslate"><span class="pre">MU*</span></code>*** games. By
<p><a class="reference external" href="https://grapevine.haus">Grapevine</a> is a new chat network for <code class="docutils literal notranslate"><span class="pre">MU*</span></code>*** games. By
connecting an in-game channel to the grapevine network, players on your game
can chat with players in other games, also non-Evennia ones.</p>
<section id="configuring-grapevine">
@ -142,11 +142,11 @@ it to your channel in-game.</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/HAProxy-Config.html
View file

@ -329,11 +329,11 @@ uncommented in the config file, it will now start as a background process.</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

10
docs/1.0-dev/Setup/How-to-connect-Evennia-to-Twitter.html
View file

@ -40,7 +40,7 @@
<section id="how-to-connect-evennia-to-twitter">
<h1>How to connect Evennia to Twitter<a class="headerlink" href="#how-to-connect-evennia-to-twitter" title="Permalink to this headline"></a></h1>
<p><a class="reference external" href="http://en.wikipedia.org/wiki/twitter">Twitter</a> is an online social networking service that enables
<p><a class="reference external" href="https://en.wikipedia.org/wiki/twitter">Twitter</a> is an online social networking service that enables
users to send and read short 280-character messages called “tweets”. Following is a short tutorial
explaining how to enable users to send tweets from inside Evennia.</p>
<section id="configuring-twitter">
@ -224,11 +224,11 @@ help.</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

14
docs/1.0-dev/Setup/IRC.html
View file

@ -43,12 +43,12 @@
<p><em>Disambiguation: This page is related to using IRC inside an Evennia game. To join the official
Evennia IRC chat, connect to irc.freenode.net and join #evennia. Alternatively, you can <a class="reference external" href="https://discord.gg/NecFePw">join our
Discord</a>, which is mirrored to IRC.</em></p>
<p><a class="reference external" href="http://en.wikipedia.org/wiki/Internet_Relay_Chat">IRC (Internet Relay Chat)</a> is a long standing
<p><a class="reference external" href="https://en.wikipedia.org/wiki/Internet_Relay_Chat">IRC (Internet Relay Chat)</a> is a long standing
chat protocol used by many open-source projects for communicating in real time. By connecting one of
Evennia’s <a class="reference internal" href="../Components/Communications.html"><span class="doc">Channels</span></a> to an IRC channel you can communicate also with people not on
an mud themselves. You can also use IRC if you are only running your Evennia MUD locally on your
computer (your game doesn’t need to be open to the public)! All you need is an internet connection.
For IRC operation you also need <a class="reference external" href="http://twistedmatrix.com/trac/wiki/TwistedWords">twisted.words</a>.
For IRC operation you also need <a class="reference external" href="https://twistedmatrix.com/trac/wiki/TwistedWords">twisted.words</a>.
This is available simply as a package <em>python-twisted-words</em> in many Linux distros, or directly
downloadable from the link.</p>
<section id="configuring-irc">
@ -74,7 +74,7 @@ if you like), but for testing, let’s set up a new channel <code class="docutil
</div>
<p>You will automatically join the new channel.</p>
<p>Next we will create a connection to an external IRC network and channel. There are many, many IRC
nets. <a class="reference external" href="http://www.irchelp.org/irchelp/networks/popular.html">Here is a list</a> of some of the biggest
nets. <a class="reference external" href="https://www.irchelp.org/networks/popular.html">Here is a list</a> of some of the biggest
ones, the one you choose is not really very important unless you want to connect to a particular
channel (also make sure that the network allows for “bots” to connect).</p>
<p>For testing, we choose the <em>Freenode</em> network, <code class="docutils literal notranslate"><span class="pre">irc.freenode.net</span></code>. We will connect to a test
@ -160,11 +160,11 @@ name of the IRC channel you used (#evennia here).</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/Installing-on-Android.html
View file

@ -211,11 +211,11 @@ killed if your phone is heavily taxed. Termux seems to keep a notification up to
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

18
docs/1.0-dev/Setup/Online-Setup.html
View file

@ -73,7 +73,7 @@ start tailing the logs again.</p>
</div></blockquote>
<ul class="simple">
<li><p>Make sure you can connect with your web browser to <code class="docutils literal notranslate"><span class="pre">http://localhost:4001</span></code> or, alternatively,
<code class="docutils literal notranslate"><span class="pre">http:127.0.0.1:4001</span></code> which is the same thing. You should get your Evennia web site and be able to
<code class="docutils literal notranslate"><span class="pre">http://127.0.0.1:4001</span></code> which is the same thing. You should get your Evennia web site and be able to
play the game in the web client. Also check so that you can connect with a mud client to host
<code class="docutils literal notranslate"><span class="pre">localhost</span></code>, port <code class="docutils literal notranslate"><span class="pre">4000</span></code> or host <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code>, port <code class="docutils literal notranslate"><span class="pre">4000</span></code>.</p></li>
<li><p><a class="reference external" href="https://www.google.se/search?q=my+ip">Google for “my ip”</a> or use any online service to figure out
@ -384,7 +384,7 @@ your game. What you need is to alias it to a more sensible domain name - an alia
around also when the IP changes.</p>
<ol>
<li><p>To set up a domain name alias, we recommend starting with a free domain name from
<a class="reference external" href="http://freedns.afraid.org/">FreeDNS</a>. Once you register there (it’s free) you have access to tens
<a class="reference external" href="https://freedns.afraid.org/">FreeDNS</a>. Once you register there (it’s free) you have access to tens
of thousands domain names that people have “donated” to allow you to use for your own sub domain.
For example, <code class="docutils literal notranslate"><span class="pre">strangled.net</span></code> is one of those available domains. So tying our IP address to
<code class="docutils literal notranslate"><span class="pre">strangled.net</span></code> using the subdomain <code class="docutils literal notranslate"><span class="pre">evennia</span></code> would mean that one could henceforth direct people to
@ -395,7 +395,7 @@ and tell FreeDNS that. There are many alternatives to be found from FreeDNS:s ho
works on multiple platforms is <a class="reference external" href="http://www.inatech.eu/inadyn/">inadyn</a>. Get it from their page or,
in Linux, through something like <code class="docutils literal notranslate"><span class="pre">apt-get</span> <span class="pre">install</span> <span class="pre">inadyn</span></code>.</p></li>
<li><p>Next, you login to your account on FreeDNS and go to the
<a class="reference external" href="http://freedns.afraid.org/dynamic/">Dynamic</a> page. You should have a list of your subdomains. Click
<a class="reference external" href="https://freedns.afraid.org/dynamic/">Dynamic</a> page. You should have a list of your subdomains. Click
the <code class="docutils literal notranslate"><span class="pre">Direct</span> <span class="pre">URL</span></code> link and you’ll get a page with a text message. Ignore that and look at the URL of
the page. It should be ending in a lot of random letters. Everything after the question mark is your
unique “hash”. Copy this string.</p></li>
@ -472,7 +472,7 @@ region. You may find useful offers for “low cost” VPS hosting on [Low End Bo
Evennia users:</p>
<p>Hosting name | Type | Lowest price | Comments
:————–:|:——-:—————
<a class="reference external" href="Setup/http:silvren.com">silvren.com</a> | Shell account | Free for MU* | Private hobby provider so don’t assume backups
<a class="reference external" href="https://silvren.com">silvren.com</a> | Shell account | Free for MU* | Private hobby provider so don’t assume backups
or expect immediate support. To ask for an account, connect with a MUD client to iweb.localecho.net,
port 4201 and ask for “Jarin”.
[Digital Ocean][2] | VPS | $5/month | You can get a $50 credit if you use the referral link
@ -494,7 +494,7 @@ servers with this option as they don’t have a lot of support.
<em>Please help us expand this list.</em></p>
<p><a class="reference external" href="https://www.digitalocean.com/pricing">2</a>
<a class="reference external" href="https://aws.amazon.com/pricing/">3</a>
<a class="reference external" href="http://www.genesismuds.com/">4</a>
<a class="reference external" href="https://www.genesismuds.com/">4</a>
<a class="reference external" href="https://www.host1plus.com/">5</a>
<a class="reference external" href="https://www.scaleway.com/">6</a>
<a class="reference external" href="https://lowendbox.com/">7</a>
@ -584,11 +584,11 @@ https://aws.amazon.com/cloud9/</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

14
docs/1.0-dev/Setup/RSS.html
View file

@ -40,7 +40,7 @@
<section id="rss">
<h1>RSS<a class="headerlink" href="#rss" title="Permalink to this headline"></a></h1>
<p><a class="reference external" href="http://en.wikipedia.org/wiki/RSS">RSS</a> is a format for easily tracking updates on websites. The
<p><a class="reference external" href="https://en.wikipedia.org/wiki/RSS">RSS</a> is a format for easily tracking updates on websites. The
principle is simple - whenever a site is updated, a small text file is updated. An RSS reader can
then regularly go online, check this file for updates and let the user know what’s new.</p>
<p>Evennia allows for connecting any number of RSS feeds to any number of in-game channels. Updates to
@ -48,10 +48,10 @@ the feed will be conveniently echoed to the channel. There are many potential us
example the MUD might use a separate website to host its forums. Through RSS, the players can then
be notified when new posts are made. Another example is to let everyone know you updated your dev
blog. Admins might also want to track the latest Evennia updates through our own RSS feed
<a class="reference external" href="http://code.google.com/feeds/p/evennia/updates/basic">here</a>.</p>
<a class="reference external" href="https://code.google.com/feeds/p/evennia/updates/basic">here</a>.</p>
<section id="configuring-rss">
<h2>Configuring RSS<a class="headerlink" href="#configuring-rss" title="Permalink to this headline"></a></h2>
<p>To use RSS, you first need to install the <a class="reference external" href="http://code.google.com/p/feedparser/">feedparser</a> python
<p>To use RSS, you first need to install the <a class="reference external" href="https://code.google.com/p/feedparser/">feedparser</a> python
module.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">feedparser</span>
</pre></div>
@ -127,11 +127,11 @@ same channels as <a class="reference internal" href="IRC.html"><span class="doc"
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/Running-Evennia-in-Docker.html
View file

@ -368,11 +368,11 @@ line.</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/Security.html
View file

@ -239,11 +239,11 @@ ISP snooping.</p>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/Settings-File.html
View file

@ -74,11 +74,11 @@
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/Setup-Overview.html
View file

@ -140,11 +140,11 @@
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/Setup-Quickstart.html
View file

@ -187,11 +187,11 @@ a web browser at <a class="reference external" href="http://localhost:4001">http
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>

8
docs/1.0-dev/Setup/Start-Stop-Reload.html
View file

@ -278,11 +278,11 @@ In-game you should now get the message that the Server has successfully restarte
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Dev blog</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>