diff --git a/docs/source/Coding/Coding-Overview.md b/docs/source/Coding/Coding-Overview.md index 60945fedb7..57d23f04b0 100644 --- a/docs/source/Coding/Coding-Overview.md +++ b/docs/source/Coding/Coding-Overview.md @@ -31,7 +31,7 @@ Quirks.md ## Evennia Changelog -``` +```{toctree} :maxdepth: 2 Changelog.md diff --git a/docs/source/Links.md b/docs/source/Links.md index 088ba072c6..ab585774b3 100644 --- a/docs/source/Links.md +++ b/docs/source/Links.md @@ -5,51 +5,30 @@ ## Official Evennia resources - [evennia.com](https://www.evennia.com) - Main Evennia portal page. Links to all corners of Evennia. -- [Evennia's manual on ReadTheDocs](https://readthedocs.org/projects/evennia/) - Read and download -offline in html, PDF or epub formats. -- [Evennia development blog](https://evennia.blogspot.com/) - Musings from the lead developer. +- [Evennia development blog](https://www.evennia.com/devblog/index.html) - Musings from the lead developer. - [Evennia on GitHub](https://github.com/evennia/evennia) - Download code and read documentation. +- [Evennia on PyPi](https://pypi.python.org/pypi/evennia) - [Evennia on Open Hub](https://www.openhub.net/p/6906) -- [Evennia on OpenHatch](https://openhatch.org/projects/Evennia) -- [Evennia on PyPi](https://pypi.python.org/pypi/Evennia-MUD-Server/) ## Evennia Community - [Evennia Game Index](http://games.evennia.com/) - An automated listing of Evennia games. -- [Evennia official Discord channel](https://discord.gg/AJJpcRUhtF) +- [Evennia official Discord channel](https://discord.gg/AJJpcRUhtF) - Chat and get help! - [Evennia official forums](https://github.com/evennia/evennia/discussions) on Github Discussions. -- [Evennia subreddit](https://www.reddit.com/r/Evennia/) +- [Evennia subreddit](https://www.reddit.com/r/Evennia/) - A little slower moving, but still active -## Third-party Evennia tools +## Third-party -- [Discord relay](https://github.com/InspectorCaracal/evennia-things/tree/main/discord_relay) - Two-way chat relays between Evennia channels and Discord channels. -- [docker-compose for Evennia](https://github.com/gtaylor/evennia-docker) - A quick-install setup for running Evennia in a [Docker container](https://www.docker.com/). (See [the official Evennia docs](https://www.evennia.com/docs/latest/Running-Evennia-in-Docker.html) for more details on running Evennia with Docker.) -- [Evcolor](https://github.com/taladan/Pegasus/blob/origin/world/utilities/evcolor) - Optional coloration for Evennia unit-test output. -- [Evennia-wiki](https://github.com/vincent-lg/evennia-wiki) - An Evennia-specific Wiki for your website. -- [nextRPI](https://github.com/cluebyte/nextrpi) - A github project for making a toolbox for people to make [RPI](https://www.topmudsites.com/forums/showthread.php?t=4804)-style Evennia games. -- [Paxboards](https://github.com/aurorachain/paxboards) - Evennia bulletin board system (both for telnet/web). -- [Unreal Engine Evennia plugin](https://www.unrealengine.com/marketplace/en-US/slug/evennia-plugin) an in-progress Unreal plugin for integrating Evennia with Epic Games' Unreal Engine. -- [vim-evennia](https://github.com/amfl/vim-evennia) - A mode for editing batch-build files (`.ev`) files in the [vim](https://www.vim.org/) text editor (Emacs users can use [evennia- -mode.el](https://github.com/evennia/evennia/blob/master/evennia/utils/evennia-mode.el)). -- [The world of Cool battles sources](https://github.com/FlutterSprite/coolbattles) - Open source turn-based battle system for an older version of Evennia. -- [Other Evennia-related repos on github](https://github.com/search?p=1&q=evennia) - ----- - -## Evennia-Based Projects - -### Code bases +- [Evennia-related repos on github](https://github.com/search?p=1&q=evennia) +- [EvscapeRoom](https://github.com/Griatch/evscaperoom) Full code of Evennia-based multiplayer escaperoom (engine is an [Evennia contrib](Contribs/Contrib-Evscaperoom.md)) - [Arx sources](https://github.com/Arx-Game/arxcode) - Open-source code release of the very popular [Arx](https://play.arxmush.org/) Evennia game. [Here are instructions for installing](https://www.evennia.com/docs/1.0-dev/Howtos/Arxcode-Installation.html) - [Encarnia sources](https://github.com/whitehorse-io/encarnia) - An open-sourced game dir for an older version of Evennia with things like races, combat etc. [Summary here](https://www.reddit.com/r/MUD/comments/6z6s3j/encarnia_an_evennia_python_mud_code_base_with/). - [The dark net/March Hare MUD](https://github.com/thedarknet/evennia) from the 2019 [DEF CON 27](https://www.defcon.org/html/defcon-27/dc-27-index.html) hacker conference in Paris. This is an Evennia game dir with batchcode to build the custom _Hackers_ style cyberspace zone with puzzles and challenges [used during the conference](https://dcdark.net/home#). -- [Muddery](https://github.com/muddery/muddery) - A mud framework under development, based on an older fork of Evennia. It has some specific design goals for building and extending the game based on input files. ### Other -- [Discord live blog](https://discordapp.com/channels/517176782357528616/517176782781415434) of the _Blackbirds_ Evennia game project. - [Evennia for MUSHers](https://musoapbox.net/topic/1150/evennia-for-mushers) - An article describing Evennia for those used to the MUSH way of doing things. -- *[Language Understanding for Text games using Deep reinforcement learning](http://news.mit.edu/2015/learning-language-playing-computer-games-0924#_msocom_1)* -([PDF](https://people.csail.mit.edu/karthikn/pdfs/mud-play15.pdf)) - MIT research paper using Evennia to train AIs. +- *[Language Understanding for Text games using Deep reinforcement learning](http://news.mit.edu/2015/learning-language-playing-computer-games-0924#_msocom_1)* ([PDF](https://people.csail.mit.edu/karthikn/pdfs/mud-play15.pdf)) - MIT research paper using Evennia to train AIs. ---- @@ -69,15 +48,18 @@ mode.el](https://github.com/evennia/evennia/blob/master/evennia/utils/evennia-mo - [Nick Gammon's hints thread](http://www.gammon.com.au/forum/bbshowpost.php?bbsubject_id=5959) - Contains a very useful list of things to think about when starting your new MUD. - [Raph Koster's laws of game design](https://www.raphkoster.com/games/laws-of-online-world-design/the-laws-of-online-world-design/) - thought-provoking guidelines and things to think about when designing a virtual multiplayer world (Raph is known for *Ultima Online* among other things). -### Community +### Interesting Communities - [Grapevine](https://grapevine.haus/) - MUD listings and inter-game chat network - [MUD Coder's Guild](https://mudcoders.com/) - A blog and [associated Slack channel](https://slack.mudcoders.com/) with discussions on MUD development. +- [Multi User Dungeon Discord](https://discord.gg/multi-user-dungeon-279748146316312576) General MUD development discord server - [MudBytes](http://www.mudbytes.net/) - MUD listing and forums - [MudConnector](http://www.mudconnect.com/) - MUD listing and forums - [MudLab](http://mudlab.org/) - MUD design discussion forum +- [BrandMuDay](https://brandmuday.mythicus.net/) MU* forum mainly focused on MUSH-type gaming. - [MuSoapbox](https://musoapbox.net/) - MU* forum mainly focused on MUSH-type gaming. - [Top Mud Sites](http://www.topmudsites.com/) - MUD listing and forums +- [r/MUD on Reddit](https://www.reddit.com/r/MUD/) MUD-centered subreddit ---- @@ -103,16 +85,14 @@ mode.el](https://github.com/evennia/evennia/blob/master/evennia/utils/evennia-mo - [Python Website](https://www.python.org/) - [Documentation](https://www.python.org/doc/) - [Tutorial](https://docs.python.org/tut/tut.html) - - [Library Reference](https://docs.python.org/lib/lib.html) - - [Language Reference](https://docs.python.org/ref/ref.html) -- [Python tips and tricks](https://www.siafoo.net/article/52) - [Jetbrains Python academy](https://hyperskill.org/onboarding?track=python) - free online programming curriculum for different skill levels -### Blogs +### General RPG - [Lost Garden](https://lostgarden.home.blog/) - A game development blog with long and interesting articles (not MUD-specific) - [What Games Are](http://whatgamesare.com/) - A blog about general game design (not MUD-specific) - [The Alexandrian](https://thealexandrian.net/) - A blog about tabletop roleplaying and board games, but with lots of general discussion about rule systems and game balance that could be applicable also for MUDs. +- [r/RPG on Reddit](https://www.reddit.com/r/rpg/) General RPG subreddit ### Literature @@ -126,17 +106,7 @@ mode.el](https://github.com/evennia/evennia/blob/master/evennia/utils/evennia-mo made the PDF of his Designing Virtual Worlds freely available through his own website ([Designing Virtual Worlds](https://mud.co.uk/dvw/)). A direct link to the PDF can be found [here](https://mud.co.uk/richard/DesigningVirtualWorlds.pdf). -- David M. Beazley *Python Essential Reference (4th ed)* - ([amazon page](https://www.amazon.com/Python-Essential-Reference-David-Beazley/dp/0672329786/)) - - Our recommended book on Python; it not only efficiently summarizes the language but is also - an excellent reference to the standard library for more experienced Python coders. -- Luciano Ramalho, *Fluent Python* - ([O'Reilly page](https://shop.oreilly.com/product/0636920032519.do)) - - This is an excellent book for experienced Python coders willing to take their code to the next level. - A great read with a lot of useful info also for veteran Pythonistas. -- Richard Cantillon *An Essay on Economic Theory* - ([free pdf](https://mises.org/books/essay_on_economic_theory_cantillon.pdf)) - A very good English - translation of *Essai sur la Nature du Commerce en Général*, one of the foundations of modern - economic theory. Written in 1730 but the translation is annotated and the essay is actually very - easy to follow also for a modern reader. Required reading if you think of implementing a sane game - economic system. +- David M. Beazley *Python Essential Reference (4th ed)* ([amazon page](https://www.amazon.com/Python-Essential-Reference-David-Beazley/dp/0672329786/)) - Our recommended book on Python; it not only efficiently summarizes the language but is also an excellent reference to the standard library for more experienced Python coders. +- Luciano Ramalho, *Fluent Python* ([O'Reilly page](https://shop.oreilly.com/product/0636920032519.do)) - This is an excellent book for experienced Python coders willing to take their code to the next level. A great read with a lot of useful info also for veteran Pythonistas. +- Richard Cantillon *An Essay on Economic Theory* ([free pdf](https://mises.org/books/essay_on_economic_theory_cantillon.pdf)) - A very good English + translation of *Essai sur la Nature du Commerce en Général*, one of the foundations of modern economic theory. Written in 1730 but the translation is annotated and the essay is actually very easy to follow also for a modern reader. Required reading if you think of implementing a sane game economic system. \ No newline at end of file diff --git a/docs/source/index.md b/docs/source/index.md index ba80dfe7be..65c89aa4ef 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -12,12 +12,12 @@ This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. Use the Search bar on the left to find or discover interesting articles. -- [Evennia Introduction](./Evennia-Introduction.md) - what is this? +- [Introduction](./Evennia-Introduction.md) - what is this Evennia thing? - [Getting help and Contribute](./Contributing.md) - when you get stuck or want to chip in ## Setup -- [Installation and running](Setup/Setup-Overview.md#installation-and-running) - getting started! +- [Setup Quickstart](Setup/Setup-Overview.md#installation-and-running) - installing Evennia and get going - [Starting, Stopping and Reloading](Setup/Start-Stop-Reload.md) - how to manage the Evennia server - [Configuration](Setup/Setup-Overview.md#configuration) - how to set up your server the way you like it - [Going public](Setup/Setup-Overview.md#going-public) - taking your game online @@ -31,16 +31,16 @@ This is the manual of [Evennia](https://www.evennia.com), the open source Python - [Core components](Components/Components-Overview.md) - the core building blocks of Evennia - [Concepts](Concepts/Concepts-Overview.md) - larger-scale concepts and features +- [Coding](Coding/Coding-Overview.md) - coding and development hints and resources - [API](./Evennia-API.md) - the full API-reference, generated from source - [Default Commands](Components/Default-Commands.md) - list of game commands included out of the box -- [Coding](Coding/Coding-Overview.md) - coding and development hints and resources ## Contributions and Info - [Contribs](Contribs/Contribs-Overview.md) - game-specific code and snippets to use for your game -- [How to contribute to these docs](./Contributing-Docs.md) - if you want to help out -- [MU- and Evennia Links](./Links.md) - useful external links for extra reading -- [BSD License](./Licensing.md) - Evennia licensing FAQ +- [Documentation - how to contribute](./Contributing-Docs.md) - if you want to help out +- [Links](./Links.md) - useful external links for extra reading +- [License](./Licensing.md) - Evennia licensing FAQ ----