Sphinx assumes that WORD.py should be a link to https://WORD.py . This is not a problem in most of the documentation, since Sphinx won't turn those python filenames into links when they are wrapped in backticks, like `WORD.py`. Unfortunately, not always that was being done, and so there were several wrong, broken links in the documentation. This patch wraps all the occurrences I've found of this case with backticks, not only making the documentation more readible and homogeneous, but more importantly getting rid of those unwanted links in the generated HTML version of the documentation. |
||
|---|---|---|
| .github | ||
| bin | ||
| docs | ||
| evennia | ||
| .flake8 | ||
| .gitignore | ||
| .release.sh | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CODING_STYLE.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| INSTALL.md | ||
| LICENSE.txt | ||
| Makefile | ||
| pyproject.toml | ||
| README.md | ||
| SECURITY.md | ||
| setup.py | ||
Evennia MUD/MU* Creation System 
Evennia is a modern library for creating online multiplayer text games (MUD, MUSH, MUX, MUCK, MOO etc) in pure Python. It allows game creators to design and flesh out their ideas with great freedom.
Evennia does not impose a particular style, genre or game mechanic. Instead it solves the boring networking and basic stuff all online games need. It provides a framework and tools for you to build the game you want. Coding in Evennia is done using normal Python modules imported into the server at runtime.
Evennia has extensive documentation. It also has a very active community with discussion forums and a discord server to help and support you!
Installation
pip install evennia
(windows users once: py -m evennia)
evennia --init mygame
cd mygame
evennia migrate
evennia start / stop / reload
See the full installation instructions for more help.
Next, browse to http://localhost:4001 or use your third-party mud client to
connect to localhost, port 4000 to see your working (if empty) game!
A game website is created automatically. Connect to your Evennia game from your
web browser as well as using traditional third-party clients.
Where to go next
If this piqued your interest, there is a lengthier introduction to read. You can also read our Evennia in pictures overview. After that, why not check out the Evennia Beginner tutorial.
Welcome!