Get Started

SharpMUSH can easily be installed locally, or on a remote server, thanks to Docker. It is a MUSH server with a web portal attached, so installing it gets you both a telnet game and a website for it.

To get started, pick the option that best aligns to your needs:

Try it first Our live example game runs the current build. Have a look around before installing anything.

Run with Docker (Recommended) The best option if you want to run a game. One Compose file brings up the server, the database, and the web portal.

Migrate from PennMUSH Rehearse a one-way import, validate your world, cut over with evidence, and retain a rollback path.

Develop SharpMUSH Build from source to change the server or the portal, or to contribute to the SharpMUSH project.

Once it is running

The Web Portal First-run setup, the admin panel, the wiki, and the in-browser terminal.

Visual Layouts, Themes, and Images Create a consistent visual language that adapts to terminals, the portal, personal themes, and screen readers.

Operator Handbook First claim, backups and restore drills, upgrades, monitoring, and incident entry points.

Softcode Packages Install and upgrade global softcode from a repository. Safer than pasting in .mush files, which still work.

Writing Plugins Extend the server with compiled C#, without forking it.