Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-01 21:47:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2021-10-26 21:41:11 +02:00
parent 66d0ad0bc9
commit 7900aad365
2073 changed files with 32986 additions and 41197 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/1.0-dev/Evennia-Introduction.html
View file

@ -14,6 +14,8 @@
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</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" />
@ -46,7 +48,7 @@
<div class="bodywrapper">
<div class="body" role="main">
<section id="evennia-introduction">
<section class="tex2jax_ignore mathjax_ignore" id="evennia-introduction">
<h1>Evennia Introduction<a class="headerlink" href="#evennia-introduction" title="Permalink to this headline"></a></h1>
<blockquote>
<div><p><em>A MUD (originally Multi-User Dungeon, with later variants Multi-User Dimension and Multi-User
@ -72,7 +74,7 @@ behind-the-scenes administration stuff that all online games need whether they l
Evennia is <em>fully persistent</em>, that means things you drop on the ground somewhere will still be
there a dozen server reboots later. Through Django we support a large variety of different database
systems (a database is created for you automatically if you use the defaults).</p>
<p>We also include a growing list of <em>optional</em> <a class="reference internal" href="Contribs/Contrib-Overview.html"><span class="doc">contribs</span></a> you can use for your game
<p>We also include a growing list of <em>optional</em> <a class="reference internal" href="Contribs/Contrib-Overview.html"><span class="doc std std-doc">contribs</span></a> you can use for your game
would you want something to build from.</p>
<p>Using the full power of Python throughout the server offers some distinct advantages. All your
coding, from object definitions and custom commands to AI scripts and economic systems is done in
@ -82,7 +84,7 @@ implementations indeed.</p>
<p>Out of the box, Evennia gives you a ‘talker’-type of game; you can walk around, chat, build rooms and objects,
do basic roleplaying and administration. The server ships with a default set of player commands that are
similar to the MUX command set. We <em>do not</em> aim specifically to be a MUX server, but we had to pick some
default to go with (see <a class="reference internal" href="Concepts/Soft-Code.html"><span class="doc">this</span></a> for more about our original motivations). It’s easy to
default to go with (see <a class="reference internal" href="Concepts/Soft-Code.html"><span class="doc std std-doc">this</span></a> for more about our original motivations). It’s easy to
remove or add commands, or to have the command syntax mimic other systems, like Diku, LP, MOO and so on.
Or why not create a new and better command system of your own design.</p>
<section id="can-i-test-it-somewhere">
@ -91,15 +93,15 @@ Or why not create a new and better command system of your own design.</p>
connect to the demo via your telnet client you can do so at <code class="docutils literal notranslate"><span class="pre">demo.evennia.com</span></code>, port <code class="docutils literal notranslate"><span class="pre">4000</span></code>.</p>
<p>Once you installed Evennia yourself it comes with its own tutorial - this shows off some of the
possibilities <em>and</em> gives you a small single-player quest to play. The tutorial takes only one
single in-game command to install as explained <a class="reference internal" href="Howto/Starting/Part1/Tutorial-World-Introduction.html"><span class="doc">here</span></a>.</p>
single in-game command to install as explained <a class="reference internal" href="Howto/Starting/Part1/Tutorial-World-Introduction.html"><span class="doc std std-doc">here</span></a>.</p>
</section>
<section id="what-you-need-to-know-to-work-with-evennia">
<h2>What you need to know to work with Evennia<a class="headerlink" href="#what-you-need-to-know-to-work-with-evennia" title="Permalink to this headline"></a></h2>
<p>Assuming you have Evennia working (see the <a class="reference internal" href="Setup/Setup-Quickstart.html"><span class="doc">quick start instructions</span></a>) and have
<p>Assuming you have Evennia working (see the <a class="reference internal" href="Setup/Setup-Quickstart.html"><span class="doc std std-doc">quick start instructions</span></a>) and have
gotten as far as to start the server and connect to it with the client of your choice, here’s what
you need to know depending on your skills and needs.</p>
<section id="i-don-t-know-or-don-t-want-to-do-any-programming-i-just-want-to-run-a-game">
<h3>I don’t know (or don’t want to do) any programming - I just want to run a game!<a class="headerlink" href="#i-don-t-know-or-don-t-want-to-do-any-programming-i-just-want-to-run-a-game" title="Permalink to this headline"></a></h3>
<section id="i-dont-know-or-dont-want-to-do-any-programming-i-just-want-to-run-a-game">
<h3>I don’t know (or don’t want to do) any programming - I just want to run a game!<a class="headerlink" href="#i-dont-know-or-dont-want-to-do-any-programming-i-just-want-to-run-a-game" title="Permalink to this headline"></a></h3>
<p>Evennia comes with a default set of commands for the Python newbies and for those who need to get a
game running <em>now</em>. Stock Evennia is enough for running a simple ‘Talker’-type game - you can build
and describe rooms and basic objects, have chat channels, do emotes and other things suitable for a
@ -112,11 +114,11 @@ very basic game indeed if you are not willing to do at least <em>some</em> codin
online</a>. We also have a comprehensive <a class="reference external" href="https://evennia.com/docs">online
manual</a> with lots of examples. But while Python is
considered a very easy programming language to get into, you do have a learning curve to climb if
you are new to programming. Evennia’s <a class="reference internal" href="Howto/Starting/Part1/Starting-Part1.html"><span class="doc">Starting-tutorial</span></a> has a <a class="reference internal" href="Howto/Starting/Part1/Python-basic-introduction.html"><span class="doc">basic introduction
you are new to programming. Evennia’s <a class="reference internal" href="Howto/Starting/Part1/Starting-Part1.html"><span class="doc std std-doc">Starting-tutorial</span></a> has a <a class="reference internal" href="Howto/Starting/Part1/Python-basic-introduction.html"><span class="doc std std-doc">basic introduction
to Python</span></a> but you should probably also sit down
with a full Python beginner’s tutorial at some point (there are plenty of them on
the web if you look around). See also our <a class="reference external" href="Links.html#wiki-litterature">link
page</a> for some reading suggestions. To efficiently code your dream game in
the web if you look around). See also our <a class="reference internal" href="Links.html"><span class="doc std std-doc">link
page</span></a> for some reading suggestions. To efficiently code your dream game in
Evennia you don’t need to be a Python guru, but you do need to be able to read example code
containing at least these basic Python features:</p>
<ul class="simple">
@ -133,8 +135,8 @@ programming</a>, using
<a class="reference external" href="https://docs.python.org/tutorial/classes.html">Classes</a>, their methods and properties</p></li>
</ul>
<p>Obviously, the more things you feel comfortable with, the easier time you’ll have to find your way.
With just basic knowledge you should be able to define your own <a class="reference internal" href="Components/Commands.html"><span class="doc">Commands</span></a>, create custom
<a class="reference internal" href="Components/Objects.html"><span class="doc">Objects</span></a> as well as make your world come alive with basic <a class="reference internal" href="Components/Scripts.html"><span class="doc">Scripts</span></a>. You can
With just basic knowledge you should be able to define your own <a class="reference internal" href="Components/Commands.html"><span class="doc std std-doc">Commands</span></a>, create custom
<a class="reference internal" href="Components/Objects.html"><span class="doc std std-doc">Objects</span></a> as well as make your world come alive with basic <a class="reference internal" href="Components/Scripts.html"><span class="doc std std-doc">Scripts</span></a>. You can
definitely build a whole advanced and customized game from extending Evennia’s examples only.</p>
</section>
<section id="i-know-my-python-stuff-and-i-am-willing-to-use-it">
@ -150,8 +152,8 @@ presence (a website and a mud web client) to play around with …</p>
</section>
<section id="where-to-from-here">
<h3>Where to from here?<a class="headerlink" href="#where-to-from-here" title="Permalink to this headline"></a></h3>
<p>From here you can continue browsing the [online documentation](<a class="reference external" href="index:Evennia-documentation">online documentation</a>) to
find more info about Evennia. Or you can jump into the <a class="reference internal" href="Howto/Howto-Overview.html"><span class="doc">Tutorials</span></a> and get your hands
<p>From here you can continue browsing the <a class="reference internal" href="index.html"><span class="doc std std-doc">online documentation</span></a> to
find more info about Evennia. Or you can jump into the <a class="reference internal" href="Howto/Howto-Overview.html"><span class="doc std std-doc">Tutorials</span></a> and get your hands
dirty with code right away. You can also read the lead developer’s <a class="reference external" href="https://evennia.blogspot.com/">dev blog</a> for many tidbits and snippets about Evennia’s development and
structure.</p>
<p>Some more hints:</p>
@ -161,12 +163,12 @@ list/forum</a> and get to know people. It’s also
highly recommended you hop onto our <a class="reference external" href="https://webchat.freenode.net/?channels=evennia&amp;uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">Developer
chat</a>
on IRC. This allows you to chat directly with other developers new and old as well as with the devs
of Evennia itself. This chat is logged (you can find links on https://www.evennia.com) and can also
of Evennia itself. This chat is logged (you can find links on <a class="reference external" href="https://www.evennia.com">https://www.evennia.com</a>) and can also
be searched from the same place for discussion topics you are interested in.</p></li>
<li><p>Read the <a class="reference internal" href="Howto/Starting/Part2/Game-Planning.html"><span class="doc">Game Planning</span></a> wiki page. It gives some ideas for your work flow and the
<li><p>Read the <a class="reference internal" href="Howto/Starting/Part2/Game-Planning.html"><span class="doc std std-doc">Game Planning</span></a> wiki page. It gives some ideas for your work flow and the
state of mind you should aim for - including cutting down the scope of your game for its first
release.</p></li>
<li><p>Do the <a class="reference internal" href="Howto/Starting/Part3/Tutorial-for-basic-MUSH-like-game.html"><span class="doc">Tutorial for basic MUSH-like game</span></a> carefully from
<li><p>Do the <a class="reference internal" href="Howto/Starting/Part3/Tutorial-for-basic-MUSH-like-game.html"><span class="doc std std-doc">Tutorial for basic MUSH-like game</span></a> carefully from
beginning to end and try to understand what does what. Even if you are not interested in a MUSH for
your own game, you will end up with a small (very small) game that you can build or learn from.</p></li>
</ol>
@ -199,7 +201,7 @@ your own game, you will end up with a small (very small) game that you can build
<li><a class="reference internal" href="#">Evennia Introduction</a><ul>
<li><a class="reference internal" href="#can-i-test-it-somewhere">Can I test it somewhere?</a></li>
<li><a class="reference internal" href="#what-you-need-to-know-to-work-with-evennia">What you need to know to work with Evennia</a><ul>
<li><a class="reference internal" href="#i-don-t-know-or-don-t-want-to-do-any-programming-i-just-want-to-run-a-game">I don’t know (or don’t want to do) any programming - I just want to run a game!</a></li>
<li><a class="reference internal" href="#i-dont-know-or-dont-want-to-do-any-programming-i-just-want-to-run-a-game">I don’t know (or don’t want to do) any programming - I just want to run a game!</a></li>
<li><a class="reference internal" href="#i-know-basic-python-or-i-am-willing-to-learn">I know basic Python, or I am willing to learn</a></li>
<li><a class="reference internal" href="#i-know-my-python-stuff-and-i-am-willing-to-use-it">I know my Python stuff and I am willing to use it!</a></li>
<li><a class="reference internal" href="#where-to-from-here">Where to from here?</a></li>
@ -235,7 +237,7 @@ your own game, you will end up with a small (very small) game that you can build
<h3>Versions</h3>
<ul>
<li><a href="Evennia-Introduction.html">1.0-dev (develop branch)</a></li>
<li><a href="../0.9.5/Evennia-Introduction.html">0.9.5 (v0.9.5 branch)</a></li>
<li><a href="../0.95/Evennia-Introduction.html">0.95 (v0.9.5 branch)</a></li>
</ul>
</div>