mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
Fixed all errors in doc building
This commit is contained in:
Griatch
parent
9fbfc8f8d0
commit
76761825d0
80 changed files with 766 additions and 767 deletions
|
|
@ -12,7 +12,7 @@ This will help you download, install and start Evennia for the first time.
|
|||
- [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)
|
||||
- [Running in Docker](./Running-Evennia-in-Docker)
|
||||
- [Where to Go Next](Getting-Started#where-to-go-next)
|
||||
- [Troubleshooting](Getting-Started#troubleshooting)
|
||||
- [Glossary of terms](../Glossary)
|
||||
|
|
@ -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](./Running-Evennia-in-Docker)
|
||||
based on `master` and `develop` branches.
|
||||
|
||||
## Requirements
|
||||
|
|
@ -161,7 +161,7 @@ Your final folder structure should look like this:
|
|||
```
|
||||
|
||||
You can [configure Evennia](../Component/Server-Conf#settings-file) extensively, for example
|
||||
to use a [different database](Choosing-An-SQL-Server). For now we'll just stick
|
||||
to use a [different database](./Choosing-An-SQL-Server). For now we'll just stick
|
||||
to the defaults though.
|
||||
|
||||
```
|
||||
|
|
@ -273,7 +273,7 @@ Your final folder structure should look like this:
|
|||
```
|
||||
|
||||
You can [configure Evennia](../Component/Server-Conf#settings-file) extensively, for example
|
||||
to use a [different database](Choosing-An-SQL-Server). We'll go with the
|
||||
to use a [different database](./Choosing-An-SQL-Server). We'll go with the
|
||||
defaults here.
|
||||
|
||||
```
|
||||
|
|
@ -414,7 +414,7 @@ path\to\muddev
|
|||
```
|
||||
|
||||
You can [configure Evennia](../Component/Server-Conf#settings-file) extensively, for example
|
||||
to use a [different database](Choosing-An-SQL-Server). We'll go with the
|
||||
to use a [different database](./Choosing-An-SQL-Server). We'll go with the
|
||||
defaults here.
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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](./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`
|
||||
|
|
@ -88,7 +88,7 @@ You can go to the dir where Evennia is installed with `cd $VIRTUAL_ENV/src/evenn
|
|||
### Final steps
|
||||
|
||||
At this point, Evennia is installed on your phone! You can now continue with the original
|
||||
[Setup Quickstart](Setup-Quickstart) instruction, we repeat them here for clarity.
|
||||
[Setup Quickstart](./Setup-Quickstart) instruction, we repeat them here for clarity.
|
||||
|
||||
To start a new game:
|
||||
|
||||
|
|
|
|||
|
|
@ -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](./Evennia-Game-Index) for more details.
|
||||
|
||||
## SSL
|
||||
|
||||
|
|
@ -249,8 +249,8 @@ 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)
|
||||
- [HAProxy Config](HAProxy-Config)
|
||||
- [Apache webserver configuration](./Apache-Config) (optional)
|
||||
- [HAProxy Config](./HAProxy-Config)
|
||||
|
||||
## 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](./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](./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 [Setup Quickstart](Setup-Quickstart) instructions normally. You only need Python
|
||||
be able to follow the [Setup Quickstart](./Setup-Quickstart) 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.
|
||||
|
|
|
|||
|
|
@ -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](./IRC) to have the feed echo to external chat channels as well.
|
||||
|
|
@ -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 [Setup Quickstart](Setup-Quickstart)
|
||||
available and can now proceed to create a new game as per the [Setup Quickstart](./Setup-Quickstart)
|
||||
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
|
||||
|
|
|
|||
|
|
@ -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](./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
|
||||
|
|
|
|||
|
|
@ -4,11 +4,11 @@ This documentation covers how to setup and maintain the server, from first insta
|
|||
|
||||
## Installation & running
|
||||
|
||||
- [Installation & Setup quick-start](Setup-Quickstart) - one page to quickly get you going
|
||||
- [Extended Install instructions](Extended-Installation) - if you have trouble or want to contribute to Evennia itself
|
||||
- [Running through Docker](Running-Evennia-in-Docker) - alternative install method, useful for quick deployment on remote servers
|
||||
- [Installing Evennia on Android](Installing-on-Android) - for those craving a mobile life
|
||||
- [Controlling the server](Start-Stop-Reload) - an extended view on how to start/stop/update the server
|
||||
- [Installation & Setup quick-start](./Setup-Quickstart) - one page to quickly get you going
|
||||
- [Extended Install instructions](./Extended-Installation) - if you have trouble or want to contribute to Evennia itself
|
||||
- [Running through Docker](./Running-Evennia-in-Docker) - alternative install method, useful for quick deployment on remote servers
|
||||
- [Installing Evennia on Android](./Installing-on-Android) - for those craving a mobile life
|
||||
- [Controlling the server](./Start-Stop-Reload) - an extended view on how to start/stop/update the server
|
||||
|
||||
## Installing custom game dirs
|
||||
|
||||
|
|
@ -16,20 +16,20 @@ This documentation covers how to setup and maintain the server, from first insta
|
|||
|
||||
## Configuring
|
||||
|
||||
- [The settings file](Settings-File) - how and where to change the main settings of the server
|
||||
- [Change database engine](Choosing-An-SQL-Server) - if you want to use something other than SQLite3
|
||||
- [Evennia game index](Evennia-Game-Index) - register your upcoming game with the index to start the hype going
|
||||
- [The settings file](./Settings-File) - how and where to change the main settings of the server
|
||||
- [Change database engine](./Choosing-An-SQL-Server) - if you want to use something other than SQLite3
|
||||
- [Evennia game index](./Evennia-Game-Index) - register your upcoming game with the index to start the hype going
|
||||
|
||||
|
||||
- [Chat on IRC](IRC) - how to link your game's channels to an external [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) channel
|
||||
- [Chat on Grapevine](Grapevine) - how to link your game's channels the [Grapevine](https://grapevine.haus/) mud network/chat
|
||||
- [Messages to RSS](RSS) - have your game notify people through RSS
|
||||
- [Messages to Twitter](How-to-connect-Evennia-to-Twitter) - have Evennia send messages to [Twitter](https://twitter.com/) (requires some coding)
|
||||
- [Chat on IRC](./IRC) - how to link your game's channels to an external [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) channel
|
||||
- [Chat on Grapevine](./Grapevine) - how to link your game's channels the [Grapevine](https://grapevine.haus/) mud network/chat
|
||||
- [Messages to RSS](./RSS) - have your game notify people through RSS
|
||||
- [Messages to Twitter](./How-to-connect-Evennia-to-Twitter) - have Evennia send messages to [Twitter](https://twitter.com/) (requires some coding)
|
||||
|
||||
## Going public
|
||||
|
||||
- [Notes about security](Security) - some things to think about to stay safe(r)
|
||||
- [Using HAProxy](HAProxy-Config) - putting a proxy in front of the game server for security
|
||||
- [Using Apache as a webserver](Apache-Config) - use Apache instead of Evennia's webserver (limited support)
|
||||
- [Taking your server online](Online-Setup) - decide on where to host and configure your game for production
|
||||
- [Client support grid](Client-Support-Grid) - clients known to work (or not) with Evennia
|
||||
- [Notes about security](./Security) - some things to think about to stay safe(r)
|
||||
- [Using HAProxy](./HAProxy-Config) - putting a proxy in front of the game server for security
|
||||
- [Using Apache as a webserver](./Apache-Config) - use Apache instead of Evennia's webserver (limited support)
|
||||
- [Taking your server online](./Online-Setup) - decide on where to host and configure your game for production
|
||||
- [Client support grid](./Client-Support-Grid) - clients known to work (or not) with Evennia
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ to install Evennia as superuser.
|
|||
Make sure the `evennia` command works. Use `evennia -h` for usage help (or read on).
|
||||
|
||||
If you are having trouble, want to install in some other way (like with Docker) or want to contribute to
|
||||
Evennia itself, check out the [Extended Installation instructions](Extended-Installation).
|
||||
It also has a [troubleshooting section](Extended-Installation#Troubleshooting) for different operating
|
||||
Evennia itself, check out the [Extended Installation instructions](./Extended-Installation).
|
||||
It also has a [troubleshooting section](./Extended-Installation#Troubleshooting) for different operating
|
||||
systems.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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 [Setup Quickstart](Setup-Quickstart) page.
|
||||
Evennia as described in the [Setup Quickstart](./Setup-Quickstart) 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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue