mirror of
https://github.com/evennia/evennia.git
synced 2026-03-19 06:16:31 +01:00
255 lines
No EOL
18 KiB
HTML
255 lines
No EOL
18 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Overview of the Evennia library — Evennia 1.0-dev documentation</title>
|
||
<link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||
<script src="../../../_static/jquery.js"></script>
|
||
<script src="../../../_static/underscore.js"></script>
|
||
<script src="../../../_static/doctools.js"></script>
|
||
<script src="../../../_static/language_data.js"></script>
|
||
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../../search.html" />
|
||
<link rel="next" title="Persistent objects and typeclasses" href="Learning-Typeclasses.html" />
|
||
<link rel="prev" title="Python Classes and objects" href="Python-classes-and-objects.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../../../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../../../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="Learning-Typeclasses.html" title="Persistent objects and typeclasses"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="Python-classes-and-objects.html" title="Python Classes and objects"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia 1.0-dev</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="Starting-Part1.html" accesskey="U">Starting Tutorial (Part 1)</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Overview of the Evennia library</a></li>
|
||
</ul>
|
||
<div class="develop">develop branch</div>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="overview-of-the-evennia-library">
|
||
<h1>Overview of the Evennia library<a class="headerlink" href="#overview-of-the-evennia-library" title="Permalink to this headline">¶</a></h1>
|
||
<div class="sidebar">
|
||
<p class="sidebar-title">API</p>
|
||
<p>API stands for <cite>Application Programming Interface</cite>, a description for how to access
|
||
the resources of a program or library.</p>
|
||
</div>
|
||
<p>A good place to start exploring Evennia is the <a class="reference internal" href="../../../Evennia-API.html"><span class="doc">Evenia-API frontpage</span></a>.
|
||
This page sums up the main components of Evennia with a short description of each. Try clicking through
|
||
to a few entries - once you get deep enough you’ll see full descriptions
|
||
of each component along with their documentation. You can also click <code class="docutils literal notranslate"><span class="pre">[source]</span></code> to see the full Python source
|
||
for each thing.</p>
|
||
<p>You can also browse <a class="reference external" href="https://github.com/evennia/evennia">the evennia repository on github</a>. This is exactly
|
||
what you can download from us. The github repo is also searchable.</p>
|
||
<p>Finally, you can clone the evennia repo to your own computer and read the sources locally. This is necessary
|
||
if you want to help with Evennia’s development itself. See the
|
||
<a class="reference internal" href="../../../Setup/Extended-Installation.html"><span class="doc">extended install instructions</span></a> if you want to do this.</p>
|
||
<div class="section" id="where-is-it">
|
||
<h2>Where is it?<a class="headerlink" href="#where-is-it" title="Permalink to this headline">¶</a></h2>
|
||
<p>If Evennia is installed, you can import from it simply with</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">evennia</span>
|
||
<span class="kn">from</span> <span class="nn">evennia</span> <span class="k">import</span> <span class="n">some_module</span>
|
||
<span class="kn">from</span> <span class="nn">evennia.some_module.other_module</span> <span class="k">import</span> <span class="n">SomeClass</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>and so on.</p>
|
||
<p>If you installed Evennia with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code>, the library folder will be installed deep inside your Python
|
||
installation. If you cloned the repo there will be a folder <code class="docutils literal notranslate"><span class="pre">evennia</span></code> on your hard drive there.</p>
|
||
<p>If you cloned the repo or read the code on <code class="docutils literal notranslate"><span class="pre">github</span></code> you’ll find this being the outermost structure:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">evennia</span><span class="o">/</span>
|
||
<span class="nb">bin</span><span class="o">/</span>
|
||
<span class="n">CHANGELOG</span><span class="o">.</span><span class="n">md</span>
|
||
<span class="o">...</span>
|
||
<span class="o">...</span>
|
||
<span class="n">docs</span><span class="o">/</span>
|
||
<span class="n">evennia</span><span class="o">/</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This outer layer is for Evennia’s installation and package distribution. That internal folder <code class="docutils literal notranslate"><span class="pre">evennia/evennia/</span></code> is
|
||
the <em>actual</em> library, the thing covered by the API auto-docs and what you get when you do <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">evennia</span></code>.</p>
|
||
<blockquote>
|
||
<div><p>The <code class="docutils literal notranslate"><span class="pre">evennia/docs/</span></code> folder contains the sources for this documentation. See
|
||
<a class="reference internal" href="../../../Contributing-Docs.html"><span class="doc">contributing to the docs</span></a> if you want to learn more about how this works.</p>
|
||
</div></blockquote>
|
||
<p>This the the structure of the Evennia library:</p>
|
||
<ul class="simple">
|
||
<li><p>evennia</p>
|
||
<ul>
|
||
<li><p><a class="reference external" href="../../../Evennia-API#shortcuts"><code class="docutils literal notranslate"><span class="pre">__init__.py</span></code></a> - The “flat API” of Evennia resides here.</p></li>
|
||
<li><p><a class="reference external" href="../../../Components/Server-Conf#Settings-file"><code class="docutils literal notranslate"><span class="pre">settings_default.py</span></code></a> - Root settings of Evennia. Copy settings
|
||
from here to <code class="docutils literal notranslate"><span class="pre">mygame/server/settings.py</span></code> file.</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Commands.html"><span class="doc">commands/</span></a> - The command parser and handler.</p>
|
||
<ul>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">default/</span></code> - The <a class="reference external" href="../../../api/evennia.commands.default.html#modules">default commands</a> and cmdsets.</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="../../../Components/Communications.html"><span class="doc">comms/</span></a> - Systems for communicating in-game.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">contrib/</span></code> - Optional plugins too game-specific for core Evennia.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">game_template/</span></code> - Copied to become the “game directory” when using <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">--init</span></code>.</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Help-System.html"><span class="doc">help/</span></a> - Handles the storage and creation of help entries.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">locale/</span></code> - Language files (<a class="reference internal" href="../../../Concepts/Internationalization.html"><span class="doc">i18n</span></a>).</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Locks.html"><span class="doc">locks/</span></a> - Lock system for restricting access to in-game entities.</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Objects.html"><span class="doc">objects/</span></a> - In-game entities (all types of items and Characters).</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Spawner-and-Prototypes.html"><span class="doc">prototypes/</span></a> - Object Prototype/spawning system and OLC menu</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Accounts.html"><span class="doc">accounts/</span></a> - Out-of-game Session-controlled entities (accounts, bots etc)</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Scripts.html"><span class="doc">scripts/</span></a> - Out-of-game entities equivalence to Objects, also with timer support.</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Portal-And-Server.html"><span class="doc">server/</span></a> - Core server code and Session handling.</p>
|
||
<ul>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">portal/</span></code> - Portal proxy and connection protocols.</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="../../../Components/Typeclasses.html"><span class="doc">typeclasses/</span></a> - Abstract classes for the typeclass storage and database system.</p></li>
|
||
<li><p><a class="reference internal" href="../../../Components/Coding-Utils.html"><span class="doc">utils/</span></a> - Various miscellaneous useful coding resources.</p></li>
|
||
<li><p><a class="reference internal" href="../../../Concepts/Web-Features.html"><span class="doc">web/</span></a> - Web resources and webserver. Partly copied into game directory on initialization.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div class="sidebar">
|
||
<p class="sidebar-title">__init__.py</p>
|
||
<p>The <cite>__init__.py</cite> file is a special Python filename used to represent a Python ‘package’.
|
||
When you import <cite>evennia</cite> on its own, you import this file. When you do <cite>evennia.foo</cite> Python will
|
||
first look for a property <cite>.foo</cite> in <cite>__init__.py</cite> and then for a module or folder of that name
|
||
in the same location.</p>
|
||
</div>
|
||
<p>While all the actual Evennia code is found in the various folders, the <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code> represents the entire
|
||
package <code class="docutils literal notranslate"><span class="pre">evennia</span></code>. It contains “shortcuts” to code that is actually located elsewhere. Most of these shortcuts
|
||
are listed if you <a class="reference internal" href="../../../Evennia-API.html"><span class="doc">scroll down a bit</span></a> on the Evennia-API page.</p>
|
||
</div>
|
||
<div class="section" id="an-example-of-exploring-the-library">
|
||
<h2>An example of exploring the library<a class="headerlink" href="#an-example-of-exploring-the-library" title="Permalink to this headline">¶</a></h2>
|
||
<p>In the previous lesson we took a brief look at <code class="docutils literal notranslate"><span class="pre">mygame/typeclasses/objects</span></code> as an example of a Python module. Let’s
|
||
open it again. Inside is the <code class="docutils literal notranslate"><span class="pre">Object</span></code> class, which inherits from <code class="docutils literal notranslate"><span class="pre">DefaultObject</span></code>.
|
||
Near the top of the module is this line:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia</span> <span class="k">import</span> <span class="n">DefaultObject</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>We want to figure out just what this DefaultObject offers. Since this is imported directly from <code class="docutils literal notranslate"><span class="pre">evennia</span></code>, we
|
||
are actually importing from <code class="docutils literal notranslate"><span class="pre">evennia/__init__.py</span></code>.</p>
|
||
<p><a class="reference external" href="Howto/Starting/Part1/evennia/__init__.py#L189">Look at Line 189</a> of <code class="docutils literal notranslate"><span class="pre">evennia/__init__.py</span></code> and you’ll find this line:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">.objects.objects</span> <span class="k">import</span> <span class="n">DefaultObject</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="sidebar">
|
||
<p class="sidebar-title">Relative and absolute imports</p>
|
||
<p>The first full-stop in <cite>from .objects.objects …</cite> means that
|
||
we are importing from the current location. This is called a <cite>relative import</cite>.
|
||
By comparison, <cite>from evennia.objects.objects</cite> is an <cite>absolute import</cite>. In this particular
|
||
case, the two would give the same result.</p>
|
||
</div>
|
||
<blockquote>
|
||
<div><p>You can also look at <a class="reference external" href="Evennia-API.html#typeclasses">the right section of the API frontpage</a> and click through
|
||
to the code that way.</p>
|
||
</div></blockquote>
|
||
<p>The fact that <code class="docutils literal notranslate"><span class="pre">DefaultObject</span></code> is imported into <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code> here is what makes it possible to also import
|
||
it as <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">evennia</span> <span class="pre">import</span> <span class="pre">DefaultObject</span></code> even though the code for the class is not actually here.</p>
|
||
<p>So to find the code for <code class="docutils literal notranslate"><span class="pre">DefaultObject</span></code> we need to look in <code class="docutils literal notranslate"><span class="pre">evennia/objects/objects.py</span></code>. Here’s how
|
||
to look it up in the docs:</p>
|
||
<ol class="simple">
|
||
<li><p>Open the <a class="reference internal" href="../../../Evennia-API.html"><span class="doc">API frontpage</span></a></p></li>
|
||
<li><p>Locate the link to <a class="reference external" href="../../../api/evennia.objects.html">evennia.objects</a> and click on it.</p></li>
|
||
<li><p>Click through to <a class="reference external" href="../../../api/evennia.objects.objects.html">evennia.objects.objects</a>.</p></li>
|
||
<li><p>You are now in the python module. Scroll down (or search in your web browser) to find the <code class="docutils literal notranslate"><span class="pre">DefaultObject</span></code> class.</p></li>
|
||
<li><p>You can now read what this does and what methods are on it. If you want to see the full source, click the
|
||
[<a class="reference external" href="../../../_modules/evennia/objects/objects.html#DefaultObject">source</a>] link.</p></li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../../../index.html">
|
||
<img class="logo" src="../../../_static/evennia_logo.png" alt="Logo"/>
|
||
</a></p>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../../../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
<p><h3><a href="../../../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Overview of the Evennia library</a><ul>
|
||
<li><a class="reference internal" href="#where-is-it">Where is it?</a></li>
|
||
<li><a class="reference internal" href="#an-example-of-exploring-the-library">An example of exploring the library</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="Python-classes-and-objects.html"
|
||
title="previous chapter">Python Classes and objects</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="Learning-Typeclasses.html"
|
||
title="next chapter">Persistent objects and typeclasses</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../../../_sources/Howto/Starting/Part1/Evennia-Library-Overview.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="Evennia-Library-Overview.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="../../../../0.9.5/index.html">0.9.5 (master branch)</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../../../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="../../../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="Learning-Typeclasses.html" title="Persistent objects and typeclasses"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="Python-classes-and-objects.html" title="Python Classes and objects"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia 1.0-dev</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="Starting-Part1.html" >Starting Tutorial (Part 1)</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Overview of the Evennia library</a></li>
|
||
</ul>
|
||
<div class="develop">develop branch</div>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |