2022-11-19 02:11:20 +01:00
|
|
|
# Evennia MUD/MU\* Creation System ![][logo]
|
2022-12-03 19:28:05 +01:00
|
|
|
[![unittestciimg]][unittestcilink] [![Coverage Status][coverimg]][coverlink] [![Pypi Version][pypibadge]][pypilink]
|
2020-09-19 13:33:10 +02:00
|
|
|
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-12-03 09:57:42 +01:00
|
|
|
[Evennia][homepage] is a modern library for creating [online multiplayer text
|
2016-11-02 19:45:02 +01:00
|
|
|
games][wikimudpage] (MUD, MUSH, MUX, MUCK, MOO etc) in pure Python. It
|
|
|
|
|
allows game creators to design and flesh out their ideas with great
|
2022-11-19 02:11:20 +01:00
|
|
|
freedom.
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-11-19 02:11:20 +01:00
|
|
|
Evennia does not impose a particular style, genre or game mechanic. Instead it
|
2022-12-03 09:57:42 +01:00
|
|
|
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][docs]. It also has a very active community
|
|
|
|
|
with [discussion forums][group] and a [discord server][chat] to help and support you!
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-11-19 02:11:20 +01:00
|
|
|
## Installation
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-11-19 02:11:20 +01:00
|
|
|
pip install evennia
|
2022-12-03 09:57:42 +01:00
|
|
|
(windows users once: py -m evennia)
|
2025-11-14 22:08:55 +01:00
|
|
|
(note: Windows users with multiple Python versions should prefer `py -3.11` instead of `python` when creating virtual environments)
|
2022-11-19 02:11:20 +01:00
|
|
|
evennia --init mygame
|
|
|
|
|
cd mygame
|
|
|
|
|
evennia migrate
|
|
|
|
|
evennia start / stop / reload
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-12-03 09:57:42 +01:00
|
|
|
See [the full installation instructions][installation] for more help.
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-12-03 09:57:42 +01:00
|
|
|
Next, browse to `http://localhost:4001` or use your third-party mud client to
|
2023-08-07 21:18:26 +02:00
|
|
|
connect to `localhost`, port `4000` to see your working (if empty) game!
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2015-02-10 16:28:17 +01:00
|
|
|
![screenshot][screenshot]
|
2023-08-07 21:18:26 +02:00
|
|
|
_A game website is created automatically. Connect to your Evennia game from your
|
|
|
|
|
web browser as well as using traditional third-party clients_.
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-12-03 09:57:42 +01:00
|
|
|
## Where to go next
|
2015-02-10 16:31:49 +01:00
|
|
|
|
2022-12-03 09:57:42 +01:00
|
|
|
If this piqued your interest, there is a [lengthier introduction][introduction] to read. You
|
2023-08-07 21:18:26 +02:00
|
|
|
can also read our [Evennia in pictures][evenniapictures] overview. After that,
|
|
|
|
|
why not check out the [Evennia Beginner tutorial][beginnertutorial].
|
2015-02-10 16:28:17 +01:00
|
|
|
|
2016-11-02 19:45:02 +01:00
|
|
|
Welcome!
|
2014-01-23 00:38:59 +01:00
|
|
|
|
|
|
|
|
|
2022-06-12 00:55:43 +02:00
|
|
|
[homepage]: https://www.evennia.com
|
2022-06-12 01:05:00 +02:00
|
|
|
[docs]: https://www.evennia.com/docs/latest
|
2022-12-03 10:55:20 +01:00
|
|
|
[screenshot]: https://user-images.githubusercontent.com/294267/205434941-14cc4f59-7109-49f7-9d71-0ad3371b007c.jpg
|
2025-10-09 23:40:38 +01:00
|
|
|
[logo]: https://raw.githubusercontent.com/evennia/evennia/refs/heads/main/evennia/web/static/website/images/evennia_logo.png
|
2020-09-19 13:52:02 +02:00
|
|
|
[unittestciimg]: https://github.com/evennia/evennia/workflows/test-suite/badge.svg
|
|
|
|
|
[unittestcilink]: https://github.com/evennia/evennia/actions?query=workflow%3Atest-suite
|
2022-12-05 19:54:33 +01:00
|
|
|
[coverimg]: https://coveralls.io/repos/github/evennia/evennia/badge.svg?branch=main
|
|
|
|
|
[coverlink]: https://coveralls.io/github/evennia/evennia?branch=main
|
2022-12-03 12:17:28 +01:00
|
|
|
[pypibadge]: https://img.shields.io/pypi/v/evennia?color=blue
|
|
|
|
|
[pypilink]: https://pypi.org/project/evennia/
|
2022-06-12 01:05:00 +02:00
|
|
|
[introduction]: https://www.evennia.com/docs/latest/Evennia-Introduction.html
|
|
|
|
|
[license]: https://www.evennia.com/docs/latest/Licensing.html
|
|
|
|
|
[group]: https://github.com/evennia/evennia/discussions
|
2022-06-12 00:55:43 +02:00
|
|
|
[chat]: https://discord.gg/AJJpcRUhtF
|
2025-10-09 23:40:38 +01:00
|
|
|
[wikimudpage]: http://en.wikipedia.org/wiki/Multi-user_dungeon
|
2022-12-03 09:57:42 +01:00
|
|
|
[evenniapictures]: https://www.evennia.com/docs/latest/Evennia-In-Pictures.html
|
2023-08-07 21:18:26 +02:00
|
|
|
[beginnertutorial]: https://www.evennia.com/docs/latest/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html
|
2022-12-03 09:57:42 +01:00
|
|
|
[installation]: https://www.evennia.com/docs/latest/Setup/Setup-Overview.html#installation-and-running
|
