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

Fix all failing links and warnings

Browse source
This commit is contained in:
Griatch 2020-07-09 00:06:50 +02:00
parent 22743055fe
commit 09c602dd69
24 changed files with 102 additions and 97 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/source/Setup/Arxcode-installing-help.md → docs/source/Contrib/Arxcode-installing-help.md
View file

@ -22,9 +22,8 @@ better match with the vanilla Evennia install.
Firstly, set aside a folder/directory on your drive for everything to follow.
You need to start by installing [Evennia](http://www.evennia.com) by following most of the [Getting
Started
Instructions](Getting-Started) for your OS. The difference is that you need to `git clone
You need to start by installing [Evennia](http://www.evennia.com) by following most of the
[Getting Started Instructions](../Setup/Setup-Quickstart) for your OS. The difference is that you need to `git clone
https://github.com/TehomCD/evennia.git` instead of Evennia's repo because Arx uses TehomCD's older
Evennia 0.8 [fork](https://github.com/TehomCD/evennia), notably still using Python2. This detail is
important if referring to newer Evennia documentation.
@ -63,8 +62,8 @@ Cd to the root of your directory and clone the released source code from github:
A new folder `myarx` should appear next to the ones you already had. You could rename this to
something else if you want.
Cd into `myarx`. If you wonder about the structure of the game dir, you can [read more about it
here](Directory-Overview).
Cd into `myarx`. If you wonder about the structure of the game dir, you can
[read more about it here](../Howto/Starting/Part1/Gamedir-Overview).
### Clean up settings

3
docs/source/Contrib/Static-In-Game-Map.md
View file

@ -291,8 +291,7 @@ def return_minimap(x, y, radius = 2):
map = ""
#For each row we need, add the characters we need.
for valuey in world_map[y-radius:y+radius+1]:
for valuex in valuey[x-radius:x+radius+1]:
for valuey in world_map[y-radius:y+radius+1]: for valuex in valuey[x-radius:x+radius+1]:
map += valuex
map += "\n"

20
docs/source/Howto/Howto-Overview.md
View file

@ -32,29 +32,29 @@ in mind for your own game, this will give you a good start.
1. [Introduction & Overview](Starting/Starting-Part2)
1. [On planning a game](Starting/Part2/Game-Planning)
1. [Multisession modes](Unimplemented.md)
1. [Layout of our tutorial game](#)
1. [Multisession modes](../Unimplemented)
1. [Layout of our tutorial game](../Unimplemented)
1. [Making use of contribs](Starting/Starting-Part3)
1. [Making a custom Character](Starting/Implementing-a-game-rule-system)
1. [Character generation](#)
1. [Resolving skills and challenges](#)
1. [Character generation](../Unimplemented)
1. [Resolving skills and challenges](../Unimplemented)
1. [NPCs and mobiles](Starting/Coordinates)
1. [Quests and Zones](#)
1. [A Combat system](Combat-System)
1. [Quests and Zones](../Unimplemented)
1. [A Combat system](../Unimplemented)
### Part 4: Using what we created
1. [Introduction & Overview](Starting/Starting-Part4)
1. [Building the tech demo](#)
1. [Creating a game world](#)
1. [Building the tech demo](../Unimplemented)
1. [Creating a game world](../Unimplemented)
### Part 5: Showing the world
1. [Introduction & Overview](Starting/Starting-Part5)
1. [Add a web page](Starting/Add-a-simple-new-web-page)
1. [More on adding web features](Starting/Web-Tutorial)
1. [Taking your game online](#)
1. [Next steps](#)
1. [Taking your game online](../Unimplemented)
1. [Next steps](../Unimplemented)
## FAQs

2
docs/source/Howto/Starting/Parsing-command-arguments,-theory-and-best-practices.md
View file

@ -652,7 +652,7 @@ about... what is this `"book"`?
To get an object from a string, we perform an Evennia search. Evennia provides a `search` method on
all typeclassed objects (you will most likely use the one on characters or accounts). This method
supports a very wide array of arguments and has [its own tutorial](Tutorial-Searching-For-Objects).
supports a very wide array of arguments and has [its own tutorial](Part1/Searching-Things).
Some examples of useful cases follow:
### Local searches

4
docs/source/Howto/Starting/Part1/Adding-Commands.md
View file

@ -1,6 +1,6 @@
# Our own commands
[prev lesson](Searching-Things) | [next lesson]()
[prev lesson](Searching-Things) | [next lesson](More-on-Commands)
In this lesson we'll learn how to create our own Evennia _Commands_. If you are new to Python you'll
also learn some more basics about how to manipulate strings and get information out of Evennia.
@ -393,4 +393,4 @@ We also upset a dragon.
In the next lesson we'll learn how to hit Smaug with different weapons. We'll also
get into how we replace and extend Evennia's default Commands.
[prev lesson](Searching-Things) | [next lesson]()
[prev lesson](Searching-Things) | [next lesson](More-on-Commands)

4
docs/source/Howto/Starting/Part1/Building-Quickstart.md
View file

@ -3,7 +3,7 @@
[prev lesson](../Starting-Part1) | [next lesson](Tutorial-World-Introduction)
In this lesson we will test out what we can do in-game out-of-the-box. Evennia ships with
[~90 default commands](Default-Command-Help), and while you can override those as you please,
[around 90 default commands](../../../Component/Default-Command-Help), and while you can override those as you please,
they can be quite useful.
Connect and log into your new game and you will end up in the "Limbo" location. This
@ -152,7 +152,7 @@ the raw description of your current room (including color codes), so that you ca
set its description to something else.
You create new Commands (or modify existing ones) in Python outside the game. We will get to that
later, in the [Commands tutorial](../Adding-Command-Tutorial).
later, in the [Commands tutorial](Adding-Commands).
## Get a Personality

5
docs/source/Howto/Starting/Part1/Django-queries.md
View file

@ -1,6 +1,6 @@
## Django Database queries
[prev lesson](Searching-Things) | [next lesson]()
[prev lesson](Searching-Things) | [next lesson](../Starting-Part2)
```important:: More advanced lesson!
@ -398,5 +398,4 @@ query using Django is a powerful skill to have.
This concludes the first part of the Evennia starting tutorial - "What we have". Now we have a good foundation
to understand how to plan what our tutorial game will be about.
[prev lesson](Searching-Things) | [next lesson]()
[prev lesson](Searching-Things) | [next lesson](../Starting-Part2)

28
docs/source/Howto/Starting/Part1/Evennia-Library-Overview.md
View file

@ -52,26 +52,26 @@ the _actual_ library, the thing covered by the API auto-docs and what you get wh
This the the structure of the Evennia library:
- evennia
- [`__init__.py`](Evennia-API#shortcuts) - The "flat API" of Evennia resides here.
- [`settings_default.py`](Server-Conf#Settings-file) - Root settings of Evennia. Copy settings
- [`__init__.py`](../../../Evennia-API#shortcuts) - The "flat API" of Evennia resides here.
- [`settings_default.py`](../../../Component/Server-Conf#Settings-file) - Root settings of Evennia. Copy settings
from here to `mygame/server/settings.py` file.
- [`commands/`](Commands) - The command parser and handler.
- [`commands/`](../../../Component/Commands) - The command parser and handler.
- `default/` - The [default commands](../../../Component/Default-Command-Help) and cmdsets.
- [`comms/`](Communications) - Systems for communicating in-game.
- [`comms/`](../../../Component/Communications) - Systems for communicating in-game.
- `contrib/` - Optional plugins too game-specific for core Evennia.
- `game_template/` - Copied to become the "game directory" when using `evennia --init`.
- [`help/`](Help-System) - Handles the storage and creation of help entries.
- [`help/`](../../../Component/Help-System) - Handles the storage and creation of help entries.
- `locale/` - Language files ([i18n](../../../Concept/Internationalization)).
- [`locks/`](Locks) - Lock system for restricting access to in-game entities.
- [`objects/`](Objects) - In-game entities (all types of items and Characters).
- [`prototypes/`](Spawner-and-Prototypes) - Object Prototype/spawning system and OLC menu
- [`accounts/`](Accounts) - Out-of-game Session-controlled entities (accounts, bots etc)
- [`scripts/`](Scripts) - Out-of-game entities equivalence to Objects, also with timer support.
- [`server/`](Portal-And-Server) - Core server code and Session handling.
- [`locks/`](../../../Component/Locks) - Lock system for restricting access to in-game entities.
- [`objects/`](../../../Component/Objects) - In-game entities (all types of items and Characters).
- [`prototypes/`](../../../Component/Spawner-and-Prototypes) - Object Prototype/spawning system and OLC menu
- [`accounts/`](../../../Component/Accounts) - Out-of-game Session-controlled entities (accounts, bots etc)
- [`scripts/`](../../../Component/Scripts) - Out-of-game entities equivalence to Objects, also with timer support.
- [`server/`](../../../Component/Portal-And-Server) - Core server code and Session handling.
- `portal/` - Portal proxy and connection protocols.
- [`typeclasses/`](Typeclasses) - Abstract classes for the typeclass storage and database system.
- [`utils/`](Coding-Utils) - Various miscellaneous useful coding resources.
- [`web/`](Web-Features) - Web resources and webserver. Partly copied into game directory on initialization.
- [`typeclasses/`](../../../Component/Typeclasses) - Abstract classes for the typeclass storage and database system.
- [`utils/`](../../../Component/Coding-Utils) - Various miscellaneous useful coding resources.
- [`web/`](../../../Concept/Web-Features) - Web resources and webserver. Partly copied into game directory on initialization.
```sidebar:: __init__.py

2
docs/source/Howto/Starting/Part1/Gamedir-Overview.md
View file

@ -203,7 +203,7 @@ people change and re-structure this in various ways to better fit their ideas.
- [batch_cmds.ev](github:evennia/game_template/world/batch_cmds.ev) - This is an `.ev` file, which is essentially
just a list of Evennia commands to execute in sequence. This one is empty and ready to expand on. The
[Tutorial World](Tutorial-World-Introduction) was built with such a batch-file.
- [prototypes.py](github:evennia/game_template/world/prototypes.py) - A [prototype](Prototype-and-Spawner) is a way
- [prototypes.py](github:evennia/game_template/world/prototypes.py) - A [prototype](../../../Component/Spawner-and-Prototypes) is a way
to easily vary objects without changing their base typeclass. For example, one could use prototypes to
tell that Two goblins, while both of the class 'Goblin' (so they follow the same code logic), should have different
equipment, stats and looks.

3
docs/source/Howto/Starting/Part1/Learning-Typeclasses.md
View file

@ -570,8 +570,7 @@ go around and re-run the method on everyone manually. For the Python beginner, d
try out Python _loops_. We try them out in multi-line Python mode:
> py
> for a in [1, 2, "foo"]:
> print(a)
> for a in [1, 2, "foo"]: > print(a)
1
2
foo

14
docs/source/Howto/Starting/Part2/Game-Planning.md
View file

@ -6,8 +6,8 @@ cracking! But where to start? Here are some ideas for a workflow. Note that the
page are just that - suggestions. Also, they are primarily aimed at a lone hobby designer or a small
team developing a game in their free time. There is an article in the Imaginary Realities e-zine
which was written by the Evennia lead dev. It focuses more on you finding out your motivations for
making a game - you can [read the article here](http://journal.imaginary-
realities.com/volume-07/issue-03/where-do-i-begin/index.html).
making a game - you can
[read the article here](http://journal.imaginary-realities.com/volume-07/issue-03/where-do-i-begin/index.html).
Below are some minimal steps for getting the first version of a new game world going with players.
@ -132,11 +132,11 @@ Talker-type game you *will* have to bite the bullet and code your game (or find
do it for you).
Even if you won't code anything yourself, as a designer you need to at least understand the basic
paradigms of Evennia, such as [Objects](../../../Component/Objects), [Commands](../../../Component/Commands) and [Scripts](../../../Component/Scripts) and
how they hang together. We recommend you go through the [Tutorial World](Tutorial-World-
Introduction) in detail (as well as glancing at its code) to get at least a feel for what is
involved behind the scenes. You could also look through the tutorial for [building a game from
scratch](Tutorial-for-basic-MUSH-like-game).
paradigms of Evennia, such as [Objects](../../../Component/Objects),
[Commands](../../../Component/Commands) and [Scripts](../../../Component/Scripts) and
how they hang together. We recommend you go through the [Tutorial World](../Part1/Tutorial-World-Introduction) in detail (as well as glancing at its code) to get at least a feel for what is
involved behind the scenes. You could also look through the tutorial for
[building a game from scratch](../Tutorial-for-basic-MUSH-like-game).
During Coding you look back at the things you wanted during the **Planning** phase and try to
implement them. Don't be shy to update your plans if you find things easier/harder than you thought.

1
docs/source/Howto/Starting/Starting-Part3.md
View file

@ -0,0 +1 @@
# Evennia Starting Tutorial (Part 3)

3
docs/source/Howto/Starting/Starting-Part4.md
View file

@ -0,0 +1,3 @@
# Evennia Starting Tutorial (Part 4)
TODO.

1
docs/source/Howto/Starting/Starting-Part5.md
View file

@ -0,0 +1 @@
# Evennia Starting Tutorial (part 5)

17
docs/source/Howto/Starting/Web-Tutorial.md
View file

@ -4,8 +4,8 @@
Evennia uses the [Django](https://www.djangoproject.com/) web framework as the basis of both its
database configuration and the website it provides. While a full understanding of Django requires
reading the Django documentation, we have provided this tutorial to get you running with the basics
and how they pertain to Evennia. This text details getting everything set up. The [Web-based
Character view Tutorial](Web-Character-View-Tutorial) gives a more explicit example of making a
and how they pertain to Evennia. This text details getting everything set up. The
[Web-based Character view Tutorial](../Web-Character-View-Tutorial) gives a more explicit example of making a
custom web page connected to your game, and you may want to read that after finishing this guide.
## A Basic Overview
@ -24,9 +24,8 @@ in [HTML](http://en.wikipedia.org/wiki/Html) for the user, and a `static` folder
like [CSS](http://en.wikipedia.org/wiki/CSS), [Javascript](http://en.wikipedia.org/wiki/Javascript),
and Image files (You may note your mygame/web folder does not have a `static` or `template` folder.
This is intended and explained further below). Django applications may also have a `models.py` file
for storing information in the database. We will not change any models here, take a look at the [New
Models](New-Models) page (as well as the [Django
docs](https://docs.djangoproject.com/en/1.7/topics/db/models/) on models) if you are interested.
for storing information in the database. We will not change any models here, take a look at the
[New Models](../../Concept/New-Models) page (as well as the [Django docs](https://docs.djangoproject.com/en/1.7/topics/db/models/) on models) if you are interested.
There is also a root `urls.py` that determines the URL structure for the entire project. A starter
`urls.py` is included in the default game template, and automatically imports all of Evennia's
@ -104,8 +103,8 @@ means that when you edit a template, the changes are instant. You don't have to
run any extra commands to see these changes - reloading the web page in your browser is enough.
To replace the index page's text, we'll need to find the template for it. We'll go into more detail
about how to determine which template is used for rendering a page in the [Web-based Character view
Tutorial](Web-Character-View-Tutorial). For now, you should know that the template we want to change
about how to determine which template is used for rendering a page in the
[Web-based Character view Tutorial](../Web-Character-View-Tutorial). For now, you should know that the template we want to change
is stored in `evennia/web/website/templates/website/index.html`.
To replace this template file, you will put your changed template inside the
@ -120,8 +119,8 @@ original file already has all the markup and tags, ready for editing.
## Further reading
For further hints on working with the web presence, you could now continue to the [Web-based
Character view Tutorial](Web-Character-View-Tutorial) where you learn to make a web page that
For further hints on working with the web presence, you could now continue to the
[Web-based Character view Tutorial](../Web-Character-View-Tutorial) where you learn to make a web page that
displays in-game character stats. You can also look at [Django's own
tutorial](https://docs.djangoproject.com/en/1.7/intro/tutorial01/) to get more insight in how Django
works and what possibilities exist.

53
docs/source/Setup/Client-Support-Grid.md
View file

@ -44,6 +44,33 @@ as ù character. Also seems to run the `version` command on connection, which wi
`MULTISESSION_MODES` above 1.
[KildClient][22] | 2.11.1 | No known issues.
## Workarounds for client issues:
### Issue: Telnet NOP displays as spurious character.
Known clients:
* [BlowTorch][16] (Andr)
* [Mukluk][17] (Andr)
Workaround:
* Set the command in game to `@option NOPKEEPALIVE=off` for the session, or use the `/save`
parameter to disable it for that Evennian account permanently.
* Client-side: Set a gag-type trigger on the NOP character to make it invisible to the client.
### Issue: Won't send blank line on Enter key press.
Known clients:
* [Potato][8]
Workaround:
* Press Control Enter, then Enter key again to send blank line.
[1](https://github.com/evennia/evennia/wiki/Web%20features#web-client)
[2](https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&q=client+status%3Dopen+])
[3](http://tintin.sourceforge.net/)
@ -66,29 +93,3 @@ as ù character. Also seems to run the `version` command on connection, which wi
[20](http://jamochamud.org/)
[21](http://duckclient.com/)
[22](https://www.kildclient.org/)
## Workarounds for client issues:
### Issue: Telnet NOP displays as spurious character.
Known clients:
* [BlowTorch][16](Andr)
* [Mukluk][17](Andr)
Workaround:
* Set the command in game to `@option NOPKEEPALIVE=off` for the session, or use the `/save`
parameter to disable it for that Evennian account permanently.
* Client-side: Set a gag-type trigger on the NOP character to make it invisible to the client.
### Issue: Won't send blank line on Enter key press.
Known clients:
* [Potato][8]
Workaround:
* Press Control Enter, then Enter key again to send blank line.

6
docs/source/Setup/Extended-Installation.md
View file

@ -445,9 +445,9 @@ tutorial is built. Once done, the `tutorial` exit will have appeared out of Limb
Once you get back to `Limbo` from the tutorial (if you get stuck in the tutorial quest you can do
`@tel #2` to jump to Limbo), a good idea is to learn how to [start, stop and reload](Start-Stop-
Reload) the Evennia server. You may also want to familiarize yourself with some [commonly used terms
in our Glossary](Glossary). After that, why not experiment with [creating some new items and build
some new rooms](Building-Quickstart) out from Limbo.
Reload) the Evennia server. You may also want to familiarize yourself with some
[commonly used terms in our Glossary](../Glossary). After that, why not experiment with
[creating some new items and build some new rooms](../Howto/Starting/Part1/Building-Quickstart) out from Limbo.
From here on, you could move on to do one of our [introductory tutorials](../Howto/Howto-Overview) or simply dive
headlong into Evennia's comprehensive [manual](https://github.com/evennia/evennia/wiki). While

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

@ -87,8 +87,8 @@ 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 [Getting
Started](Getting-Started) instruction, we repeat them here for clarity.
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.
To start a new game:

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

@ -178,8 +178,8 @@ SSH_INTERFACES = ['0.0.0.0']
AMP_PORT = 4006
```
The `AMP_PORT` is required to work, since this is the internal port linking Evennia's [Server and
Portal](Portal-And-Server) components together. The other ports are encrypted ports that may be
The `AMP_PORT` is required to work, since this is the internal port linking Evennia's
[Server and Portal](../Component/Portal-And-Server) components together. The other ports are encrypted ports that may be
useful for custom protocols but are otherwise not used.
### Lockdown mode
@ -250,7 +250,7 @@ to use DNS verification.
## Relevant SSL Proxy Setup Information
- [Apache webserver configuration](Apache-Config) (optional)
- [HAProxy Config](HAProxy-Config-(Optional))
- [HAProxy Config](HAProxy-Config)
## Hosting locally or remotely?

3
docs/source/Setup/Settings-File.md
View file

@ -0,0 +1,3 @@
# The Evennia Default Settings file
TODO

2
docs/source/Setup/Setup-Overview.md
View file

@ -12,7 +12,7 @@ This documentation covers how to setup and maintain the server, from first insta
## Installing custom game dirs
- [Installing Arxcode](Arxcode-installing-help) - a custom gamedir based on the popular Evennia game [Arx](https://play.arxgame.org/)
- [Installing Arxcode](../Contrib/Arxcode-installing-help) - a custom gamedir based on the popular Evennia game [Arx](https://play.arxgame.org/)
## Configuring

2
docs/source/Setup/Setup-Quickstart.md
View file

@ -90,4 +90,4 @@ Full stop of the server (will need to use `start` to activate it again):
## The Next step
Why not head into the [Starting Tutorial](../Howto/Starting/Starting-Overview) to learn how to start making your new game!
Why not head into the [Starting Tutorial](../Howto/Starting/Starting-Part1) to learn how to start making your new game!

3
docs/source/toc.md
View file

@ -68,6 +68,7 @@
- [Concept/Web Features](Concept/Web-Features)
- [Concept/Zones](Concept/Zones)
- [Contrib/A voice operated elevator using events](Contrib/A-voice-operated-elevator-using-events)
- [Contrib/Arxcode installing help](Contrib/Arxcode-installing-help)
- [Contrib/Building menus](Contrib/Building-menus)
- [Contrib/Contrib Overview](Contrib/Contrib-Overview)
- [Contrib/Dialogues in events](Contrib/Dialogues-in-events)
@ -132,7 +133,6 @@
- [Licensing](Licensing)
- [Links](Links)
- [Setup/Apache Config](Setup/Apache-Config)
- [Setup/Arxcode installing help](Setup/Arxcode-installing-help)
- [Setup/Choosing An SQL Server](Setup/Choosing-An-SQL-Server)
- [Setup/Client Support Grid](Setup/Client-Support-Grid)
- [Setup/Evennia Game Index](Setup/Evennia-Game-Index)
@ -150,6 +150,7 @@
- [Setup/Setup Overview](Setup/Setup-Overview)
- [Setup/Setup Quickstart](Setup/Setup-Quickstart)
- [Setup/Start Stop Reload](Setup/Start-Stop-Reload)
- [Unimplemented](Unimplemented)
- [index](index)
```toctree::