2020-07-14 00:21:00 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-07-14 00:21:00 +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-07-14 00:21:00 +02:00
< title > Setup quickstart — 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-07-14 00:21:00 +02:00
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
2020-10-19 22:46:24 +02:00
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Starting Tutorial (Part 1)" href = "../Howto/Starting/Part1/Starting-Part1.html" / >
< link rel = "prev" title = "Evennia Introduction" href = "../Evennia-Introduction.html" / >
2020-07-14 00:21:00 +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" >
< a href = "../Howto/Starting/Part1/Starting-Part1.html" title = "Starting Tutorial (Part 1)"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "../Evennia-Introduction.html" title = "Evennia Introduction"
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 = "" > Setup quickstart< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2021-10-26 21:41:11 +02:00
< section class = "tex2jax_ignore mathjax_ignore" id = "setup-quickstart" >
2020-07-14 00:21:00 +02:00
< h1 > Setup quickstart< a class = "headerlink" href = "#setup-quickstart" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the
server doesn’
in complete isolation if you want, without needing any access to the internet.< / p >
2021-05-16 00:06:01 +02:00
< section id = "installation" >
2020-07-14 00:21:00 +02:00
< h2 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-05-16 00:06:01 +02:00
< p > Evennia supports Python 3.7 to 3.9. As with most Python packages, using a
2021-10-26 21:41:11 +02:00
< a class = "reference internal" href = "../Glossary.html#virtualenv" > < span class = "std std-doc" > virtualenv< / span > < / a > is recommended in order to keep your
2020-07-14 00:21:00 +02:00
installation independent from the system libraries. It’ < em > not< / em > recommended
to install Evennia as superuser.< / p >
2020-11-14 11:55:52 +01:00
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< p > This is not yet available. Switch to the 0.9.5 version of these docs to install Evennia.< / p >
< / div >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > pip install evennia
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > Make sure the < code class = "docutils literal notranslate" > < span class = "pre" > evennia< / span > < / code > command works. Use < code class = "docutils literal notranslate" > < span class = "pre" > evennia< / span > < span class = "pre" > -h< / span > < / code > for usage help (or read on).< / p >
2021-05-16 00:06:01 +02:00
< p > If you are having trouble, want to install in some other way (like with Docker)
2021-10-26 21:41:11 +02:00
or want to contribute to Evennia itself, check out the < a class = "reference internal" href = "Extended-Installation.html" > < span class = "doc std std-doc" > Extended Installation
instructions< / span > < / a > . It also has a < a class = "reference internal" href = "Extended-Installation.html#troubleshooting" > < span class = "std std-doc" > troubleshooting
section< / span > < / a > for different operating
2020-07-14 00:21:00 +02:00
systems.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "initialize-a-new-game" >
2020-07-14 00:21:00 +02:00
< h2 > Initialize a new game< a class = "headerlink" href = "#initialize-a-new-game" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Use < code class = "docutils literal notranslate" > < span class = "pre" > cd< / span > < / code > to enter a folder where you want to do your game development. Here (and in
the rest of the Evennia documentation) we call this folder < code class = "docutils literal notranslate" > < span class = "pre" > mygame< / span > < / code > , but you should of course
name your game whatever you like:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia --init mygame
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > This will create a new folder < code class = "docutils literal notranslate" > < span class = "pre" > mygame< / span > < / code > (or whatever you chose) in your current location. This
contains empty templates and all the default settings needed to start the server.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "start-the-new-game" >
2020-07-14 00:21:00 +02:00
< h2 > Start the new game< a class = "headerlink" href = "#start-the-new-game" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < code class = "docutils literal notranslate" > < span class = "pre" > cd< / span > < / code > into your game folder (< code class = "docutils literal notranslate" > < span class = "pre" > mygame< / span > < / code > in our case). Next, run< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia migrate
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > This will create the default database (Sqlite3). The database file ends up as < code class = "docutils literal notranslate" > < span class = "pre" > mygame/server/evennia.db3< / span > < / code > . If you
ever want to start from a fresh database, just delete this file and re-run < code class = "docutils literal notranslate" > < span class = "pre" > evennia< / span > < span class = "pre" > migrate< / span > < / code > again.< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia start
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > Set your user-name and password when prompted. This will be the “god user” or “superuser” in-game. The email is optional.< / p >
< p > If all went well, the server is now up and running. Point a legacy MUD/telnet client to < code class = "docutils literal notranslate" > < span class = "pre" > localhost:4000< / span > < / code > or
a web browser at < a class = "reference external" href = "http://localhost:4001" > http://localhost:4001< / a > to play your new (if empty) game!< / p >
< blockquote >
< div > < p > If < code class = "docutils literal notranslate" > < span class = "pre" > localhost< / span > < / code > doesn’ < code class = "docutils literal notranslate" > < span class = "pre" > 127.0.0.1< / span > < / code > , which is the same thing.< / p >
< / div > < / blockquote >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "see-server-logs" >
2020-07-14 00:21:00 +02:00
< h2 > See server logs< a class = "headerlink" href = "#see-server-logs" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > This will echol the server logs to the terminal as they come in:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia --log
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > or< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia -l
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > You can also start logging immediately when running < code class = "docutils literal notranslate" > < span class = "pre" > evennia< / span > < / code > commands, such as< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia start -l
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > To exit the log view, enter < code class = "docutils literal notranslate" > < span class = "pre" > Ctrl-C< / span > < / code > (< code class = "docutils literal notranslate" > < span class = "pre" > Cmd-C< / span > < / code > for Mac). This will not affect the server.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "restarting-and-stopping" >
2020-07-14 00:21:00 +02:00
< h2 > Restarting and stopping< a class = "headerlink" href = "#restarting-and-stopping" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > You can restart the server without disconnecting any connected players:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia restart
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > To do a full stop and restart (will disconnect everyone):< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia reboot
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
< p > Full stop of the server (will need to use < code class = "docutils literal notranslate" > < span class = "pre" > start< / span > < / code > to activate it again):< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > evennia stop
2020-07-14 00:21:00 +02:00
< / pre > < / div >
< / div >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "the-next-step" >
2020-07-14 00:21:00 +02:00
< h2 > The Next step< a class = "headerlink" href = "#the-next-step" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-10-26 21:41:11 +02:00
< p > Why not head into the < a class = "reference internal" href = "../Howto/Starting/Part1/Starting-Part1.html" > < span class = "doc std std-doc" > Starting Tutorial< / span > < / a > to learn how to start making your new game!< / p >
2021-05-16 00:06:01 +02:00
< / section >
< / section >
2020-07-14 00:21:00 +02:00
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-07-14 00:21:00 +02:00
< / 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 = "#" > Setup quickstart< / a > < ul >
< li > < a class = "reference internal" href = "#installation" > Installation< / a > < / li >
< li > < a class = "reference internal" href = "#initialize-a-new-game" > Initialize a new game< / a > < / li >
< li > < a class = "reference internal" href = "#start-the-new-game" > Start the new game< / a > < / li >
< li > < a class = "reference internal" href = "#see-server-logs" > See server logs< / a > < / li >
< li > < a class = "reference internal" href = "#restarting-and-stopping" > Restarting and stopping< / a > < / li >
< li > < a class = "reference internal" href = "#the-next-step" > The Next step< / a > < / li >
< / ul >
< / li >
< / ul >
2020-10-19 22:46:24 +02:00
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "../Evennia-Introduction.html"
title="previous chapter">Evennia Introduction< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "../Howto/Starting/Part1/Starting-Part1.html"
title="next chapter">Starting Tutorial (Part 1)< / a > < / p >
2020-07-14 00:21:00 +02:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Setup/Setup-Quickstart.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-07-14 00:21:00 +02:00
< h3 > Versions< / h3 >
< ul >
< li > < a href = "Setup-Quickstart.html" > 1.0-dev (develop 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 >
2020-10-19 22:46:24 +02:00
< li class = "right" >
< a href = "../Howto/Starting/Part1/Starting-Part1.html" title = "Starting Tutorial (Part 1)"
>next< / a > |< / li >
< li class = "right" >
< a href = "../Evennia-Introduction.html" title = "Evennia Introduction"
>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 = "" > Setup quickstart< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +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-07-14 00:21:00 +02:00
< / div >
< / body >
< / html >
