It takes its basis and functionality heavily from PennMUSH and its brethren with the intent of a compatibility layer.
SharpMUSH is a modern iteration of the time-tested MUSH frameworks. It provides a layer of compatibility for PennMUSH for transferability, and builds a modern tech landscape around it that does away with many of the limitations that have made MUSHes harder to use, without losing what makes them great.
You can find our documentation here: SharpMUSH Documentation. This features such elements as our Compatibility, Installation, and API documentation, and how to download SharpMUSH and get up and running!
Currently, there is no Release Candidate for SharpMUSH. We are still in the early stages of development, and are working on getting a stable release out.
SharpMUSH is available as Docker images on DockerHub:
sharpmush/sharpmush-server- Main serversharpmush/sharpmush-connectionserver- Connection server
For information on setting up automatic DockerHub publishing when new versions are released, see DockerHub Setup Guide.
- Install .Net 10
- Install Docker Desktop
Build with:
dotnet buildRun the tests with:
dotnet testNote: Test telemetry output is disabled by default to reduce console noise. To enable telemetry metrics during test runs, set the environment variable:
export SHARPMUSH_ENABLE_TEST_TELEMETRY=true dotnet test
The main entrypoint to set as a Startup Project is SharpMUSH.Server.
For full integration, you will also need to run SharpMUSH.ConnectionServer, which handles client connections.
Additionally, a Blazor web client is available at SharpMUSH.Client.