From 397b5feedfa1ef6ab043ff2b0872661dd1f382bf Mon Sep 17 00:00:00 2001 From: Griatch Date: Fri, 31 Jul 2020 18:15:53 +0200 Subject: [PATCH] Clean up client grid --- docs/source/Contributing-Docs.md | 2 +- docs/source/Howto/Howto-Overview.md | 4 +- .../Howto/Starting/Part3/A-Sittable-Object.md | 4 +- docs/source/Howto/Starting/Starting-Part2.md | 4 +- docs/source/Setup/Client-Support-Grid.md | 160 ++++++++++-------- docs/source/_static/basic.css | 21 ++- 6 files changed, 110 insertions(+), 85 deletions(-) diff --git a/docs/source/Contributing-Docs.md b/docs/source/Contributing-Docs.md index a43b33317c..c8872ba267 100644 --- a/docs/source/Contributing-Docs.md +++ b/docs/source/Contributing-Docs.md @@ -554,7 +554,7 @@ a plain HTML string in the markdown like so: #### Tables -A table is specified using [ReST table syntax][ReST-tables]: +A table is specified using [ReST table syntax][ReST-tables] (they don't need to be indented): ```` ```eval_rst diff --git a/docs/source/Howto/Howto-Overview.md b/docs/source/Howto/Howto-Overview.md index b28424f057..bf7e96431e 100644 --- a/docs/source/Howto/Howto-Overview.md +++ b/docs/source/Howto/Howto-Overview.md @@ -32,9 +32,7 @@ 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) -1. [Layout of our tutorial game](../Unimplemented) -1. [Some useful Contribs](Starting/Part2/Some-Useful-Contribs) +1. [Planning to use some useful Contribs](Starting/Part2/Planning-Some-Useful-Contribs) ### Part3: How we get there diff --git a/docs/source/Howto/Starting/Part3/A-Sittable-Object.md b/docs/source/Howto/Starting/Part3/A-Sittable-Object.md index e1382ae4b3..a51c9b52e4 100644 --- a/docs/source/Howto/Starting/Part3/A-Sittable-Object.md +++ b/docs/source/Howto/Starting/Part3/A-Sittable-Object.md @@ -1,4 +1,4 @@ -[prev lesson]() | [next lesson]() +[prev lesson](../../../Unimplemented) | [next lesson](../../../Unimplemented) # Making a sittable object @@ -799,4 +799,4 @@ Eagle-eyed readers will notice that the `stand` command sitting "on" the chair ( together with the `sit` command sitting "on" the Character (variant 2). There is nothing stopping you from mixing them, or even try a third solution that better fits what you have in mind. -[prev lesson]() | [next lesson]() \ No newline at end of file +[prev lesson](../../../Unimplemented) | [next lesson](../../../Unimplemented) \ No newline at end of file diff --git a/docs/source/Howto/Starting/Starting-Part2.md b/docs/source/Howto/Starting/Starting-Part2.md index 5fb48dfb39..39c72d99d1 100644 --- a/docs/source/Howto/Starting/Starting-Part2.md +++ b/docs/source/Howto/Starting/Starting-Part2.md @@ -18,9 +18,7 @@ 1. Introduction & Overview (you are here) 1. [On planning a game](Part2/Game-Planning) -1. [Multisession modes](../../Unimplemented) -1. [Layout of our tutorial game](../../Unimplemented) -1. [Some useful Contribs](Part2/Some-Useful-Contribs) +1. [Planning to use some useful Contribs](Part2/Planning-Some-Useful-Contribs) In Part two of the Starting tutorial we'll step back and plan out the kind of tutorial game we want to make. In the process we'll go through the common questions of "where to start" diff --git a/docs/source/Setup/Client-Support-Grid.md b/docs/source/Setup/Client-Support-Grid.md index e1b27f3de2..1a9fc0ef61 100644 --- a/docs/source/Setup/Client-Support-Grid.md +++ b/docs/source/Setup/Client-Support-Grid.md @@ -1,95 +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: - - **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 ++----------------------------+-----------+----------------------------------------------------------------+ +| 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. - - -[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/ \ No newline at end of file diff --git a/docs/source/_static/basic.css b/docs/source/_static/basic.css index e89235ddc2..d0fa172aba 100644 --- a/docs/source/_static/basic.css +++ b/docs/source/_static/basic.css @@ -390,14 +390,16 @@ table caption span.caption-number { table caption span.caption-text { } + table.docutils td, table.docutils th { padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; + border-top: 1px solid #aaa; + border-left: 1px solid #aaa; + border-right: 1px solid #aaa; border-bottom: 1px solid #aaa; } + table.footnote td, table.footnote th { border: 0 !important; } @@ -426,6 +428,19 @@ td > p:last-child { margin-bottom: 0px; } +thead { + border-bottom: 2px solid #aaa; +} + +.row-odd { + background: #edeee4; +} + +.row-even { + background: #f4f4ed; +} + + /* -- figures --------------------------------------------------------------- */ div.figure {