# Evennia MUD/MU\* Creation System ![][logo]
[![unittestciimg]][unittestcilink] [![Coverage Status][coverimg]][coverlink] [![Pypi Version][pypibadge]][pypilink]
[Evennia][homepage] 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
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][docs]. It also has a very active community
with [discussion forums][group] and a [discord server][chat] 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][installation] 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!
![screenshot][screenshot]
_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][introduction] to read. You
can also read our [Evennia in pictures][evenniapictures] overview. After that,
why not check out the [Evennia Beginner tutorial][beginnertutorial].
Welcome!
[homepage]: https://www.evennia.com
[docs]: https://www.evennia.com/docs/latest
[screenshot]: https://user-images.githubusercontent.com/294267/205434941-14cc4f59-7109-49f7-9d71-0ad3371b007c.jpg
[logo]: https://github.com/evennia/evennia/blob/master/evennia/web/website/static/website/images/evennia_logo.png
[unittestciimg]: https://github.com/evennia/evennia/workflows/test-suite/badge.svg
[unittestcilink]: https://github.com/evennia/evennia/actions?query=workflow%3Atest-suite
[coverimg]: https://coveralls.io/repos/github/evennia/evennia/badge.svg?branch=main
[coverlink]: https://coveralls.io/github/evennia/evennia?branch=main
[pypibadge]: https://img.shields.io/pypi/v/evennia?color=blue
[pypilink]: https://pypi.org/project/evennia/
[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
[chat]: https://discord.gg/AJJpcRUhtF
[wikimudpage]: http://en.wikipedia.org/wiki/MUD
[evenniapictures]: https://www.evennia.com/docs/latest/Evennia-In-Pictures.html
[beginnertutorial]: https://www.evennia.com/docs/latest/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html
[installation]: https://www.evennia.com/docs/latest/Setup/Setup-Overview.html#installation-and-running
Raw data
{
"_id": null,
"home_page": null,
"name": "evennia",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Griatch <griatch@gmail.com>",
"keywords": "MUD, MUSH, MUX, MMO, text-only, multiplayer, online, rpg, game, engine, framework, text, adventure, telnet, websocket, blind, accessible, ascii, utf-8, terminal, online, server, beginner, tutorials",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/02/8e/9282e73309662d62b4e4a57597cc034c126a9e5c3da647e782a1a66e2c93/evennia-4.1.1.tar.gz",
"platform": null,
"description": "# Evennia MUD/MU\\* Creation System ![][logo]\n[![unittestciimg]][unittestcilink] [![Coverage Status][coverimg]][coverlink] [![Pypi Version][pypibadge]][pypilink]\n\n\n[Evennia][homepage] is a modern library for creating [online multiplayer text\ngames][wikimudpage] (MUD, MUSH, MUX, MUCK, MOO etc) in pure Python. It\nallows game creators to design and flesh out their ideas with great\nfreedom.\n\nEvennia does not impose a particular style, genre or game mechanic. Instead it\nsolves the boring networking and basic stuff all online games need. It provides\na framework and tools for you to build the game you want. Coding in Evennia is\ndone using normal Python modules imported into the server at runtime.\n\nEvennia has [extensive documentation][docs]. It also has a very active community\nwith [discussion forums][group] and a [discord server][chat] to help and support you!\n\n## Installation\n\n pip install evennia\n (windows users once: py -m evennia)\n evennia --init mygame\n cd mygame\n evennia migrate\n evennia start / stop / reload\n\nSee [the full installation instructions][installation] for more help.\n\nNext, browse to `http://localhost:4001` or use your third-party mud client to\nconnect to `localhost`, port `4000` to see your working (if empty) game!\n\n![screenshot][screenshot]\n_A game website is created automatically. Connect to your Evennia game from your\nweb browser as well as using traditional third-party clients_.\n\n## Where to go next\n\nIf this piqued your interest, there is a [lengthier introduction][introduction] to read. You\ncan also read our [Evennia in pictures][evenniapictures] overview. After that,\nwhy not check out the [Evennia Beginner tutorial][beginnertutorial].\n\nWelcome!\n\n\n[homepage]: https://www.evennia.com\n[docs]: https://www.evennia.com/docs/latest\n[screenshot]: https://user-images.githubusercontent.com/294267/205434941-14cc4f59-7109-49f7-9d71-0ad3371b007c.jpg\n[logo]: https://github.com/evennia/evennia/blob/master/evennia/web/website/static/website/images/evennia_logo.png\n[unittestciimg]: https://github.com/evennia/evennia/workflows/test-suite/badge.svg\n[unittestcilink]: https://github.com/evennia/evennia/actions?query=workflow%3Atest-suite\n[coverimg]: https://coveralls.io/repos/github/evennia/evennia/badge.svg?branch=main\n[coverlink]: https://coveralls.io/github/evennia/evennia?branch=main\n[pypibadge]: https://img.shields.io/pypi/v/evennia?color=blue\n[pypilink]: https://pypi.org/project/evennia/\n[introduction]: https://www.evennia.com/docs/latest/Evennia-Introduction.html\n[license]: https://www.evennia.com/docs/latest/Licensing.html\n[group]: https://github.com/evennia/evennia/discussions\n[chat]: https://discord.gg/AJJpcRUhtF\n[wikimudpage]: http://en.wikipedia.org/wiki/MUD\n[evenniapictures]: https://www.evennia.com/docs/latest/Evennia-In-Pictures.html\n[beginnertutorial]: https://www.evennia.com/docs/latest/Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html\n[installation]: https://www.evennia.com/docs/latest/Setup/Setup-Overview.html#installation-and-running\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "A full-featured toolkit and server for text-based multiplayer games (MUDs, MU*, etc).",
"version": "4.1.1",
"project_urls": {
"Dev Blog": "https://www.evennia.com/devblog/index.html",
"Discord": "https://discord.gg/AJJpcRUhtF",
"Documentation": "https://www.evennia.com/docs/latest/index.html",
"Forums": "https://github.com/evennia/evennia/discussions",
"Game Index": "http://games.evennia.com",
"Github": "https://github.com/evennia/evennia",
"Homepage": "https://www.evennia.com",
"Issue tracker": "https://github.com/evennia/evennia/issues",
"Live Demo": "https://demo.evennia.com/",
"Patreon": "https://www.patreon.com/griatch"
},
"split_keywords": [
"mud",
" mush",
" mux",
" mmo",
" text-only",
" multiplayer",
" online",
" rpg",
" game",
" engine",
" framework",
" text",
" adventure",
" telnet",
" websocket",
" blind",
" accessible",
" ascii",
" utf-8",
" terminal",
" online",
" server",
" beginner",
" tutorials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef08bd2e9b20ad69f2b2fed401f8f3d2e5e5434b19068fa3ce339a254471f753",
"md5": "83d9a9c6fab4088c445130d837a851f3",
"sha256": "2b30c498cdc8cd3a0f3fc887c4807198232d0ed79f343db85323f1b883cc5976"
},
"downloads": -1,
"filename": "evennia-4.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83d9a9c6fab4088c445130d837a851f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 2438328,
"upload_time": "2024-04-06T21:07:54",
"upload_time_iso_8601": "2024-04-06T21:07:54.943559Z",
"url": "https://files.pythonhosted.org/packages/ef/08/bd2e9b20ad69f2b2fed401f8f3d2e5e5434b19068fa3ce339a254471f753/evennia-4.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "028e9282e73309662d62b4e4a57597cc034c126a9e5c3da647e782a1a66e2c93",
"md5": "07377de7f616f701d93f8389cbeda7bb",
"sha256": "4f43e9a33ae63f03c83ff375c553cef1ab49ea9a75e1bc5bacd38630b72d9977"
},
"downloads": -1,
"filename": "evennia-4.1.1.tar.gz",
"has_sig": false,
"md5_digest": "07377de7f616f701d93f8389cbeda7bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 2084290,
"upload_time": "2024-04-06T21:07:58",
"upload_time_iso_8601": "2024-04-06T21:07:58.205038Z",
"url": "https://files.pythonhosted.org/packages/02/8e/9282e73309662d62b4e4a57597cc034c126a9e5c3da647e782a1a66e2c93/evennia-4.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 21:07:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "evennia",
"github_project": "evennia",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "evennia"
}
JSON
