From 1ae614d35e9550c8d97169d17181e5c5e6d5ee35 Mon Sep 17 00:00:00 2001 From: Evennia docbuilder action Date: Tue, 22 Nov 2022 10:37:02 +0000 Subject: [PATCH] Updated HTML docs. --- docs/1.0-dev/.buildinfo | 2 +- docs/1.0-dev/Howtos/Howtos-Overview.html | 7 +- docs/1.0-dev/Setup/Online-Setup.html | 127 +++++++----------- docs/1.0-dev/Setup/Setup-Overview.html | 10 +- .../_sources/Howtos/Howtos-Overview.md.txt | 4 +- .../_sources/Setup/Online-Setup.md.txt | 66 +++------ .../api/evennia.commands.default.account.html | 4 +- .../api/evennia.commands.default.admin.html | 4 +- .../evennia.commands.default.building.html | 8 +- .../api/evennia.commands.default.general.html | 16 +-- .../api/evennia.commands.default.system.html | 4 +- .../api/evennia.commands.default.tests.html | 2 +- .../evennia.commands.default.unloggedin.html | 16 +-- ....base_systems.email_login.email_login.html | 16 +-- ...b.base_systems.ingame_python.commands.html | 4 +- ...systems.mux_comms_cmds.mux_comms_cmds.html | 8 +- ...rib.full_systems.evscaperoom.commands.html | 24 ++-- ...ontrib.game_systems.clothing.clothing.html | 4 +- ...trib.grid.extended_room.extended_room.html | 4 +- .../api/evennia.contrib.rpg.dice.dice.html | 4 +- ...evennia.contrib.rpg.rpsystem.rpsystem.html | 8 +- ...ontrib.tutorials.evadventure.commands.html | 4 +- ...ntrib.tutorials.red_button.red_button.html | 16 +-- ...trib.tutorials.tutorial_world.objects.html | 16 +-- ...ontrib.tutorials.tutorial_world.rooms.html | 12 +- ...utils.git_integration.git_integration.html | 4 +- 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 158536 -> 158550 bytes docs/1.0-dev/searchindex.js | 2 +- 31 files changed, 180 insertions(+), 228 deletions(-) diff --git a/docs/1.0-dev/.buildinfo b/docs/1.0-dev/.buildinfo index 01bb4c2201..e1a635ae08 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: 5c7573c6842d4487378d41827992e022 +config: a62091330c1ccd02fd5643736f633492 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/1.0-dev/Howtos/Howtos-Overview.html b/docs/1.0-dev/Howtos/Howtos-Overview.html index d1beee69f8..a5c0485966 100644 --- a/docs/1.0-dev/Howtos/Howtos-Overview.html +++ b/docs/1.0-dev/Howtos/Howtos-Overview.html @@ -117,9 +117,10 @@

Beginner Tutorial

Recommended starting point! This will take you from absolute beginner to making a small but full game with Evennia. Other tutorials and howto’s tend to assume you are already familiar with the concepts explained in the Beginning tutorial.

-
-

The latter parts of the beginner tutorial are still being worked on.

-
+
+

Note

+

Part 3 and onwards are still under development.

+

Settings example

You can connect Evennia to the Internet without any changes to your settings. The default settings @@ -336,12 +312,10 @@ as Not yet public and just be a teaser. If so, pick pre-alpha

and follow the instructions. See the Game index page for more details.

-
-

SSL

+
+

SSL and HTTPS

SSL can be very useful for web clients. It will protect the credentials and gameplay of your users -over a web client if they are in a public place, and your websocket can also be switched to WSS for -the same benefit. SSL certificates used to cost money on a yearly basis, but there is now a program -that issues them for free with assisted setup to make the entire process less painful.

+over a web client if they are in a public place, and your websocket can also be switched to WSS for the same benefit. SSL certificates used to cost money on a yearly basis, but there is now a program that issues them for free with assisted setup to make the entire process less painful.

Options that may be useful in combination with an SSL proxy:

# See above for the section on Lockdown Mode.
 # Useful for a proxy on the public interface connecting to Evennia on localhost.
@@ -375,18 +349,16 @@ or through a TXT record in your DNS. Which one you will want to do is a personal
 also be based on your hosting choice. In a controlled/cPanel environment, you will most likely have
 to use DNS verification.
-
-

Relevant SSL Proxy Setup Information

+

Relevant SSL Proxy Setup Information

-
-

Hosting locally or remotely?

-
-

Using your own computer as a server

+
+
+

Hosting Evennia from your own computer

What we showed above is by far the simplest and probably cheapest option: Run Evennia on your own home computer. Moreover, since Evennia is its own web server, you don’t need to install anything extra to have a website.

@@ -414,8 +386,8 @@ tier connection) or you are the subject of legal action by a copyright holder, y main internet connection terminated as a consequence.

-

Setting up your own machine as a server

-

The first section of this page describes how to do this +

Setting up your own machine as a server

+

The first section of this page describes how to do this and allow users to connect to the IP address of your machine/router.

A complication with using a specific IP address like this is that your home IP might not remain the same. Many ISPs (Internet Service Providers) allocates a dynamic IP to you which could change at @@ -450,8 +422,8 @@ systems). inadyn

-
-

Remote hosting

+
+

Hosting Evennia on a remote server

Your normal “web hotel” will probably not be enough to run Evennia. A web hotel is normally aimed at a very specific usage - delivering web pages, at the most with some dynamic content. The “Python scripts” they refer to on their home pages are usually only intended to be CGI-like scripts launched @@ -488,7 +460,7 @@ usage might be limited. Also, if the server people decides to take the server do you have no choice but to sit it out (but you’ll hopefully be warned ahead of time).

-

Installing Evennia on a remote server

+

Installing Evennia on a remote server

Firstly, if you are familiar with server infrastructure, consider using [Docker](Running-Evennia-in- Docker) to deploy your game to the remote server; it will likely ease installation and deployment. Docker images may be a little confusing if you are completely new to them though.

@@ -503,8 +475,8 @@ install everything without actually needing to have further -

Hosting options

+
+

Hosting options and suggestions

To find commercial solutions, browse the web for “shell access”, “VPS” or “Cloud services” in your region. You may find useful offers for “low cost” VPS hosting on Low End Box. The associated Low End Talk forum can be useful for health checking the many small businesses that offer @@ -550,38 +522,36 @@ Evennia users:

on demand

Similar to Amazon. Free 12-month tier with limited regions.

-

Genesis MUD hosting

-

Shell account

-

$8/month

-

Dedicated MUD host with very limited memory offerings. As for 2017, runs a 13 years old Python version (2.4) so you’d need to either convince them to update or compile yourself. Note that Evennia needs at least the “Deluxe” package (50MB RAM) and probably a lot higher for a production game. This host is not recommended for Evennia.

- -

Host1Plus

+

Host1Plus

VPS & Cloud

$4/month

$4-$8/month depending on length of sign-up period.

-

Scaleway

+

Scaleway

Cloud

€3/month / on-demand

EU based (Paris, Amsterdam). Smallest option provides 2GB RAM.

-

Prgmr

+

Prgmr

VPS

$5/month

1 month free with a year prepay. You likely want some experience with servers with this option as they don’t have a lot of support.

-

Linode

+

Linode

Cloud

$5/month / on-demand

Multiple regions. Smallest option provides 1GB RAM

+

Genesis MUD hosting

+

Shell account

+

$8/month

+

Dedicated MUD host with very limited memory offerings. May run very old Python versions. Evennia needs at least the “Deluxe” package (50MB RAM) and probably a lot higher for a production game. While it’s sometimes mentioned in a MUD context, this host is not recommended for Evennia.

+

Please help us expand this list.

-
-
-

Cloud9

+

Cloud9

If you are interested in running Evennia in the online dev environment Cloud9, you can spin it up through their normal online setup using the Evennia Linux install instructions. The one extra thing you will have to do is update mygame/server/conf/settings.py and add @@ -592,6 +562,7 @@ service offering. New customers entitled to the 1 year AWS “free tier” may f sufficient resources to operate a Cloud9 development environment without charge. https://aws.amazon.com/cloud9/

+
diff --git a/docs/1.0-dev/Setup/Setup-Overview.html b/docs/1.0-dev/Setup/Setup-Overview.html index 55a56d6533..f1a27e93b6 100644 --- a/docs/1.0-dev/Setup/Setup-Overview.html +++ b/docs/1.0-dev/Setup/Setup-Overview.html @@ -234,11 +234,11 @@