Getting Started
Essential information to get your TinyMUX server running quickly.
-
README
General information about the distribution, supported platforms, and bug reporting procedures.
-
Frequently Asked Questions
Answers to common questions about TinyMUX setup and usage.
-
CHANGES
List of new features, commands, and bug fixes in the current version.
-
NOTES
Helpful tips and miscellaneous information for TinyMUX administration.
Installation & Setup
Step-by-step guides for installing TinyMUX on various platforms.
-
INSTALL
Detailed installation instructions for Unix-based systems.
-
Windows Installation
Installation guide for Windows platforms.
-
SGP Minimal DB
Information about the included Sandbox Globals Project minimal database.
Configuration
Customizing your TinyMUX server to suit your needs.
-
CONFIGURATION
Comprehensive guide to server configuration options.
-
GUESTS
Setting up and managing guest characters on your server.
-
LIMITS
Information about system limits and constraints.
Administration
Tools and techniques for ongoing server maintenance.
Advanced Features
Specialized functionality for enhanced game experiences.
-
REALMS
World of Darkness style realms implementation.
-
REALITY
Reality levels configuration example.
-
REALITY.SETUP
Detailed setup guide for reality levels functionality.
-
LOCAL
Notes on extending MUX via local.cpp extensions.
Conversion & Migration
Migrating from other server platforms or older TinyMUX versions.
-
CONVERSION
Converting databases from other server formats.
Security
Protecting your server from threats and vulnerabilities.
-
ATTACK
Information about potential attacks and defensive procedures.
Reference
Additional reference materials.
-
CREDITS
Acknowledgment of contributors to the TinyMUX project.
-
DISTRIBUTIONS
Information about TinyMUX distribution channels.
-
PATCHES
Guide to applying patches to the server.
External Documentation Resources
Additional resources available online:
- TinyMUX Wiki - Community-maintained documentation, articles, and guides
- Javelin's Guide for PennMUSH Gods - While specific to PennMUSH, contains useful information applicable to TinyMUX
- Omega Flatfile Converter - Tool for converting between different database formats