MudCore is a simple MUD server. Game logic is implemented in lua, telnet handling is done for you, and the server can communicate with the outside world by way of ZeroMQ sockets.
NOTE: MudCore is not under active development. I consider it feature-complete, but never built a game atop it.
The easiest way to build MudCore is with
Nix. If you have Nix installed, run
nix build; the binary will appear at
./result/bin/mudcore. You can then
run it from the project root; this will start a server using the
If you want to install MudCore into your environment, run
nix-env -f . -i.
Beyond fundamental build tools (like you'd get with debian's
build-essential), you will need:
If you are building from git, you will also need:
If you want to build documentation, you will also need:
If you are building from git, first run
Building from source is the usual
./configure && make && sudo make install dance. The server runs just fine without being installed by
make install, if you don't want to install it.
The full documentation for MudCore is maintained as a Texinfo
manual. It is built as part of a normal run of
make, and if you do
not install it, you can read it after building by loading
doc/mudcore.info into your info reader.
If you want documentation in other formats, try running
make pdf or
make html. Similarly,
make install-pdf or
make install-html will
If you are developing a game, you should not need to modify the C
code. If you want to hack on MudCore itself, you can either install
dependencies by hand, or if you use Nix,
nix-shell will give you a
shell with dependencies available.
To build a tarball for a release, run
make distcheck. This requires
a LaTeX distribution. If you do not have one, you can run
nix-shell --arg withTools true, and the shell will have one available.