Documentation
Comprehensive guides, references, and tutorials for TinyMUX setup and administration.
Getting Started
Essential information to get your TinyMUX server running quickly.
- README - General information about the distribution, supported platforms, and bug reporting procedures.
- FAQ - Answers to common questions about TinyMUX setup and usage.
- 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.
- BACKUPS - Essential guide to backing up your TinyMUX database.
- MEMORY - Managing memory usage and disk-based vs. memory-based operation.
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.
Version History
See the Version History page for changelogs from every major TinyMUX release, from 2.0 through the current version.
External Documentation Resources
- TinyMUX Wiki - Community-maintained documentation, articles, and guides
- Javelin’s Guide for PennMUSH Gods - While specific to PennMUSH, contains useful information applicable to TinyMUX