2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-06-15 21:52:33 +02:00
< head >
< meta charset = "utf-8" / >
2021-05-16 00:06:01 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" / >
2020-06-15 21:52:33 +02:00
< title > Evennia Introduction — 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 >
2021-10-26 21:41:11 +02:00
< 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 >
2020-06-13 23:31:27 +02:00
< link rel = "shortcut icon" href = "_static/favicon.ico" / >
2020-06-15 21:52:33 +02:00
< link rel = "index" title = "Index" href = "genindex.html" / >
2020-10-19 22:46:24 +02:00
< link rel = "search" title = "Search" href = "search.html" / >
2022-02-05 15:09:22 +00:00
< link rel = "next" title = "Starting Tutorial (Part 1)" href = "Howto/Starting/Part1/Starting-Part1.html" / >
2020-10-19 22:46:24 +02:00
< link rel = "prev" title = "Evennia Documentation" href = "index.html" / >
2020-06-15 21:52:33 +02:00
< / 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 >
2020-10-19 22:46:24 +02:00
< li class = "right" >
2022-02-05 15:09:22 +00:00
< a href = "Howto/Starting/Part1/Starting-Part1.html" title = "Starting Tutorial (Part 1)"
2020-10-19 22:46:24 +02:00
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "index.html" title = "Evennia Documentation"
accesskey="P">previous< / a > |< / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Evennia Introduction< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2020-06-13 00:36:45 +02:00
2021-10-26 21:41:11 +02:00
< section class = "tex2jax_ignore mathjax_ignore" id = "evennia-introduction" >
2020-06-13 00:36:45 +02:00
< h1 > Evennia Introduction< a class = "headerlink" href = "#evennia-introduction" title = "Permalink to this headline" > ¶< / a > < / h1 >
< blockquote >
2020-06-16 22:49:43 +02:00
< div > < p > < em > A MUD (originally Multi-User Dungeon, with later variants Multi-User Dimension and Multi-User
Domain) is a multiplayer real-time virtual world described primarily in text. MUDs combine elements
of role-playing games, hack and slash, player versus player, interactive fiction and online chat.
Players can read or view descriptions of rooms, objects, other players, non-player characters, and
actions performed in the virtual world. Players typically interact with each other and the world by
2021-08-06 00:47:51 +02:00
typing commands that resemble a natural language.< / em > - < a class = "reference external" href = "https://en.wikipedia.org/wiki/MUD" > Wikipedia< / a > < / p >
2020-06-13 00:36:45 +02:00
< / div > < / blockquote >
2020-06-16 22:49:43 +02:00
< p > If you are reading this, it’
2021-08-06 00:47:51 +02:00
massively-multiplayer game (< a class = "reference external" href = "https://tinyurl.com/c5sc4bm" > MUD/MUX/MUSH< / a > etc) of your very own. You
2020-06-16 22:49:43 +02:00
might just be starting to think about it, or you might have lugged around that < em > perfect< / em > game in
your mind for years … you know < em > just< / em > how good it would be, if you could only make it come to
reality. We know how you feel. That is, after all, why Evennia came to be.< / p >
2020-11-29 12:45:38 +01:00
< p > Evennia is a MU*-building system: a bare-bones Python codebase and server intended to
2020-06-16 22:49:43 +02:00
be highly extendable for any style of game. “Bare-bones” in this context means that we try to impose
2020-11-29 12:45:38 +01:00
as few game-specific things on you as possible. For convenience offer basic building
2020-06-16 22:49:43 +02:00
blocks like objects, characters, rooms, default commands for building and administration etc, we
don’
2020-11-29 12:45:38 +01:00
be different from game to game anyway.< / p >
2020-06-16 22:49:43 +02:00
< p > What we < em > do< / em > however, is to provide a solid foundation for all the boring database, networking, and
behind-the-scenes administration stuff that all online games need whether they like it or not.
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 >
2021-10-26 21:41:11 +02:00
< 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
2020-11-29 12:45:38 +01:00
would you want something to build from.< / p >
2020-06-16 22:49:43 +02:00
< 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
normal Python modules rather than some ad-hoc scripting language. The fact that you script the game
in the same high-level language that you code it in allows for very powerful and custom game
implementations indeed.< / p >
2020-11-29 12:45:38 +01:00
< p > Out of the box, Evennia gives you a ‘ ’
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
2021-10-26 21:41:11 +02:00
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’
2020-11-29 12:45:38 +01:00
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 >
2021-05-16 00:06:01 +02:00
< section id = "can-i-test-it-somewhere" >
2020-06-13 00:36:45 +02:00
< h2 > Can I test it somewhere?< a class = "headerlink" href = "#can-i-test-it-somewhere" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-11-29 12:45:38 +01:00
< p > Evennia’ < a class = "reference external" href = "https://demo.evennia.com" > https://demo.evennia.com< / a > . If you prefer to
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 >
2020-06-16 22:49:43 +02:00
< 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
2022-02-05 15:09:22 +00:00
single in-game command to install as explained < a class = "reference internal" href = "Howto/Starting/Part1/Tutorial-World.html" > < span class = "doc std std-doc" > here< / span > < / a > .< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "what-you-need-to-know-to-work-with-evennia" >
2020-06-13 00:36:45 +02:00
< 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 >
2022-02-05 15:09:22 +00:00
< p > Assuming you have Evennia working (see the < a class = "reference internal" href = "Setup/Installation.html" > < span class = "doc std std-doc" > quick start instructions< / span > < / a > ) and have
2020-06-16 22:49:43 +02:00
gotten as far as to start the server and connect to it with the client of your choice, here’
you need to know depending on your skills and needs.< / p >
2021-10-26 21:41:11 +02:00
< section id = "i-dont-know-or-dont-want-to-do-any-programming-i-just-want-to-run-a-game" >
< h3 > I don’ ’ < 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 >
2020-06-16 22:49:43 +02:00
< 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 ‘ ’
and describe rooms and basic objects, have chat channels, do emotes and other things suitable for a
social or free-form MU*. Combat, mobs and other game elements are not included, so you’
very basic game indeed if you are not willing to do at least < em > some< / em > coding.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "i-know-basic-python-or-i-am-willing-to-learn" >
2020-06-13 00:36:45 +02:00
< h3 > I know basic Python, or I am willing to learn< a class = "headerlink" href = "#i-know-basic-python-or-i-am-willing-to-learn" title = "Permalink to this headline" > ¶< / a > < / h3 >
2020-06-16 22:49:43 +02:00
< p > Evennia’ < a class = "reference external" href = "https://github.com/evennia/evennia" > viewable
2020-11-29 12:45:38 +01:00
online< / a > . We also have a comprehensive < a class = "reference external" href = "https://evennia.com/docs" > online
2020-06-16 22:49:43 +02:00
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
2021-10-26 21:41:11 +02:00
you are new to programming. Evennia’ < 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
2020-11-29 12:45:38 +01:00
to Python< / span > < / a > but you should probably also sit down
with a full Python beginner’
2021-10-26 21:41:11 +02:00
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
2020-06-16 22:49:43 +02:00
Evennia you don’
containing at least these basic Python features:< / p >
2020-06-13 00:36:45 +02:00
< ul class = "simple" >
2021-08-06 00:47:51 +02:00
< li > < p > Importing and using python < a class = "reference external" href = "https://docs.python.org/3.7/tutorial/modules.html" > modules< / a > < / p > < / li >
< li > < p > Using < a class = "reference external" href = "https://www.tutorialspoint.com/python/python_variable_types.htm" > variables< / a > , < a class = "reference external" href = "https://docs.python.org/tutorial/controlflow.html#if-statements" > conditional
2020-06-16 22:49:43 +02:00
statements< / a > ,
2021-08-06 00:47:51 +02:00
< a class = "reference external" href = "https://docs.python.org/tutorial/controlflow.html#for-statements" > loops< / a > and
< a class = "reference external" href = "https://docs.python.org/tutorial/controlflow.html#defining-functions" > functions< / a > < / p > < / li >
< li > < p > Using < a class = "reference external" href = "https://docs.python.org/tutorial/datastructures.html" > lists, dictionaries and list
2020-06-16 22:49:43 +02:00
comprehensions< / a > < / p > < / li >
2021-08-06 00:47:51 +02:00
< li > < p > Doing < a class = "reference external" href = "https://docs.python.org/tutorial/introduction.html#strings" > string handling and formatting< / a > < / p > < / li >
< li > < p > Have a basic understanding of < a class = "reference external" href = "https://www.tutorialspoint.com/python/python_classes_objects.htm" > object-oriented
2020-06-16 22:49:43 +02:00
programming< / a > , using
2021-08-06 00:47:51 +02:00
< a class = "reference external" href = "https://docs.python.org/tutorial/classes.html" > Classes< / a > , their methods and properties< / p > < / li >
2020-06-13 00:36:45 +02:00
< / ul >
2020-06-16 22:49:43 +02:00
< p > Obviously, the more things you feel comfortable with, the easier time you’
2021-10-26 21:41:11 +02:00
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
2020-06-16 22:49:43 +02:00
definitely build a whole advanced and customized game from extending Evennia’ < / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "i-know-my-python-stuff-and-i-am-willing-to-use-it" >
2020-06-13 00:36:45 +02:00
< h3 > I know my Python stuff and I am willing to use it!< a class = "headerlink" href = "#i-know-my-python-stuff-and-i-am-willing-to-use-it" title = "Permalink to this headline" > ¶< / a > < / h3 >
2020-06-16 22:49:43 +02:00
< p > Even if you started out as a Python beginner, you will likely get to this point after working on
your game for a while. With more general knowledge in Python the full power of Evennia opens up for
you. Apart from modifying commands, objects and scripts, you can develop everything from advanced
mob AI and economic systems, through sophisticated combat and social mini games, to redefining how
commands, players, rooms or channels themselves work. Since you code your game by importing normal
Python modules, there are few limits to what you can accomplish.< / p >
< p > If you < em > also< / em > happen to know some web programming (HTML, CSS, Javascript) there is also a web
presence (a website and a mud web client) to play around with …< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "where-to-from-here" >
2020-06-13 00:36:45 +02:00
< h3 > Where to from here?< a class = "headerlink" href = "#where-to-from-here" title = "Permalink to this headline" > ¶< / a > < / h3 >
2021-10-26 21:41:11 +02:00
< 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
2020-11-29 12:45:38 +01:00
dirty with code right away. You can also read the lead developer’ < a class = "reference external" href = "https://evennia.blogspot.com/" > dev blog< / a > for many tidbits and snippets about Evennia’
2020-06-16 22:49:43 +02:00
structure.< / p >
2020-06-13 00:36:45 +02:00
< p > Some more hints:< / p >
< ol class = "simple" >
2020-06-16 22:49:43 +02:00
< li > < p > Get engaged in the community. Make an introductory post to our < a class = "reference external" href = "https://groups.google.com/forum/#%21forum/evennia" > mailing
list/forum< / a > and get to know people. It’
2021-08-06 00:47:51 +02:00
highly recommended you hop onto our < a class = "reference external" href = "https://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb" > Developer
2020-06-16 22:49:43 +02:00
chat< / a >
on IRC. This allows you to chat directly with other developers new and old as well as with the devs
2021-10-26 21:41:11 +02:00
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
2020-06-16 22:49:43 +02:00
be searched from the same place for discussion topics you are interested in.< / p > < / li >
2021-10-26 21:41:11 +02:00
< 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
2020-06-16 22:49:43 +02:00
state of mind you should aim for - including cutting down the scope of your game for its first
release.< / p > < / li >
2021-10-26 21:41:11 +02:00
< 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
2020-06-16 22:49:43 +02:00
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 >
2020-06-13 00:36:45 +02:00
< / ol >
2021-05-16 00:06:01 +02:00
< / section >
< / section >
< / section >
2020-06-13 00:36:45 +02:00
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-06-13 00:36:45 +02:00
< / div >
< / div >
< / div >
2020-06-15 21:52:33 +02:00
< 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 = "#" > 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 >
2021-10-26 21:41:11 +02:00
< 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’ ’ < / a > < / li >
2020-06-15 21:52:33 +02:00
< 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 >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2020-06-13 00:36:45 +02:00
2020-10-19 22:46:24 +02:00
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "index.html"
title="previous chapter">Evennia Documentation< / a > < / p >
< h4 > Next topic< / h4 >
2022-02-05 15:09:22 +00:00
< p class = "topless" > < a href = "Howto/Starting/Part1/Starting-Part1.html"
title="next chapter">Starting Tutorial (Part 1)< / a > < / p >
2020-06-15 21:52:33 +02:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "_sources/Evennia-Introduction.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
2021-03-06 01:37:43 +01:00
< / div > < h3 > Links< / h3 >
< ul >
< 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 >
2021-08-06 00:47:51 +02:00
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
2021-08-06 00:53:44 +02:00
< a href = "https://evennia.blogspot.com/" > Blog< / a >
2021-03-06 01:37:43 +01:00
< / li >
< / ul >
2020-06-15 21:52:33 +02:00
< h3 > Versions< / h3 >
< ul >
< li > < a href = "Evennia-Introduction.html" > 1.0-dev (develop branch)< / a > < / li >
< / ul >
2020-06-14 21:48:02 +02:00
2020-06-15 21:52:33 +02:00
< / 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 >
2020-10-19 22:46:24 +02:00
< li class = "right" >
2022-02-05 15:09:22 +00:00
< a href = "Howto/Starting/Part1/Starting-Part1.html" title = "Starting Tutorial (Part 1)"
2020-10-19 22:46:24 +02:00
>next< / a > |< / li >
< li class = "right" >
< a href = "index.html" title = "Evennia Documentation"
>previous< / a > |< / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Evennia Introduction< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2020, The Evennia developer community.
2020-10-15 01:31:30 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
2020-06-15 21:52:33 +02:00
< / div >
< / body >
2020-06-13 00:36:45 +02:00
< / html >
