From 2856056808a7bb922f1bf9681a9ae8b0042ed708 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Sat, 5 Feb 2022 17:31:31 +0000 Subject: [PATCH] Updated HTML docs --- docs/1.0-dev/.buildinfo | 2 +- docs/1.0-dev/Setup/Installation-Docker.html | 48 +++++++----------- .../_sources/Setup/Installation-Docker.md.txt | 40 ++++++--------- .../api/evennia.commands.default.account.html | 4 +- .../api/evennia.commands.default.admin.html | 4 +- .../evennia.commands.default.building.html | 8 +-- .../api/evennia.commands.default.comms.html | 8 +-- .../api/evennia.commands.default.general.html | 12 ++--- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 8 +-- ....base_systems.email_login.email_login.html | 8 +-- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 4 +- ...rib.full_systems.evscaperoom.commands.html | 24 ++++----- ...ontrib.game_systems.clothing.clothing.html | 4 +- ...trib.game_systems.turnbattle.tb_basic.html | 4 +- ...trib.game_systems.turnbattle.tb_equip.html | 4 +- ...trib.game_systems.turnbattle.tb_items.html | 4 +- ...trib.game_systems.turnbattle.tb_magic.html | 4 +- ...trib.game_systems.turnbattle.tb_range.html | 4 +- ...trib.grid.extended_room.extended_room.html | 4 +- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 4 +- ...ntrib.tutorials.red_button.red_button.html | 16 +++--- ...trib.tutorials.tutorial_world.objects.html | 16 +++--- ...ontrib.tutorials.tutorial_world.rooms.html | 8 +-- docs/1.0-dev/api/evennia.utils.eveditor.html | 4 +- docs/1.0-dev/api/evennia.utils.evmenu.html | 4 +- docs/1.0-dev/api/evennia.utils.evmore.html | 4 +- docs/1.0-dev/objects.inv | Bin 138993 -> 138887 bytes docs/1.0-dev/searchindex.js | 2 +- docs/1.0-dev/toc.html | 8 ++- 32 files changed, 125 insertions(+), 149 deletions(-) diff --git a/docs/1.0-dev/.buildinfo b/docs/1.0-dev/.buildinfo index 527332e904..8d9877e28b 100644 --- a/docs/1.0-dev/.buildinfo +++ b/docs/1.0-dev/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ea332c35165f8bc0be86dd033aa5b705 +config: b4ea174c6b95d42cd31b2e184b56a494 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/1.0-dev/Setup/Installation-Docker.html b/docs/1.0-dev/Setup/Installation-Docker.html index 31be3b3b7a..675d9e0a2c 100644 --- a/docs/1.0-dev/Setup/Installation-Docker.html +++ b/docs/1.0-dev/Setup/Installation-Docker.html @@ -42,10 +42,8 @@

Running Evennia in Docker

-

Evennia has an official docker image which makes +

Evennia releases docker images which makes running an Evennia-based game in a Docker container easy.

-
-

Install Evennia through docker

First, install the docker program so you can run the Evennia container. You can get it freely from docker.com. Linux users can likely also get it through their normal package manager.

@@ -53,16 +51,15 @@ package manager.

docker pull evennia/evennia
-

This is a good command to know, it is also how you update to the latest version when we make updates -in the future. This tracks the master branch of Evennia.

-
-

Note: If you want to experiment with the (unstable) develop branch, use docker pull evennia/evennia:develop.

-
-

Next cd to a place where your game dir is, or where you want to create it. Then run:

-
docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 --rm -v $PWD:/usr/src/game --user
+
This will get the latest stable image.

+
docker pull evennia/evennia:develop 
+

+

+
gets the image based off Evennia’s unstable develop branch.

+
Next, cd to a place where your game dir is, or where you want to create it. Then run:

+
docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 --rm -v $PWD:/usr/src/game --user $UID:$GID evennia/evennia
 

 

-
\(UID:\)GID evennia/evennia

 
Having run this (see next section for a description of what’s what), you will be at a prompt inside
 the docker container:

 
evennia|docker /usr/src/game $
@@ -71,8 +68,8 @@ the docker container:

 
This is a normal shell prompt. We are in the /usr/src/game location inside the docker container.
 If you had anything in the folder you started from, you should see it here (with ls) since we
 mounted the current directory to usr/src/game (with -v above). You have the evennia command
-available and can now proceed to create a new game as per the Setup Quickstart
-instructions (you can skip the virtualenv and install ‘globally’ in the container though).

+available and can now proceed to create a new game as per the normal game setup
+instructions (no virtualenv needed).

 
You can run Evennia from inside this container if you want to, it’s like you are root in a little
 isolated Linux environment. To exit the container and all processes in there, press Ctrl-D. If you
 created a new game folder, you will find that it has appeared on-disk.

@@ -82,13 +79,7 @@ by rootsudo chown myname:myname -R mygame, where you replace myname with
 your username and mygame with whatever your game folder is named.

 

-

-
Description of the docker run command

-
    docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 --rm -v $PWD:/usr/src/game --user
-$UID:$GID evennia/evennia
-

-

-
This is what it does:

+
Below is an explanation of the docker run command we used:

 
    
 
  • docker run ... evennia/evennia tells us that we want to run a new container based on the
 evennia/evennia docker image. Everything in between are options for this. The evennia/evennia is
@@ -114,8 +105,6 @@ group IDs instead of root’s IDs (root is the user running evennia inside the c
 having stale .pid files in your filesystem between container reboots which you have to force
 delete with sudo rm server/*.pid before each boot.
    • 
 

-

-

Running your game as a docker image

If you run the docker command given in the previous section from your game dir you can then @@ -133,17 +122,17 @@ install dependencies.

container comes up. If you already have a game folder with a database set up you can also start the docker container and pass commands directly to it. The command you pass will be the main process to run in the container. From your game dir, run for example this command:

-
docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 --rm -v $PWD:/usr/src/game
+
docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 --rm -v $PWD:/usr/src/game evennia/evennia evennia start -l
 

 

-
evennia/evennia evennia start -l

 
This will start Evennia as the foreground process, echoing the log to the terminal. Closing the
 terminal will kill the server. Note that you must use a foreground command like evennia start -l
 or evennia ipstart to start the server - otherwise the foreground process will finish immediately
 and the container go down.
+
-

Create your own game image

+

Create your own game image

These steps assume that you have created or otherwise obtained a game directory already. First, cd to your game dir and create a new empty text file named Dockerfile. Save the following two lines into it:

@@ -165,7 +154,6 @@ build the image locally only (name the container whatever you like in that case, mygame).

Docker images are stored centrally on your computer. You can see which ones you have available locally with docker images. Once built, you have a couple of options to run your game.

-

Run container from your game image for development

To run the container based on your game image locally for development, mount the local game @@ -335,13 +323,11 @@ line.

Table of Contents