File	Date	Author	Commit
etc	2023-04-20	Lee Harr	[e93366] configurable cls lines
src	2023-04-26	Lee Harr	[a6d4ce] best guess fixes
var	2021-04-16	Lee Harr	[4ac335] show players and mobs
.hgignore	2023-02-12	Lee Harr	[37b176] ignore virtualenv
.hgtags	2020-10-23	Lee Harr	[3a6015] Added tag tzmud-0.10 for changeset 7e94d815d10d
.tar-ignore	2008-08-25	missive@hotmail.com	[7b174c] update README to talk about included world data...
COPYING	2008-08-17	missive@hotmail.com	[313daf] initial import
MOTD	2020-08-27	Lee Harr	[ae5a3e] remove references to bb
README	2023-02-12	Lee Harr	[e228c5] Change tested versions
TODO	2023-04-26	Lee Harr	[898dde] update todo
announce	2020-10-20	Lee Harr	[c0e657] update to python3
tzcontrol.py	2021-04-16	Lee Harr	[bacf85] allow not opening traditional mud server port
tzmud.tac	2021-04-16	Lee Harr	[bacf85] allow not opening traditional mud server port

Read Me

TZMud is a Python MUD server.

Check for the latest updates at:
    https://sourceforge.net/projects/tzmud/


INSTALLING

First install the requirements:
    Python3 (http://www.python.org/)
        [tested with Python-3.9.2]
    Twisted (http://twistedmatrix.com/)
        [tested with Twisted-22.10.0]
    ZODB (http://pypi.python.org/pypi/ZODB/)
        [tested with ZODB-5.8.0]

    If you want to run the (optional) web server, you will also need:
        Flask (https://flask.palletsprojects.com/en/2.2.x/)
            [tested with Flask-2.2.2]
        Flask-login (https://flask-login.readthedocs.io/en/latest/)
            [tested with Flask_Login-0.6.2]
        Flask-wtf (https://flask-wtf.readthedocs.io/en/1.0.x/)
            [tested with Flask_WTF-1.1.1]
        WTForms (https://wtforms.readthedocs.io/en/3.0.x/)
            [tested with WTForms-3.0.1]
        Autobahn (https://autobahn.readthedocs.io/en/latest/)
            [tested with autobahn-23.1.2]

Unpack the TZMud distribution and run the
TZMud control program tzcontrol.py with:
    python tzcontrol.py -s

That command will generate an empty configuration
file at etc/conf.py where you can add changes to
the settings from etc/defaults.py


RUNNING

If you want to start with a minimal world, then
the first time you run the server, run the TZMud
control program as:
    python tzcontrol.py -f

That command will generate a "fresh" database with
a couple of simple rooms. The first character you
create will be an administrator.

If you would like to use the more built up world
that is included with the distribution, then run
the TZMud control program as:
    python tzcontrol.py -z

That command will restore the database 0.Data.fs
from the var/db/backup directory. All players
have been removed from the database, so you will
still be able to create the first admin character.


CONNECTING

Use a MUD client (or telnet if you want to play the
old-school way). The default port is 4444. If you
are running the server on your own computer, try
connecting to localhost:4444 or 127.0.0.1:4444

Once connected, create a character with
    create <make up a name> <make up a password>
(Do not include the angle brackets <>)

The first character created will be an administrator.


DEVELOPING

TZMud is Free Software, released under the GPL.

If you make any changes or improvements, please
consider sharing your changes with the project.

For instructions on checking out the latest code see:
    https://sourceforge.net/projects/tzmud/