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 > Installing on Android — Evennia 1.0-dev documentation< / title >
2020-07-14 00:21:00 +02:00
< 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" / >
2022-02-06 18:34:09 +00:00
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Upgrading an existing installation" href = "Installation-Upgrade.html" / >
< link rel = "prev" title = "Installation Troubleshooting" href = "Installation-Troubleshooting.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" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
accesskey="I">index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / a > |< / li >
2022-02-06 18:34:09 +00:00
< li class = "right" >
< a href = "Installation-Upgrade.html" title = "Upgrading an existing installation"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "Installation-Troubleshooting.html" title = "Installation Troubleshooting"
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 >
2022-02-06 18:34:09 +00:00
< li class = "nav-item nav-item-1" > < a href = "Setup-Overview.html" accesskey = "U" > Server Setup and Life< / a > » < / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-this" > < a href = "" > Installing on Android< / 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 = "installing-on-android" >
2020-06-13 00:36:45 +02:00
< h1 > Installing on Android< a class = "headerlink" href = "#installing-on-android" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > This page describes how to install and run the Evennia server on an Android phone. This will involve
installing a slew of third-party programs from the Google Play store, so make sure you are okay with
this before starting.< / p >
2022-02-05 15:58:44 +00:00
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< p > Android installation is experimental and not tested with later versions of Android.
Report your findings.< / p >
2022-02-05 15:09:22 +00:00
< / div >
2021-05-16 00:06:01 +02:00
< section id = "install-termux" >
2020-06-13 00:36:45 +02:00
< h2 > Install Termux< a class = "headerlink" href = "#install-termux" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-16 22:49:43 +02:00
< p > The first thing to do is install a terminal emulator that allows a “full” version of linux to be
run. Note that Android is essentially running on top of linux so if you have a rooted phone, you may
be able to skip this step. You < em > don’ < / em > require a rooted phone to install Evennia though.< / p >
< p > Assuming we do not have root, we will install
< a class = "reference external" href = "https://play.google.com/store/apps/details?id=com.termux&hl=en" > Termux< / a > .
Termux provides a base installation of Linux essentials, including apt and Python, and makes them
available under a writeable directory. It also gives us a terminal where we can enter commands. By
default, Android doesn’
installation directory is the root directory.< / p >
< p > Termux will set up a base system for us on first launch, but we will need to install some
prerequisites for Evennia. Commands you should run in Termux will look like this:< / p >
2020-06-13 00:36:45 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ cat file.txt
< / pre > < / div >
< / div >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > $< / span > < / code > symbol is your prompt - do not include it when running commands.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "prerequisites" >
2020-06-13 00:36:45 +02:00
< h2 > Prerequisites< a class = "headerlink" href = "#prerequisites" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-16 22:49:43 +02:00
< p > To install some of the libraries Evennia requires, namely Pillow and Twisted, we have to first
install some packages they depend on. In Termux, run the following< / p >
2020-06-13 00:36:45 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ pkg install -y clang git zlib ndk-sysroot libjpeg-turbo libcrypt python
< / pre > < / div >
< / div >
2020-06-16 22:49:43 +02:00
< p > Termux ships with Python 3, perfect. Python 3 has venv (virtualenv) and pip (Python’
installer) built-in.< / p >
< p > So, let’
versions.< / p >
2020-06-13 00:36:45 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ cd
$ python3 -m venv evenv
< / pre > < / div >
< / div >
< p > This will create a new folder, called < code class = "docutils literal notranslate" > < span class = "pre" > evenv< / span > < / code > , containing the new python executable.
2020-06-16 22:49:43 +02:00
Next, let’
following command:< / p >
2020-06-13 00:36:45 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ source evenv/bin/activate
< / pre > < / div >
< / div >
< p > Your prompt will change to look like this:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > (evenv) $
< / pre > < / div >
< / div >
< p > Update the updaters and installers in the venv: pip, setuptools and wheel.< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > python3< / span > < span class = "o" > -< / span > < span class = "n" > m< / span > < span class = "n" > pip< / span > < span class = "n" > install< / span > < span class = "o" > --< / span > < span class = "n" > upgrade< / span > < span class = "n" > pip< / span > < span class = "n" > setuptools< / span > < span class = "n" > wheel< / span >
< / pre > < / div >
< / div >
2021-05-16 00:06:01 +02:00
< section id = "installing-evennia" >
2020-06-13 00:36:45 +02:00
< h3 > Installing Evennia< a class = "headerlink" href = "#installing-evennia" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > Now that we have everything in place, we’ < / p >
< p > Mysterious incantations< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > export< / span > < span class = "n" > LDFLAGS< / span > < span class = "o" > =< / span > < span class = "s2" > " -L/data/data/com.termux/files/usr/lib/" < / span >
< span class = "n" > export< / span > < span class = "n" > CFLAGS< / span > < span class = "o" > =< / span > < span class = "s2" > " -I/data/data/com.termux/files/usr/include/" < / span >
< / pre > < / div >
< / div >
< p > (these tell clang, the C compiler, where to find the bits for zlib when building Pillow)< / p >
< p > Install the latest Evennia in a way that lets you edit the source< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > (evenv) $ pip install --upgrade -e ' git+https://github.com/evennia/evennia#egg=evennia'
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
2020-06-16 22:49:43 +02:00
< p > This step will possibly take quite a while - we are downloading Evennia and are then installing it,
building all of the requirements for Evennia to run. If you run into trouble on this step, please
2021-10-26 21:41:11 +02:00
see < a class = "reference internal" href = "#troubleshooting" > < span class = "std std-doc" > Troubleshooting< / span > < / a > .< / p >
2020-06-13 00:36:45 +02:00
< p > You can go to the dir where Evennia is installed with < code class = "docutils literal notranslate" > < span class = "pre" > cd< / span > < span class = "pre" > $VIRTUAL_ENV/src/evennia< / span > < / code > . < code class = "docutils literal notranslate" > < span class = "pre" > git< / span > < span class = "pre" > grep< / span > < span class = "pre" > (something)< / span > < / code > can be handy, as can < code class = "docutils literal notranslate" > < span class = "pre" > git< / span > < span class = "pre" > diff< / span > < / code > < / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "final-steps" >
2020-06-13 00:36:45 +02:00
< h3 > Final steps< a class = "headerlink" href = "#final-steps" title = "Permalink to this headline" > ¶< / a > < / h3 >
2020-07-14 00:21:00 +02:00
< p > At this point, Evennia is installed on your phone! You can now continue with the original
2022-02-05 15:09:22 +00:00
< a class = "reference internal" href = "Installation.html" > < span class = "doc std std-doc" > Setup Quickstart< / span > < / a > instruction, we repeat them here for clarity.< / p >
2020-06-13 00:36:45 +02:00
< p > To start a new game:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > (evenv) $ evennia --init mygame
(evenv) $ ls
mygame evenv
< / pre > < / div >
< / div >
< p > To start the game for the first time:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > (evenv) $ cd mygame
(evenv) $ evennia migrate
(evenv) $ evennia start
< / pre > < / div >
< / div >
2021-10-26 21:41:11 +02:00
< p > Your game should now be running! Open a web browser at < a class = "reference external" href = "http://localhost:4001" > http://localhost:4001< / a > or point a telnet
2020-06-16 22:49:43 +02:00
client to localhost:4000 and log in with the user you created.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< / section >
< section id = "running-evennia" >
2020-06-13 00:36:45 +02:00
< h2 > Running Evennia< a class = "headerlink" href = "#running-evennia" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-16 22:49:43 +02:00
< p > When you wish to run Evennia, get into your Termux console and make sure you have activated your
virtualenv as well as are in your game’ < / p >
2020-06-13 00:36:45 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ cd ~ & & source evenv/bin/activate
(evenv) $ cd mygame
(evenv) $ evennia start
< / pre > < / div >
< / div >
2022-02-05 15:09:22 +00:00
< p > You may wish to look at the < a class = "reference internal" href = "Installation-Git.html#linux-install" > < span class = "std std-doc" > Linux Instructions< / span > < / a > for more.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "caveats" >
2020-06-13 00:36:45 +02:00
< h2 > Caveats< a class = "headerlink" href = "#caveats" title = "Permalink to this headline" > ¶< / a > < / h2 >
< ul class = "simple" >
2020-06-16 22:49:43 +02:00
< li > < p > Android’ ’
the command @ server in-game will throw an exception. So far, there is no fix for this problem.< / p > < / li >
2020-06-13 00:36:45 +02:00
< li > < p > As you might expect, performance is not amazing.< / p > < / li >
2020-06-16 22:49:43 +02:00
< li > < p > Android is fairly aggressive about memory handling, and you may find that your server process is
killed if your phone is heavily taxed. Termux seems to keep a notification up to discourage this.< / p > < / li >
2020-06-13 00:36:45 +02:00
< / ul >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "troubleshooting" >
2020-06-13 00:36:45 +02:00
< h2 > Troubleshooting< a class = "headerlink" href = "#troubleshooting" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > As time goes by and errors are reported, this section will be added to.< / p >
< p > Some steps to try anyway:< / p >
< ul class = "simple" >
< li > < p > Make sure your packages are up-to-date, try running < code class = "docutils literal notranslate" > < span class = "pre" > pkg< / span > < span class = "pre" > update< / span > < span class = "pre" > & & < / span > < span class = "pre" > pkg< / span > < span class = "pre" > upgrade< / span > < span class = "pre" > -y< / span > < / code > < / p > < / li >
< li > < p > Make sure you’ < code class = "docutils literal notranslate" > < span class = "pre" > pkg< / span > < span class = "pre" > install< / span > < span class = "pre" > clang< / span > < span class = "pre" > -y< / span > < / code > < / p > < / li >
< li > < p > Make sure you’ < / p > < / li >
< li > < p > Make sure you’ < code class = "docutils literal notranslate" > < span class = "pre" > cd< / span > < span class = "pre" > & & < / span > < span class = "pre" > source< / span > < span class = "pre" > evenv/bin/activate< / span > < / code > < / p > < / li >
< li > < p > See if a shell will start: < code class = "docutils literal notranslate" > < span class = "pre" > cd< / span > < span class = "pre" > ~/mygame< / span > < span class = "pre" > ;< / span > < span class = "pre" > evennia< / span > < span class = "pre" > shell< / span > < / code > < / p > < / li >
< li > < p > Look at the log files in ~/mygame/server/logs/< / p > < / li >
< / ul >
2021-05-16 00:06:01 +02:00
< / 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" >
2020-07-14 00:21:00 +02:00
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
2020-06-15 21:52:33 +02:00
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
2020-07-14 00:21:00 +02:00
< form class = "search" action = "../search.html" method = "get" >
2020-06-15 21:52:33 +02:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
2020-07-14 00:21:00 +02:00
< p > < h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
2020-06-15 21:52:33 +02:00
< ul >
< li > < a class = "reference internal" href = "#" > Installing on Android< / a > < ul >
< li > < a class = "reference internal" href = "#install-termux" > Install Termux< / a > < / li >
< li > < a class = "reference internal" href = "#prerequisites" > Prerequisites< / a > < ul >
< li > < a class = "reference internal" href = "#installing-evennia" > Installing Evennia< / a > < / li >
< li > < a class = "reference internal" href = "#final-steps" > Final steps< / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#running-evennia" > Running Evennia< / a > < / li >
< li > < a class = "reference internal" href = "#caveats" > Caveats< / a > < / li >
< li > < a class = "reference internal" href = "#troubleshooting" > Troubleshooting< / a > < / li >
< / ul >
< / li >
< / ul >
2020-06-13 00:36:45 +02:00
2022-02-06 18:34:09 +00:00
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "Installation-Troubleshooting.html"
title="previous chapter">Installation Troubleshooting< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Installation-Upgrade.html"
title="next chapter">Upgrading an existing installation< / 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" >
2022-02-05 15:09:22 +00:00
< li > < a href = "../_sources/Setup/Installation-Android.md.txt"
2020-06-15 21:52:33 +02:00
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 >
2022-02-05 15:09:22 +00:00
< li > < a href = "Installation-Android.html" > 1.0-dev (develop branch)< / a > < / li >
2022-02-05 18:41:59 +00:00
< li > < a href = "../../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2020-06-15 21:52:33 +02:00
< / 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" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
>index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / a > |< / li >
2022-02-06 18:34:09 +00:00
< li class = "right" >
< a href = "Installation-Upgrade.html" title = "Upgrading an existing installation"
>next< / a > |< / li >
< li class = "right" >
< a href = "Installation-Troubleshooting.html" title = "Installation Troubleshooting"
>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 >
2022-02-06 18:34:09 +00:00
< li class = "nav-item nav-item-1" > < a href = "Setup-Overview.html" > Server Setup and Life< / a > » < / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-this" > < a href = "" > Installing on Android< / 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 >
