Migrate from PennMUSH, RhostMUSH or TinyMUX
SharpMUSH directly imports a PennMUSH flatfile and, optionally, its mush.cnf, mail database
(maildb), and chat database (chatdb). The flatfile keeps every object’s dbref, so softcode can
keep referring to the same objects. The mail and chat databases bring mail aliases, messages and
channels. It also imports a RhostMUSH flatfile with its mail dumps, and a TinyMUX flatfile
with its mail.db and comsys.db, or the netmux.sqlite TinyMUX 2.14 runs from; Importing from RhostMUSH or TinyMUX
says what those imports carry over and what they leave behind. Everything else on this page applies
to all three. Where it names a PennMUSH file, use the matching file from your server.
1. Take stock of the source game
Section titled “1. Take stock of the source game”Before changing either server, write down:
- the PennMUSH version, flatfile format, database size, highest dbref and object count;
- custom flags, powers, attributes, locks, command and function restrictions, and any files
mush.cnfincludes; - channels, mail, mail aliases, player passwords, guests and login rules (mail and channels live in
the separate
maildbandchatdbfiles); - globals, master room objects, HTTP and event handlers, startup attributes and scheduled jobs;
- packages and the important softcode commands players and staff use;
- DNS, telnet and browser addresses, bots, monitoring, outgoing mail and other connected services;
- uploaded files and anything plugins or maintenance scripts use.
Make a flatfile, maildb and chatdb while the game is quiet, and record a checksum of each. Copy
them, the whole configuration folder, help and text files, and anything else the game relies on, to
storage the SharpMUSH machine cannot overwrite.
The importer takes one mush.cnf and, beside it, the files its include lines name, such as
alias.cnf and restrict.cnf. Each include line reads the uploaded file of that name, never a file
on the SharpMUSH machine, and the import report names each included file that was not uploaded. The
mail and chat files are optional, but leaving
them out means no mail aliases or channels are imported.
Check the new machine with @storage. An import needs room for the live world, the world being
imported, and the world it replaces (see Disk space). Do the first
full-size rehearsal on a throwaway, private SharpMUSH installation with the same version and storage
settings you plan to use for real.
2. Rehearse the import
Section titled “2. Rehearse the import”-
Start a clean SharpMUSH stack, keep
/setupaway from untrusted visitors, and claim the administrator account linked to#1. -
In setup, open Import a PennMUSH, RhostMUSH or TinyMUX database (later, Database import under Build & manage). Leave the format on Tell from the file unless the import picks the wrong one. Upload the flatfile together with the matching
mush.cnf,maildbandchatdb. Settings frommush.cnf(including the objects it names and its restrictions) are applied before objects are converted; mail aliases, messages, channels, members and history come from the mail and chat files. -
Read every warning about a setting that was skipped. Recreate the ones SharpMUSH supports, and write down the ones you are deliberately leaving behind.
-
Let the conversion finish. SharpMUSH builds the imported world separately, in a
<world>.staging-*folder, so a failed conversion never half-replaces the live world. -
Read the import report before accepting it. Accepting moves the old live world to
<world>.previousand puts the imported world in its place in one step. -
Go back to setup to choose the staff roles, HTTP and event handlers and bundled packages. An imported world may already have its own handlers; understand which attributes a setup choice moves or removes before you add a second one.
A rehearsal is evidence, not the real thing. Don’t open it to players, don’t accept their changes, and don’t quietly turn it into the production game. Repeat the import from a fresh flatfile when you cut over.
SharpMUSH’s developers compare its behaviour with PennMUSH’s automatically, by replaying the same scripted sessions against both and reporting every difference. Those comparisons show how compatible the engine is, but they don’t replace testing your own game’s code. The Compatibility page and the PennMUSH compatibility help topic list the known differences.
Importing from RhostMUSH or TinyMUX
Section titled “Importing from RhostMUSH or TinyMUX”The import page takes a RhostMUSH flatfile, a TinyMUX flatfile or TinyMUX 2.14’s netmux.sqlite,
with their mail, channels and configuration files. It tells the formats apart from the file’s first
lines; choose the format on the page if it guesses wrong. A start-up import reads
PENNMUSH_DATABASE_FORMAT (auto, pennmush, rhostmush or tinymux) beside
PENNMUSH_DATABASE_PATH.
Such an import rewrites the softcode that would read differently here (colour codes, @hook,
@femit, RhostMUSH’s commands, functions and totems, and attribute names SharpMUSH refuses), sets the
game’s dialect and turns on the settings its code expects. Read
Moving a RhostMUSH or TinyMUX Game before the first rehearsal: it
lists which files to upload, what comes across, every rewrite and what is left out.
Check the rewritten softcode
Section titled “Check the rewritten softcode”When the import ends, the import page lists every attribute whose softcode it rewrote under Rewritten softcode, one line each, apart from the other warnings. Each line names the object, the attribute and what changed. Click a line to see the attribute’s code before and after the rewrite. A line that says check by hand names code the rewrite could not carry over exactly, with the reason, for example colour stored in a register.

Output: four attributes are listed and the first two are open. In #9/DESCRIBE, %xbBlue text%xn
became [ansi(b,Blue text)] and %<065> became A. #10/DESCRIBE says check by hand twice, so that
attribute needs a person to read it.
Test each listed attribute on the rehearsed world, and fix the check-by-hand ones before players connect.
Keep the import log
Section titled “Keep the import log”The Download import log button at the bottom of the import page saves the whole report as a text
file named sharpmush-import-<date>-<time>.log: the counts, every error and warning, and each
rewritten attribute with its code before and after. Keep it with your cutover notes, or attach it
when you ask for help with an import.
Rewritten softcode (4)
#9/DESCRIBE: %c/%x colour written as ansi(); %<065> written as A Before: A shiny widget%r%xbBlue text%xn and %<065>. After: A shiny widget%r[ansi(b,Blue text)]%band A.Output: one rewritten attribute from the log, with its code before and after.
An import started with PENNMUSH_DATABASE_PATH writes the same file into the directory that holds
the imported database, and the server log names it. The server log also lists every rewritten
attribute, one line each, after a warning that gives the count.
3. Check the rehearsed world
Section titled “3. Check the rehearsed world”For every row, record pass or fail, the command or screen you used, and any difference you accepted.
| Area | At least check |
|---|---|
| Logins and passwords | God, a wizard, an ordinary player, a guest, aliases, a failed login, a password reset, and linking a character to a web account. Replace imported password hashes with new passwords over time. |
| Objects and dbrefs | Object counts and the highest dbref look right; known rooms, exits, things and players keep the dbrefs softcode uses. |
| Attributes and locks | Inherited, private, wizard-only, visual and large attributes; representative lock types and their failure messages. |
| Flags and powers | Custom and built-in ones exist, permissions are right, and sample objects kept theirs. |
| Channels and mail | The right maildb and chatdb were used. Check membership, aliases, history, mail folders, sending, reading, deleting and privacy with separate accounts. |
| Settings | mush.cnf settings, command and function restrictions, names, limits, login rules and named objects match your notes. |
| Handlers and packages | HTTP and event handlers, globals, master room code, startup behaviour and each package have one deliberate owner. |
| Softcode | Every attribute under Rewritten softcode, then a list of player commands, building commands, queues, loops, regular expressions, locks, stored data and error cases, most important first. |
| Connections | Log in over telnet and the portal terminal; check colour, client negotiation, disconnecting and reconnecting. |
| Web portal | Claiming, logging in, linking characters, the wiki, permissions, the terminal and the admin pages work for each role. |
| Connected services | DNS, proxy routes, bots, outgoing web requests, mail, monitoring, metrics and backups work from the private copy. |
When something differs, find out why instead of adjusting the test until it passes. Whether the data imported correctly and whether the engine behaves the same are separate questions.
4. Cut over
Section titled “4. Cut over”Agree the go/no-go checklist, and who decides on rolling back, before the maintenance window.
-
Announce the freeze, and stop logins or put PennMUSH into maintenance mode.
-
Let queued work finish, make the final flatfile with its matching
maildbandchatdb, archive the configuration and anything else the game relies on, and record checksums and counts for every file. -
Repeat the rehearsed import on the real SharpMUSH machine. Don’t reuse a rehearsal world that has been changed.
-
Run the short acceptance list: administrator and player login, known dbrefs, core softcode, sample mail and channels, telnet, the portal terminal, connected services, backup, storage, health, logs and metrics.
-
Change DNS, proxy and client addresses only after the named person signs off. Keep PennMUSH stopped but ready to start again.
-
Watch errors, queues, storage, logins, connection drops and player reports through the agreed period. Keep the import report and a log of the cutover.
5. Roll back safely
Section titled “5. Roll back safely”Decide in advance what sends the game back: logins failing, data widely wrong, important softcode not working, unsafe storage behaviour, or a connected service that can’t be fixed.
To go back to PennMUSH: stop accepting changes in SharpMUSH, point the addresses back, and start the preserved PennMUSH world from its state before the cutover. Changes players made after SharpMUSH opened do not carry back automatically; say so when you announce the rollback.
<world>.previous is something else: it is the SharpMUSH world that was replaced when the import
was accepted. It can undo a just-accepted import on the SharpMUSH side; it is not a copy of PennMUSH.
Stop the SharpMUSH stack before moving world folders, and never copy or read a live data.mdb. For
ongoing SharpMUSH recovery, restore a copy made by @backup, or a restic snapshot holding one,
following the restore steps.
Keep the source archive and <world>.previous until acceptance and the observation period are over.
Delete old data only after the decision is written down and a separate, working backup is confirmed.
Before you announce a date
Section titled “Before you announce a date”- Complete at least one full-size rehearsal on the SharpMUSH version you will use.
- Name the person who decides go/no-go and rollback.
- Prove both telnet and browser access through the real proxy setup.
- Make sure there is disk room for the live, imported and replaced worlds.
- Write down the observation period and exactly what sends the game back to PennMUSH.