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

Update docs with better markup

Browse source
This commit is contained in:
Griatch 2020-11-10 19:48:18 +01:00
parent 0fbffd7962
commit 43e2b0aba3
4 changed files with 104 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/source/Builder-Docs.md
View file

@ -4,7 +4,7 @@ This section contains information useful to world builders.
### Building basics
- [Default in-game commands](./Default-Command-Help)
- [Default in-game commands](api:evennia.commands.default)
- [Building Quick-start](./Building-Quickstart)
- [Giving build permissions to others](./Building-Permissions)
- [Adding text tags](./TextTags)
@ -29,7 +29,6 @@ This section contains information useful to world builders.
```toctree::
:hidden:
Default-Command-Help
Building-Quickstart
Building-Permissions
TextTags

159
docs/source/Client-Support-Grid.md
View file

@ -1,94 +1,109 @@
# Client Support Grid
This grid tries to gather Evennia-specific knowledge about the various clients and protocols used.
Everyone's welcome to report their findings.
This grid tries to gather info about different MU clients when used with Evennia.
If you want to report a problem, update an entry or add a client, make a
new [documentation issue](github:issue) for it. Everyone's encouraged to report their findings.
##### Legend:
##### Legend:
- **Name**: The name of the client. If it's only available for a specific OS, it should be noted
here too.
- **Name**: The name of the client. Also note if it's OS-specific.
- **Version**: Which version or range of client versions were tested.
- **Comments**: Any comments or quirks on using this client with Evennia should be added here. Also
note if some other protocol than Telnet is used (like Websockets, SSH etc).
- **Comments**: Any quirks on using this client with Evennia should be added here.
## Client Grid
Name | Version | Comments
:----------:------------
[Evennia webclient][1] | 0.6 | Uses WS/AJAX. [Current client issues][2]
[tintin++][3] | 2.0+ | No MXP support
[tinyfugue][4] | 5.0+ | No UTF-8 support
[MUSHclient][5] (Win) | 4.94 | NAWS reports full text area
[Zmud][6] (Win) | 7.21 | *UNTESTED*
[Cmud][7] (Win) | v3 | *UNTESTED*
[Potato][8] | 2.0.0b16 | No MXP, MCCP support. Win 32bit does not understand
"localhost", must use `127.0.0.1`. [Newline issue](https://github.com/evennia/evennia/issues/1131).
*Won't send a single blank line on Enter press.
[Mudlet][9] | 3.4+ | No known issues. Some older versions showed <> as html under MXP.
[SimpleMU][10] (Win) | full | *UNTESTED*. Discontinued. NAWS reports pixel size.
[Atlantis][11] (Mac) | 0.9.9.4 | No known issues.
[GMUD][12] | 0.0.1 | Can't handle any telnet handshakes. Not recommended.
[BeipMU][13] (Win) | 3.0.255 | No MXP support. Best to enable "MUD prompt handling", disable
"Handle HTML tags".
[MudRammer][14] (IOS) | 1.8.7 | Bad Telnet Protocol compliance: displays spurious characters.
[MUDMaster][15] (IOS) | 1.3.1 | *UNTESTED*
[BlowTorch][16] (Andr) | 1.1.3 | *Telnet NOP displays as spurious character.
[Mukluk][17] (Andr) | 2015.11.20| *Telnet NOP displays as spurious character. Has UTF-8/Emoji
support.
[Gnome-MUD][18] (Unix) | 0.11.2 | Telnet handshake errors. First (only) attempt at logging in
fails.
[Spyrit][19] | 0.4 | No MXP, OOB support.
[JamochaMUD][20] | 5.2 | Does not support ANSI within MXP text.
[DuckClient][21] (Chrome)| 4.2 | No MXP support. Displays Telnet Go-Ahead and WILL SUPPRESS-GO-AHEAD
as ù character. Also seems to run the `version` command on connection, which will not work in
`MULTISESSION_MODES` above 1.
[KildClient][22] | 2.11.1 | No known issues.
```eval_rst
[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/
+----------------------------+-----------+----------------------------------------------------------------+
| Name | Version | Comments |
+============================+===========+================================================================+
| `Evennia Webclient`_ | 0.9 | Evennia-specific |
+----------------------------+-----------+----------------------------------------------------------------+
| `tintin++`_ | 2.0+ | No MXP support |
+----------------------------+-----------+----------------------------------------------------------------+
| tinyfugue_ | 5.0+ | No UTF-8 support |
+----------------------------+-----------+----------------------------------------------------------------+
| MUSHclient_ (Win) | 4.94 | NAWS reports full text area |
+----------------------------+-----------+----------------------------------------------------------------+
| Zmud_ (Win) | 7.21 | *UNTESTED* |
+----------------------------+-----------+----------------------------------------------------------------+
| Cmud_ (Win) | v3 | *UNTESTED* |
+----------------------------+-----------+----------------------------------------------------------------+
| Potato_ | 2.0.0b16 | No MXP, MCCP support. Win 32bit does not understand |
| | | "localhost", must use `127.0.0.1`. |
+----------------------------+-----------+----------------------------------------------------------------+
| Mudlet_ | 3.4+ | No known issues. Some older versions showed <> as html |
| | | under MXP. |
+----------------------------+-----------+----------------------------------------------------------------+
| SimpleMU_ (Win) | full | Discontinued. NAWS reports pixel size. |
+----------------------------+-----------+----------------------------------------------------------------+
| Atlantis_ (Mac) | 0.9.9.4 | No known issues. |
+----------------------------+-----------+----------------------------------------------------------------+
| GMUD_ | 0.0.1 | Can't handle any telnet handshakes. Not recommended. |
+----------------------------+-----------+----------------------------------------------------------------+
| BeipMU_ (Win) | 3.0.255 | No MXP support. Best to enable "MUD prompt handling", disable |
| | | "Handle HTML tags". |
+----------------------------+-----------+----------------------------------------------------------------+
| MudRammer_ (IOS) | 1.8.7 | Bad Telnet Protocol compliance: displays spurious characters. |
+----------------------------+-----------+----------------------------------------------------------------+
| MUDMaster_ | 1.3.1 | *UNTESTED* |
+----------------------------+-----------+----------------------------------------------------------------+
| BlowTorch_ (Andr) | 1.1.3 | Telnet NOP displays as spurious character. |
+----------------------------+-----------+----------------------------------------------------------------+
| Mukluk_ (Andr) | 2015.11.20| Telnet NOP displays as spurious character. Has UTF-8/Emoji |
| | | support. |
+----------------------------+-----------+----------------------------------------------------------------+
| Gnome-MUD_ (Unix) | 0.11.2 | Telnet handshake errors. First (only) attempt at logging in |
| | | fails. |
+----------------------------+-----------+----------------------------------------------------------------+
| Spyrit_ | 0.4 | No MXP, OOB support. |
+----------------------------+-----------+----------------------------------------------------------------+
| JamochaMUD_ | 5.2 | Does not support ANSI within MXP text. |
+----------------------------+-----------+----------------------------------------------------------------+
| DuckClient_ (Chrome) | 4.2 | No MXP support. Displays Telnet Go-Ahead and |
| | | WILL SUPPRESS-GO-AHEAD as ù character. Also seems to run |
| | | the `version` command on connection, which will not work in |
| | | `MULTISESSION_MODES` above 1. |
+----------------------------+-----------+----------------------------------------------------------------+
| KildClient_ | 2.11.1 | No known issues. |
+----------------------------+-----------+----------------------------------------------------------------+
.. _Evennia Webclient: ../Components/Webclient.html
.. _tintin++: http://tintin.sourceforge.net/
.. _tinyfugue: http://tinyfugue.sourceforge.net/
.. _MUSHclient: http://mushclient.com/
.. _Zmud: http://forums.zuggsoft.com/index.php?page=4&action=file&file_id=65
.. _Cmud: http://forums.zuggsoft.com/index.php?page=4&action=category&cat_id=11
.. _Potato: http://www.potatomushclient.com/
.. _Mudlet: http://www.mudlet.org/
.. _SimpleMU: https://archive.org/details/tucows_196173_SimpleMU_MU_Client
.. _Atlantis: http://www.riverdark.net/atlantis/
.. _GMUD: https://sourceforge.net/projects/g-mud/
.. _BeipMU: http://www.beipmu.com/
.. _MudRammer: https://itunes.apple.com/us/app/mudrammer-a-modern-mud-client/id597157072
.. _MUDMaster: https://itunes.apple.com/us/app/mudmaster/id341160033
.. _BlowTorch: http://bt.happygoatstudios.com/
.. _Mukluk: https://play.google.com/store/apps/details?id=com.crap.mukluk
.. _Gnome-MUD: https://github.com/GNOME/gnome-mud
.. _Spyrit: https://spyrit.ierne.eu.org/
.. _JamochaMUD: http://jamochamud.org/
.. _DuckClient: http://duckclient.com/
.. _KildClient: https://www.kildclient.org/
```
## Workarounds for client issues:
### Issue: Telnet NOP displays as spurious character.
Known clients:
* [BlowTorch][16](Andr)
* [Mukluk][17](Andr)
* BlowTorch (Andr)
* Mukluk (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.
* In-game: Use `@option NOPKEEPALIVE=off` for the session, or use the `/save`
parameter to disable it for that Evennia 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.

30
docs/source/Contributing-Docs.md
View file

@ -2,7 +2,7 @@
```warning::
WARNING: This system is still WIP and many things are bound to change!
The creation of docs pages is still WIP and we are still figuring things out here and there.
```
Contributing to the docs is is like [contributing to the rest of Evennia][contributing]: Check out the branch of Evennia you want to edit the documentation for. Create your
@ -643,7 +643,7 @@ a good idea to end with four dashes `----`. This will create a visible line betw
class/function docs to follow. See for example [the Traits docs](api:evennia.contrib.traits).
All non-private classes, methods and functions must have a Google-style docstring, as per the
[Evennia coding style guidelines][github:evennia/CODING_STYLE.md]. This will then be correctly formatted
[Evennia coding style guidelines](github:evennia/CODING_STYLE.md). This will then be correctly formatted
into pretty api docs.
## Technical
@ -661,19 +661,19 @@ extension
to understand our friendly Google-style docstrings used in classes and functions etc.
[sphinx](https://www.sphinx-doc.org/en/master/)
[recommonmark](https://recommonmark.readthedocs.io/en/latest/index.html)
[commonmark](https://spec.commonmark.org/current/)
[commonmark-help](https://commonmark.org/help/)
[sphinx-autodoc](http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc)
[sphinx-napoleon](http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html)
[sphinx]: https://www.sphinx-doc.org/en/master/
[recommonmark]: https://recommonmark.readthedocs.io/en/latest/index.html
[commonmark]: https://spec.commonmark.org/current/
[commonmark-help]: https://commonmark.org/help/
[sphinx-autodoc]: http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc
[sphinx-napoleon]: http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
[getting-started]: Setup/Setup-Quickstart
[contributing]: ./Contributing
[ReST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
[ReST-tables](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables)
[ReST-directives](https://www.sphinx-doc.org/en/master/usage/restruturedtext/directives.html)
[Windows-WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
[ReST]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
[ReST-tables]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables
[ReST-directives]: https://www.sphinx-doc.org/en/master/usage/restruturedtext/directives.html
[Windows-WSL]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
[linkdemo]: #Links
[retext](https://github.com/retext-project/retext)
[grip](https://github.com/joeyespo/grip)
[pycharm](https://www.jetbrains.com/pycharm/)
[retext]: https://github.com/retext-project/retext
[grip]: https://github.com/joeyespo/grip
[pycharm]: https://www.jetbrains.com/pycharm/

1
docs/source/_templates/versioning.html
View file

@ -5,4 +5,5 @@
<li><a href="{{ item.url }}">{{ item.release }} ({{ item.name }} branch)</a></li>
{%- endfor %}
</ul>
{% endif %}