TeensyMUD Server

v3.0.0

Introduction

TeensyMUD is a very simple mud server written in Ruby. It uses a multiplexed single-threaded network driver using Acceptor/Reactor and Observer patterns and YAML formatted text files as a database. It is also a pure event driven system where all game objects communicate with each other via events.

This server was initially created in response to an Aprils Fool’s joke posted by Erwin Andreasen on TheMudConnector forum announcing a 1K mud contest. Those obfuscated versions can be found in the repository.

Download

The latest release can be found at teensymud.kicks-ass.org

System Dependencies

Required

Ruby 1.9.x

Can be obtained at the home of Ruby, www.ruby-lang.org. It runs on most platforms.

Log4r

All logging done through this now. Install from Ruby Gems, or log4r.sourceforge.net/

Optional

RubyGems

To install rake and various things. See - rubyforge.org/projects/rubygems

Rake

To build documentation, run tests, etc. See - rake.rubyforge.org

Racc

To rebuild FARTS or BoolExp parser. Ruby comes with Racc runtime so this is not needed for execution. See - i.loveruby.net/en/prog/racc.html

FlexMock

To run regression tests. See - onestepback.org/software/flexmock/

Curses

To run tclient in curses mode under windows. The Windows one-click installer may be missing the pdcurses.dll, or if you built it yourself from source the curses.so extension probably wasn’t built. You can get binaries for it at www.dave.burt.id.au/ruby/curses.zip. The pdcurses.dll should be placed in your rubybin directory and not your windows directories. See jarp.does.notwork.org/win32/ for the sources.

Features

Installation

  1. $ tar xzvf tmud*

  2. $ cd tmud*

  3. $ ruby tmud.rb

That’s it. It will boot on port 4000 and build an initial database in the db directory.

See config.yaml file for more configuration information. Documentation inside.

Starting the mud

Usage: ruby ./tmud.rb [options]

-p, --port PORT                  Select the port the mud will run on
                                   (default is 4000)
-d, --dbfile DBFILE              Select the name of the database file
                                   (default is 'db/testworld.yaml')
-c, --config CONFIGFILE          Select the name of the configuration file
                                   (default is 'config.yaml')
-l, --logfile LOGFILE            Select the name of the log file
                                   (default is 'logs/server.log')
-h, --home LOCATIONID            Select the object id where new characters will start
                                   (default is 1) 
-t, --[no-]trace                 Trace execution
-v, --[no-]verbose               Run verbosely
    --help                       Show this message
    --version                    Show version

Options specified on the command line will override those in the config.yaml file.

There is a sample database, db/testworld.yaml that illustrates the use of triggers. The admin account is ‘Wizard’ and the password is ‘potrzebie’.

To start using the sample database either specify it in the config file or on the command line:

There are two converted databases from the original tinymud and dikumud. The admin account on both is ‘Wizard’ and the password is ‘potrzebie’. To run with those use:

The TinyMud scripts are only partially operable, which may severely restrict your movement.

See db/license.tiny and db/license.diku for more informtion.

Operation

Help

Contributors

TeensyMUD contributers list

Copyright© 2005 the contributors. All rights reserved.

See LICENSE file for terms and conditions.

Contributors

License

TeensyMUD Public License

Copyright© 2005 the contributors. All rights reserved.

See CONTRIBUTORS file for list of the contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files, the rights to use, copy, modify, create derivative works, merge, publish, distribute, sublicense, and/or sell copies of this software, and to permit persons to whom the software is furnished to do so, subject to the following conditions:

1) Redistribution in source code must retain the copyright information and attributions in the original source code, the above copyright notice, this list of conditions, the CONTRIBUTORS file and the following disclaimer.

2) Redistribution in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.

3) The rights granted to you under this license automatically terminate should you attempt to assert any patent claims against the licensor or contributors, which in any way restrict the ability of any party to use this software or portions thereof in any form under the terms of this license.

Disclaimer: THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.