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

Doc refactor/renaming

Browse source
This commit is contained in:
Griatch 2020-07-11 10:41:33 +02:00
parent 9d8e8d7693
commit b5b265ec3b
115 changed files with 518 additions and 434 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -71,25 +71,25 @@ 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/)
[4](http://tinyfugue.sourceforge.net/)
[5](http://mushclient.com/)
[6](http://forums.zuggsoft.com/index.php?page=4&action=file&file_id=65)
[7](http://forums.zuggsoft.com/index.php?page=4&action=category&cat_id=11)
[8](http://www.potatomushclient.com/)
[9](http://www.mudlet.org/)
[10](https://archive.org/details/tucows_196173_SimpleMU_MU_Client)
[11](http://www.riverdark.net/atlantis/)
[12](https://sourceforge.net/projects/g-mud/)
[13](http://www.beipmu.com/)
[14](https://itunes.apple.com/us/app/mudrammer-a-modern-mud-client/id597157072)
[15](https://itunes.apple.com/us/app/mudmaster/id341160033)
[16](http://bt.happygoatstudios.com/)
[17](https://play.google.com/store/apps/details?id=com.crap.mukluk)
[18](https://github.com/GNOME/gnome-mud)
[19](https://spyrit.ierne.eu.org/)
[20](http://jamochamud.org/)
[21](http://duckclient.com/)
[22](https://www.kildclient.org/)
[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/
[4]: http://tinyfugue.sourceforge.net/
[5]: http://mushclient.com/
[6]: http://forums.zuggsoft.com/index.php?page=4&action=file&file_id=65
[7]: http://forums.zuggsoft.com/index.php?page=4&action=category&cat_id=11
[8]: http://www.potatomushclient.com/
[9]: http://www.mudlet.org/
[10]: https://archive.org/details/tucows_196173_SimpleMU_MU_Client
[11]: http://www.riverdark.net/atlantis/
[12]: https://sourceforge.net/projects/g-mud/
[13]: http://www.beipmu.com/
[14]: https://itunes.apple.com/us/app/mudrammer-a-modern-mud-client/id597157072
[15]: https://itunes.apple.com/us/app/mudmaster/id341160033
[16]: http://bt.happygoatstudios.com/
[17]: https://play.google.com/store/apps/details?id=com.crap.mukluk
[18]: https://github.com/GNOME/gnome-mud
[19]: https://spyrit.ierne.eu.org/
[20]: http://jamochamud.org/
[21]: http://duckclient.com/
[22]: https://www.kildclient.org/

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

@ -160,7 +160,7 @@ Your final folder structure should look like this:
mygame/
```
You can [configure Evennia](../Component/Server-Conf#settings-file) extensively, for example
You can [configure Evennia](../Components/Server-Conf#settings-file) extensively, for example
to use a [different database](./Choosing-An-SQL-Server). For now we'll just stick
to the defaults though.
@ -272,7 +272,7 @@ Your final folder structure should look like this:
mygame/
```
You can [configure Evennia](../Component/Server-Conf#settings-file) extensively, for example
You can [configure Evennia](../Components/Server-Conf#settings-file) extensively, for example
to use a [different database](./Choosing-An-SQL-Server). We'll go with the
defaults here.
@ -413,7 +413,7 @@ path\to\muddev
mygame\
```
You can [configure Evennia](../Component/Server-Conf#settings-file) extensively, for example
You can [configure Evennia](../Components/Server-Conf#settings-file) extensively, for example
to use a [different database](./Choosing-An-SQL-Server). We'll go with the
defaults here.

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

@ -29,7 +29,7 @@ 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](../Component/Commands) in order to tweet. If you are unsure about how commands work and how to add
[Command](../Components/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/Starting/Part1/Adding-Commands)
before continuing.
@ -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](../Component/Locks) as you feel is appropriate. Change the overall
= tweet`). You may change the [lock](../Components/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

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](../Component/Communications) to an IRC channel you can communicate also with people not on
Evennia's [Channels](../Components/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/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](../Component/Server-Conf#settings-file). To have Evennia recognize changed port settings you have
[settings file](../Components/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
@ -179,7 +179,7 @@ AMP_PORT = 4006
```
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
[Server and Portal](../Components/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

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

@ -20,7 +20,7 @@ to give you a menu with options.
## Starting Evennia
Evennia consists of two components, the Evennia [Server and Portal](../Component/Portal-And-Server). Briefly,
Evennia consists of two components, the Evennia [Server and Portal](../Components/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](../Component/Scripts). It also calls `at_server_reload()` hooks on all
doesn't kill "persistent" [Scripts](../Components/Scripts). It also calls `at_server_reload()` hooks on all
objects so you
can save eventual temporary properties you want.