2022-11-19 02:11:20 +01:00
|
|
|
# Evennia MUD/MU\* Creation System ![][logo]
|
2020-09-19 13:33:10 +02:00
|
|
|
[![Build Status][unittestciimg]][unittestcilink] [![Coverage Status][coverimg]][coverlink]
|
|
|
|
|
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2016-11-02 19:45:02 +01:00
|
|
|
*Evennia* is a modern library for creating [online multiplayer text
|
|
|
|
|
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
|
|
|
|
|
solves the boring networking and provides a framework for you to build the game
|
|
|
|
|
you want. Coding in Evennia is done using normal Python modules imported into
|
|
|
|
|
the server at runtime. All library code is heavily documented. Evennia has
|
|
|
|
|
extensive manuals and tutorials as well as a very active support community!
|
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
|
|
|
|
|
evennia --init mygame
|
|
|
|
|
cd mygame
|
|
|
|
|
evennia migrate
|
|
|
|
|
evennia start / stop / reload
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-11-19 02:11:20 +01:00
|
|
|
Next, browse to http://localhost:4001 or telnet to localhost port 4000 to see your working (if empty) game!
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2022-11-19 02:11:20 +01:00
|
|
|
- https://www.evennia.com is the main hub tracking all things Evennia.
|
|
|
|
|
- [Here is a shortcut to the documentation and tutorials](https://www.evennia.com/docs/latest/)
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2015-02-10 16:28:17 +01:00
|
|
|
![screenshot][screenshot]
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2015-02-10 16:12:21 +01:00
|
|
|
## Current Status
|
2014-01-23 00:38:59 +01:00
|
|
|
|
2016-11-02 19:45:02 +01:00
|
|
|
The codebase is currently in **Beta**. While development continues,
|
|
|
|
|
Evennia is already stable enough to be suitable for prototyping and
|
|
|
|
|
development of your own games.
|
2015-02-10 16:31:49 +01:00
|
|
|
|
2015-02-10 16:28:17 +01:00
|
|
|
## Where to go from here
|
|
|
|
|
|
2016-11-02 19:45:02 +01:00
|
|
|
If this piqued your interest, there is a [lengthier
|
|
|
|
|
introduction][introduction] to read.
|
2015-02-10 16:28:17 +01:00
|
|
|
|
2016-11-02 19:45:02 +01:00
|
|
|
To learn how to get your hands on the code base, the [Getting
|
|
|
|
|
started][gettingstarted] page is the way to go. Otherwise you could
|
2022-06-12 00:55:43 +02:00
|
|
|
browse the [Documentation][docs] or why not come join the [Evennia
|
2016-11-02 19:45:02 +01:00
|
|
|
Community forum][group] or join us in our [development chat][chat].
|
|
|
|
|
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
|
|
|
[gettingstarted]: https://www.evennia.com/docs/latest/Getting-Started.html
|
|
|
|
|
[docs]: https://www.evennia.com/docs/latest
|
2017-09-23 15:53:05 +02:00
|
|
|
[screenshot]: https://user-images.githubusercontent.com/294267/30773728-ea45afb6-a076-11e7-8820-49be2168a6b8.png
|
2016-11-21 09:10:14 +01:00
|
|
|
[logo]: https://github.com/evennia/evennia/blob/master/evennia/web/website/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
|
2016-11-02 17:28:31 +01:00
|
|
|
[coverimg]: https://coveralls.io/repos/github/evennia/evennia/badge.svg?branch=master
|
|
|
|
|
[coverlink]: https://coveralls.io/github/evennia/evennia?branch=master
|
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
|
2015-02-10 16:31:49 +01:00
|
|
|
[wikimudpage]: http://en.wikipedia.org/wiki/MUD
|
