From 0ccef6108ac832cb86f3f8fb6c2b8dc2c5836df9 Mon Sep 17 00:00:00 2001 From: Griatch Date: Mon, 18 May 2015 12:31:35 +0200 Subject: [PATCH] Update README.md Some cleanup of the text. --- README.md | 48 ++++++++---------------------------------------- 1 file changed, 8 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 30224929c2..0236ef1074 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![Build Status][travisimg]][travislink] *Evennia* is a modern library for creating [online multiplayer text -games][wikimudpage] (MUD, MUSH, MUX, MOO etc) in pure Python. It allows game -creators to design and flesh out their games with great freedom. +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]. http://www.evennia.com is the main hub tracking all things Evennia. @@ -11,57 +11,25 @@ http://www.evennia.com is the main hub tracking all things Evennia. ## Features and Philosophy -Evennia aims to supply a bare-bones MU\* codebase that allows vast -flexibility for game designers while taking care of all the gritty -networking and database-handling behind the scenes. Evennia offers an -easy API for handling persistent objects, time-dependent scripting and -all the other low-level features needed to create an online text-based -game. The idea is to allow the mud-coder to concentrate solely on -designing the parts and systems of the mud that makes it uniquely fit -their ideas. +The Evennia library aims for you to have a fully functioning, if empty, online game up and running in minutes. Rather than impose a particular style or genre of game we offer a framework on which you build the game of your dreams. There are easy ways to handl persistent objects, time-dependent scripting and all the other low-level features needed to create an online text-based game. The idea is to allow the mud-coder to concentrate on designing the bits that make their game unique. -Coding in Evennia is primarily done by normal Python modules, making -the codebase extremely flexible. The code is heavily documented and -you use Python classes to represent your objects, scripts and players. -The database layer is abstracted away. +Coding in Evennia is done by normal Python modules imported into the server at runtime. All code is heavily documented and you use Python classes to represent your objects, scripts and players. 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. ![screenshot][screenshot] -Evennia offers extensive connectivity options. A single server -instance may offer connections over Telnet, SSH, SSL and HTTP. The -latter is possible since Evennia is also its own web server: A default -website as well as a browser-based comet-style mud client comes as -part of the package. +Evennia offers extensive connectivity options. A single server instance may offer connections over Telnet, SSH and SSL. Evennia is also its own web server: A default website as well as a browser-based mud client (html5 websockets, with fallback to AJAX) is available from the the first start. Due to our Django and Twisted foundations, web integration is easy since the same code that powers the game is also used to run its web presence. -Due to our Django and Twisted foundations, web integration is -easy since the same code that powers the game may also be used to run -its web presence. - -Whereas Evennia is intended to be customized to almost any level you -like, we do offer some defaults you can build from. The code base -comes with basic classes for objects, exits, rooms and characters. -There is also a default command set for handling administration, -building, chat channels, poses and so on. This is enough to run a -'Talker' or some other social-style game out of the box. Stock Evennia -is however deliberately void of any game-world-specific systems. So -you won't find any AI codes, mobs, skill systems, races or combat -stats in the default distribution (we might expand our contributions -folder with optional plugins in the future though). +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 is also a default command set for handling administration, building, chat channels, poses and so on. This is enough to run a 'Talker' or some other social-style game out of the box. You won't find any AI codes, mobs, skill systems, races or combat stats in the core library (we will gradually offer more optional plugins in the future though). ## Current Status -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. +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. ## Where to go from here If this piqued your interest, there is a [lengthier introduction][introduction] to read. -To learn how to get your hands on the code base, the [Getting started][gettingstarted] page -is the way to go. Otherwise you could browse -the [Documentation][wiki] or why not come join the [Evennia Community forum][group] -or join us in our [development chat][chat]. Welcome! +To learn how to get your hands on the code base, the [Getting started][gettingstarted] page is the way to go. Otherwise you could browse the [Documentation][wiki] or why not come join the [Evennia Community forum][group] or join us in our [development chat][chat]. Welcome! [homepage]: http://www.evennia.com