Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-24 16:56:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Resync all links and fix issues with auto-relink

Browse source
This commit is contained in:
Griatch 2020-06-18 00:44:36 +02:00
parent 20a1741f4c
commit fab769e0d0
107 changed files with 887 additions and 877 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/Setup/Arxcode-installing-help.md
View file

@ -32,7 +32,7 @@ important if referring to newer Evennia documentation.
If you are new to Evennia it's *highly* recommended that you run through the
instructions in full - including initializing and starting a new empty game and connecting to it.
That way you can be sure Evennia works correctly as a base line. If you have trouble, make sure to
read the [Troubleshooting instructions](Getting-Started#troubleshooting) for your
read the [Troubleshooting instructions](Setup/Getting-Started#troubleshooting) for your
operating system. You can also drop into our
[forums](https://groups.google.com/forum/#%21forum/evennia), join `#evennia` on `irc.freenode.net`
or chat from the linked [Discord Server](https://discord.gg/NecFePw).

52
docs/source/Setup/Getting-Started.md
View file

@ -7,14 +7,14 @@ This will help you download, install and start Evennia for the first time.
> test out Evennia. Apart from downloading and updating you don't even need an
> internet connection until you feel ready to share your game with the world.
- [Quick Start](Getting-Started#quick-start)
- [Requirements](Getting-Started#requirements)
- [Linux Install](Getting-Started#linux-install)
- [Mac Install](Getting-Started#mac-install)
- [Windows Install](Getting-Started#windows-install)
- [Running in Docker](Running-Evennia-in-Docker)
- [Where to Go Next](Getting-Started#where-to-go-next)
- [Troubleshooting](Getting-Started#troubleshooting)
- [Quick Start](Setup/Getting-Started#quick-start)
- [Requirements](Setup/Getting-Started#requirements)
- [Linux Install](Setup/Getting-Started#linux-install)
- [Mac Install](Setup/Getting-Started#mac-install)
- [Windows Install](Setup/Getting-Started#windows-install)
- [Running in Docker](Setup/Running-Evennia-in-Docker)
- [Where to Go Next](Setup/Getting-Started#where-to-go-next)
- [Troubleshooting](Setup/Getting-Started#troubleshooting)
- [Glossary of terms](Glossary)
## Quick Start
@ -37,7 +37,7 @@ Evennia should now be running and you can connect to it by pointing a web browse
`http://localhost:4001` or a MUD telnet client to `localhost:4000` (use `127.0.0.1` if your OS does
not recognize `localhost`).
We also release [Docker images](Running-Evennia-in-Docker)
We also release [Docker images](Setup/Running-Evennia-in-Docker)
based on `master` and `develop` branches.
## Requirements
@ -68,10 +68,10 @@ Twisted packages
## Linux Install
If you run into any issues during the installation and first start, please
check out [Linux Troubleshooting](Getting-Started#linux-troubleshooting).
check out [Linux Troubleshooting](Setup/Getting-Started#linux-troubleshooting).
For Debian-derived systems (like Ubuntu, Mint etc), start a terminal and
install the [dependencies](Getting-Started#requirements):
install the [dependencies](Setup/Getting-Started#requirements):
```
sudo apt-get update
@ -143,7 +143,7 @@ pip install -e evennia
```
For more info about `pip`, see the [Glossary entry on pip](Glossary#pip). If
install failed with any issues, see [Linux Troubleshooting](Getting-Started#linux-troubleshooting).
install failed with any issues, see [Linux Troubleshooting](Setup/Getting-Started#linux-troubleshooting).
Next we'll start our new game, here called "mygame". This will create yet
another new folder where you will be creating your new game:
@ -160,8 +160,8 @@ Your final folder structure should look like this:
mygame/
```
You can [configure Evennia](Server-Conf#settings-file) extensively, for example
to use a [different database](Choosing-An-SQL-Server). For now we'll just stick
You can [configure Evennia](Component/Server-Conf#settings-file) extensively, for example
to use a [different database](Setup/Choosing-An-SQL-Server). For now we'll just stick
to the defaults though.
```
@ -175,7 +175,7 @@ evennia start # (create a superuser when asked. Email is optional.)
Your game should now be running! Open a web browser at `http://localhost:4001`
or point a telnet client to `localhost:4000` and log in with the user you
created. Check out [where to go next](Getting-Started#where-to-go-next).
created. Check out [where to go next](Setup/Getting-Started#where-to-go-next).
## Mac Install
@ -184,7 +184,7 @@ The Evennia server is a terminal program. Open the terminal e.g. from
*Applications->Utilities->Terminal*. [Here is an introduction to the Mac
terminal](http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line)
if you are unsure how it works. If you run into any issues during the
installation, please check out [Mac Troubleshooting](Getting-Started#mac-troubleshooting).
installation, please check out [Mac Troubleshooting](Setup/Getting-Started#mac-troubleshooting).
* Python should already be installed but you must make sure it's a high enough version.
([This](http://docs.python-guide.org/en/latest/starting/install/osx/) discusses
@ -254,7 +254,7 @@ pip install -e evennia
```
For more info about `pip`, see the [Glossary entry on pip](Glossary#pip). If
install failed with any issues, see [Mac Troubleshooting](Getting-Started#mac-troubleshooting).
install failed with any issues, see [Mac Troubleshooting](Setup/Getting-Started#mac-troubleshooting).
Next we'll start our new game. We'll call it "mygame" here. This creates a new
folder where you will be creating your new game:
@ -272,8 +272,8 @@ Your final folder structure should look like this:
mygame/
```
You can [configure Evennia](Server-Conf#settings-file) extensively, for example
to use a [different database](Choosing-An-SQL-Server). We'll go with the
You can [configure Evennia](Component/Server-Conf#settings-file) extensively, for example
to use a [different database](Setup/Choosing-An-SQL-Server). We'll go with the
defaults here.
```
@ -287,13 +287,13 @@ evennia start # (create a superuser when asked. Email is optional.)
Your game should now be running! Open a web browser at `http://localhost:4001`
or point a telnet client to `localhost:4000` and log in with the user you
created. Check out [where to go next](Getting-Started#where-to-go-next).
created. Check out [where to go next](Setup/Getting-Started#where-to-go-next).
## Windows Install
If you run into any issues during the installation, please check out
[Windows Troubleshooting](Getting-Started#windows-troubleshooting).
[Windows Troubleshooting](Setup/Getting-Started#windows-troubleshooting).
> If you are running Windows10, consider using the Windows Subsystem for Linux
> ([WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)) instead.
@ -394,7 +394,7 @@ folders when you use the `dir` command) and run
pip install -e evennia
```
For more info about `pip`, see the [Glossary entry on pip](Glossary#pip). If
the install failed with any issues, see [Windows Troubleshooting](Getting-Started#windows-
the install failed with any issues, see [Windows Troubleshooting](Setup/Getting-Started#windows-
troubleshooting).
Next we'll start our new game, we'll call it "mygame" here. This creates a new folder where you will
be
@ -413,8 +413,8 @@ path\to\muddev
mygame\
```
You can [configure Evennia](Server-Conf#settings-file) extensively, for example
to use a [different database](Choosing-An-SQL-Server). We'll go with the
You can [configure Evennia](Component/Server-Conf#settings-file) extensively, for example
to use a [different database](Setup/Choosing-An-SQL-Server). We'll go with the
defaults here.
```
@ -428,7 +428,7 @@ evennia start # (create a superuser when asked. Email is optional.)
Your game should now be running! Open a web browser at `http://localhost:4001`
or point a telnet client to `localhost:4000` and log in with the user you
created. Check out [where to go next](Getting-Started#where-to-go-next).
created. Check out [where to go next](Setup/Getting-Started#where-to-go-next).
## Where to Go Next
@ -438,7 +438,7 @@ logged in, stand in the `Limbo` room and run
@batchcommand tutorial_world.build
to build [Evennia's tutorial world](Tutorial-World-Introduction) - it's a small solo quest to
to build [Evennia's tutorial world](Contrib/Tutorial-World-Introduction) - it's a small solo quest to
explore. Only run the instructed `@batchcommand` once. You'll get a lot of text scrolling by as the
tutorial is built. Once done, the `tutorial` exit will have appeared out of Limbo - just write
`tutorial` to enter it.

8
docs/source/Setup/How-to-connect-Evennia-to-Twitter.md
View file

@ -29,8 +29,8 @@ pip install python-twitter
## A basic tweet command
Evennia doesn't have a `tweet` command out of the box so you need to write your own little
[Command](Commands) in order to tweet. If you are unsure about how commands work and how to add
them, it can be an idea to go through the [Adding a Command Tutorial](Adding-Command-Tutorial)
[Command](Component/Commands) in order to tweet. If you are unsure about how commands work and how to add
them, it can be an idea to go through the [Adding a Command Tutorial](Howto/StartingTutorial/Adding-Command-Tutorial)
before continuing.
You can create the command in a separate command module (something like `mygame/commands/tweet.py`)
@ -89,7 +89,7 @@ Be sure to substitute your own actual API/Access keys and secrets in the appropr
We default to limiting tweet access to players with `Developers`-level access *or* to those players
that have the permission "tweet" (allow individual characters to tweet with `@perm/player playername
= tweet`). You may change the [lock](Locks) as you feel is appropriate. Change the overall
= tweet`). You may change the [lock](Component/Locks) as you feel is appropriate. Change the overall
permission to `Players` if you want everyone to be able to tweet.
Now add this command to your default command set (e.g in `mygame/commands/defalt_cmdsets.py`") and
@ -106,5 +106,5 @@ This shows only a basic tweet setup, other things to do could be:
* Echo your tweets to an in-game channel
Rather than using an explicit command you can set up a Script to send automatic tweets, for example
to post updated game stats. See the [Tweeting Game Stats tutorial](Tutorial-Tweeting-Game-Stats) for
to post updated game stats. See the [Tweeting Game Stats tutorial](Howto/Tutorial-Tweeting-Game-Stats) for
help.

2
docs/source/Setup/IRC.md
View file

@ -7,7 +7,7 @@ Discord](https://discord.gg/NecFePw), which is mirrored to IRC._
[IRC (Internet Relay Chat)](http://en.wikipedia.org/wiki/Internet_Relay_Chat) is a long standing
chat protocol used by many open-source projects for communicating in real time. By connecting one of
Evennia's [Channels](Communications) to an IRC channel you can communicate also with people not on
Evennia's [Channels](Component/Communications) to an IRC channel you can communicate also with people not on
an mud themselves. You can also use IRC if you are only running your Evennia MUD locally on your
computer (your game doesn't need to be open to the public)! All you need is an internet connection.
For IRC operation you also need [twisted.words](http://twistedmatrix.com/trac/wiki/TwistedWords).

4
docs/source/Setup/Installing-on-Android.md
View file

@ -80,7 +80,7 @@ Install the latest Evennia in a way that lets you edit the source
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
see [Troubleshooting](Installing-on-Android#troubleshooting).
see [Troubleshooting](Setup/Installing-on-Android#troubleshooting).
You can go to the dir where Evennia is installed with `cd $VIRTUAL_ENV/src/evennia`. `git grep
(something)` can be handy, as can `git diff`
@ -120,7 +120,7 @@ $ cd ~ && source evenv/bin/activate
(evenv) $ evennia start
```
You may wish to look at the [Linux Instructions](Getting-Started#linux-install) for more.
You may wish to look at the [Linux Instructions](Setup/Getting-Started#linux-install) for more.
## Caveats

12
docs/source/Setup/Online-Setup.md
View file

@ -66,7 +66,7 @@ web services you are running through this router though.
You can connect Evennia to the Internet without any changes to your settings. The default settings
are easy to use but are not necessarily the safest. You can customize your online presence in your
[settings file](Server-Conf#settings-file). To have Evennia recognize changed port settings you have
[settings file](Component/Server-Conf#settings-file). To have Evennia recognize changed port settings you have
to do a full `evennia reboot` to also restart the Portal and not just the Server component.
Below is an example of a simple set of settings, mostly using the defaults. Evennia will require
@ -202,7 +202,7 @@ To register, stand in your game dir, run
evennia connections
and follow the instructions. See the [Game index page](Evennia-Game-Index) for more details.
and follow the instructions. See the [Game index page](Setup/Evennia-Game-Index) for more details.
## SSL
@ -249,7 +249,7 @@ also be based on your hosting choice. In a controlled/cPanel environment, you wi
to use DNS verification.
## Relevant SSL Proxy Setup Information
- [Apache webserver configuration](Apache-Config) (optional)
- [Apache webserver configuration](Setup/Apache-Config) (optional)
- [HAProxy Config](HAProxy-Config-(Optional))
## Hosting locally or remotely?
@ -283,7 +283,7 @@ main internet connection terminated as a consequence.
#### Setting up your own machine as a server
[The first section](Online-Setup#connecting-from-the-outside) of this page describes how to do this
[The first section](Setup/Online-Setup#connecting-from-the-outside) 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
@ -344,7 +344,7 @@ game stays online. Many services guarantee a certain level of up-time and also d
for you. Make sure to check, some offer lower rates in exchange for you yourself being fully
responsible for your data/backups.
- Usually offers a fixed domain name, so no need to mess with IP addresses.
- May have the ability to easily deploy [docker](Running-Evennia-in-Docker) versions of evennia
- May have the ability to easily deploy [docker](Setup/Running-Evennia-in-Docker) versions of evennia
and/or your game.
**Disadvantages**
@ -362,7 +362,7 @@ Docker) to deploy your game to the remote server; it will likely ease installati
Docker images may be a little confusing if you are completely new to them though.
If not using docker, and assuming you know how to connect to your account over ssh/PuTTy, you should
be able to follow the [Getting Started](Getting-Started) instructions normally. You only need Python
be able to follow the [Getting Started](Setup/Getting-Started) instructions normally. You only need Python
and GIT pre-installed; these should both be available on any servers (if not you should be able to
easily ask for them to be installed). On a VPS or Cloud service you can install them yourself as
needed.

2
docs/source/Setup/RSS.md
View file

@ -44,4 +44,4 @@ switch:
@rss2chan/delete rss = https://github.com/evennia/evennia/commits/master.atom
You can connect any number of RSS feeds to a channel this way. You could also connect them to the
same channels as [IRC](IRC) to have the feed echo to external chat channels as well.
same channels as [IRC](Setup/IRC) to have the feed echo to external chat channels as well.

2
docs/source/Setup/Running-Evennia-in-Docker.md
View file

@ -34,7 +34,7 @@ evennia|docker /usr/src/game $
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 [Getting Started](Getting-Started)
available and can now proceed to create a new game as per the [Getting Started](Setup/Getting-Started)
instructions (you can skip the virtualenv and install 'globally' in the container though).
You can run Evennia from inside this container if you want to, it's like you are root in a little

2
docs/source/Setup/Security.md
View file

@ -131,7 +131,7 @@ Now the only ports open will be your administrative ssh port (whichever you chos
4000-4001.
### Use an external webserver
Though not officially supported, there are some benefits to [deploying a webserver](Apache-Config)
Though not officially supported, there are some benefits to [deploying a webserver](Setup/Apache-Config)
to handle/proxy traffic to your Evennia instance.
For example, Evennia's game engine and webservice are tightly integrated. If you bring your game

6
docs/source/Setup/Start-Stop-Reload.md
View file

@ -3,7 +3,7 @@
You control Evennia from your game folder (we refer to it as `mygame/` here), using the `evennia`
program. If the `evennia` program is not available on the command line you must first install
Evennia as described in the [Getting Started](Getting-Started) page.
Evennia as described in the [Getting Started](Setup/Getting-Started) page.
> Hint: If you ever try the `evennia` command and get an error complaining that the command is not
available, make sure your [virtualenv](Glossary#virtualenv) is active.
@ -20,7 +20,7 @@ to give you a menu with options.
## Starting Evennia
Evennia consists of two components, the Evennia [Server and Portal](Portal-And-Server). Briefly,
Evennia consists of two components, the Evennia [Server and Portal](Component/Portal-And-Server). Briefly,
the *Server* is what is running the mud. It handles all game-specific things but doesn't care
exactly how players connect, only that they have. The *Portal* is a gateway to which players
connect. It knows everything about telnet, ssh, webclient protocols etc but very little about the
@ -67,7 +67,7 @@ reboots. Since they are connected to the *Portal*, their connections are not los
Reloading is as close to a "warm reboot" you can get. It reinitializes all code of Evennia, but
doesn't kill "persistent" [Scripts](Scripts). It also calls `at_server_reload()` hooks on all
doesn't kill "persistent" [Scripts](Component/Scripts). It also calls `at_server_reload()` hooks on all
objects so you
can save eventual temporary properties you want.