Documentation on StompyMUX Documentation

Introduction

Mon, 01 Jan 0001 00:00:00 +0000

StompyMUX is a framework for creating multi-user text-based games about Big Stompy Robots. It comes with a real-time combat system, a unit repair system, economic building blocks, and much more.

Status

StompyMUX is an occasionally developed modernization fork of BattletechMUX.

License

StompyMUX inherits an Artistic License, included in LICENSE.md in the source distribution.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Clone the sources

If you don’t already have a copy of the sources, clone the repo:

git clone git@github.com:gtaylor/stompymux.git

Make sure to cd into the repo root and fetch the third party libraries that we’ve vendored:

cd stompymux
git submodule update --init --recursive

Install dependencies

Before compiling the sources and running your own game, you’ll need to ensure that the following dependencies are present:

CMake 4.3 or higher
Clang 20 or higher
Just 1.56 or higher

Include What You Use

The optional just iwyu check requires an IWYU release built against the same Clang major version as the project. For Clang 20, install libclang-20-dev, then build and install IWYU 0.24 (the clang_20 branch) from the upstream repository. Make the executable available as include-what-you-use-20, or set IWYU to its path when running the check:

History

Mon, 01 Jan 0001 00:00:00 +0000

This codebase is the result of over 30 years of development in one form or another. It started hosted on a TinyMUSE server, around 1992 or 1993. Its primary instance powered the most popular Battletech MU* to date, 3056 MUSE.

There after, the code was ported to/reimplemented for TinyMUSH by the Animudiacs crew, who ran, amongst other servers, 3034-II (which later evolved into 3035) and Varxsis (a non-battletech universe with similar theme and technology). Somewhat simultaneously, Markus Stenberg (aka Fingon) ported the original MUSE code to TinyMUX, implementing a lot of ideas from the Animudiacs sites and implementing a lot more from scratch, both official Battletech rules and brand new ideas. The main MUX site has always been 3030 MUX.