Lua-MUD

A MUD framework written in lua

What is this?

This is a framework written in lua, designed to be the server-side of a MUD (Multi User Dungeon). MUD's were most popular in the 90's, when compter graphics were, for the most part, limited to text on a console. Most muds are a combination of a text adventure and a TCP chat server.

What dependencies does this have?

NOTE: SQL support is currently deprecated in favour of flat file storage. The db api may be rewritten to use SQL libraries again in the future

• LuaSQL with an appropriate driver installed
  • e.g. for SQLite3 run luarocks install luasql-sqlite3
• luasocket
• xml2lua

How do I use this?

1. Download or clone the source
2. Make sure that lua is installed and in your path
3. Setup your world files

• Rename data/1.lua.example to data/1.lua for a 1-room world example OR
• Load in the data/ directory from an existing world

4. Run 'lua setup.lua' to set up the configuration for the server
5. Run 'lua main.lua' to start the server
6. Log in to the server using the admin username and password you set up in step 4

• Any characters created with this account will have full command access

Building guide Coming Soon