Package: cwmud
An extendable, modular MUD server.Clockwork is a pure-Python MUD server designed with modularity and ease of development in mind.Current StateThis isn’t a viable MUD server yet. There’s account creation, basic character creation, rooms, talking, and walking around, but that’s about it. There are also no permission controls on admin commands yet, so anyone can do whatever they want (which is good because there is no concept of an admin yet).Thereloadcommand was broken with the recent changes to client/protocol serving (the server reloads, but any connected clients will get dumped into a limbo state of disconnected I/O), but it should be fixed in the next minor version.So anyway, very under-construction at the moment.LicenseClockwork uses the MIT license. See thelicense filefor more details.InstallationFirst, it ishighlyrecommended that you set up avirtualenvto run Clockwork in:$ cd mymud
$ virtualenv -p python3 --no-site-packages .venv
$ source .venv/bin/activateThen, Clockwork can be installed through pip:$ pip install cwmudNote: If not using virtualenv (you should!), you will need to run this command with elevated privileges (sudo).DependenciesClockwork runs onPython3.4 and is as yet untested on any later versions. There are currently no plans to support earlier versions.Clockwork requires a runningRedisserver and theredis-pybindings package for messages, andbcryptfor password hashing (and bcrypt in turn requires libffi). It also makes use ofminiboa-py3, a Python 3 port ofminiboa, which is a tiny, asynchronous Telnet server. Our modified copy of miniboa is included incwmud/libs.To install the libffi library on Debian/Ubuntu, run:$ sudo apt-get install libffi-devSee theRedis Quick Startguide for details on installing and configuring Redis.ConfigurationAll the post-installation configuration settings are stored incwmud/settings.py.Some key settings you’ll probably want to change:DEFAULT_HOST: The IP to bind the listener to, default is"localhost"(127.0.0.1), change to"0.0.0.0"to allow external connections.DEFAULT_PORT: The port to listen for new Telnet connections on, default is4000.LOG_PATH: The path for the server log, defaults to"./logs/mud.log"(rotates daily at midnight, which are also settings that can be changed).DATA_DIR: The path to a folder where local data should be loaded from and saved to (serialized objects, flat text files, etc.), defaults to"./data".These (and other) options can also be set on a per-run basis using command-line options (see below).UsageTo start the Clockwork server, simply run:$ python -m cwmudFor a full list of uses and options, see the help output by running:$ python -m cwmud --helpAfter booting, the server will be ready to accept Telnet connections on whatever address and port you specified incwmud/settings.py(default is localhost and port 4000).TestingClockwork includes a suite of unit tests inpytestformat. To run the test suite you will first need to install pytest and the plugins we use (coverage, flake8, timeout). To install all of the test suite dependencies, run:$ pip install -r tests/requirements.txtNote: If not using virtualenv (you should!), you will need to run this command with elevated privileges (sudo).After pytest is installed, you can run the test suite via our Makefile:$ make testsIf you don’t havemakeavailable (a make.bat file will be in the works for Windows users), you can call pytest directly like so:$ py.test --flake8 cwmud testsDevelopmentGit repository:https://github.com/whutch/cwmudProject planning:https://github.com/whutch/cwmud/projectsIssue tracker:https://github.com/whutch/cwmud/issuesPlease read thestyle guidefor coding conventions and style guidelines before submitting any pull requests or committing changes.Contact & SupportHomepage:(not yet)Documentation:(not hosted yet, but you can build it indocs)Wiki:https://github.com/whutch/cwmud/wikiYou can email me questions and comments atwill@whutch.com. You can also find me as Kazan on theMud Coders Slack group(you can find the sign-up page on theMud Coders Guild blog).