From d7ad770b1c0ebdbd11f765ced4cb798e464eae8e Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 19 Nov 2022 02:11:20 +0100 Subject: [PATCH] Make Readme more succinct --- README.md | 51 ++++++++++++++++---------------------------------- pyproject.toml | 2 +- 2 files changed, 17 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 9b32773135..305edd278c 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,33 @@ -# Evennia MUD/MU\* Creation System ![evennia logo][logo] +# Evennia MUD/MU\* Creation System ![][logo] [![Build Status][unittestciimg]][unittestcilink] [![Coverage Status][coverimg]][coverlink] *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 -freedom. Evennia is made available under the very friendly [BSD -license][license]. +freedom. -http://www.evennia.com is the main hub tracking all things Evennia. +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! +## Installation -## Features and Philosophy + pip install evennia + evennia --init mygame + cd mygame + evennia migrate + evennia start / stop / reload -The Evennia library aims for you to have a fully functioning, if -empty, online game up and running in minutes. Rather than imposing a -particular style, genre or game mechanic we offer a framework on which -you build the game of your dreams. The idea is to allow you to -concentrate on designing the bits that make your game unique. +Next, browse to http://localhost:4001 or telnet to localhost port 4000 to see your working (if empty) game! -Coding in Evennia is done using normal Python modules imported into -the server at runtime. All library code is heavily documented and -Evennia comes with extensive manuals and tutorials. You use Python -classes to represent your objects, scripts, players, in-game channels -and so on. The database layer is abstracted away. This makes it -possible to create the game using modern code practices using the full -flexibility and power of Python. +- 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/) ![screenshot][screenshot] -Evennia offers extensive connectivity options, including traditional -telnet connections. Evennia is also its own web server: A default -website as well as a browser-based mud client (html5 websockets, with -fallback to AJAX) runs by default. Due to our Django and Twisted -foundations, web integration is easy since the same code powering the -game is also used to run its web presence. - -Whereas Evennia is intentionally empty of game content from the onset, -we *do* offer some defaults you can build from. The code base comes -with basic classes for objects, exits, rooms and characters. There are -systems for handling puppeting, scripting, timers, dynamic games -states etc. A default command set (completely replaceable with your -own syntax and functionality) handles administration, building, chat -channels, poses and so on. The default setup is enough to run a -'Talker' or some other social-style game out of the box. We also have -a contributions folder with optional plugins and examples of more -game-specific systems. - ## Current Status The codebase is currently in **Beta**. While development continues, diff --git a/pyproject.toml b/pyproject.toml index 231e1dca90..06b81e3337 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "evennia" -version = "1.0rc4" +version = "1.0rc5" maintainers = [ { name="Griatch", email="griatch@gmail.com" }, ]