A utility for Transformice that allows a player to experience historic occasions such as events.

To experience an exhibit of the museum, you must use tfm-proxy-loader to load Transformice, and also have caseus installed. Then you can simply run the python -m museum command according to the following usage:

usage: museum [-h] [--data-dir DATA_DIR] [--log]

options:
  -h, --help           show this help message and exit
  --data-dir DATA_DIR  The directory for the exhibit data (defaulted to 'data')
  --log                Log packets from the client and server

This will run a server implementation running on localhost:11801 that you can connect to using the proxy loader. To enter the museum, simply get to the login page, enter a username, and press the "Submit" button; passwords are ignored. If your username is not already taken, then you will be welcomed into the museum. The rooms you enter correspond to the exhibits you can visit. For instance, going to the "armageddon" room will bring you to the "Armageddon" exhibit. If you go to a room with no corresponding exhibit, you will be brought to the lobby, which is not a very exciting place.

Please note that this server is NOT intended for a general audience. It implicitly trusts clients, and does not attempt much of any error handling, nor does it care that much about performance. Using this server for a general audience is a decidedly bad idea. Do not do it.

The currently available exhibits are:

• Armageddon
• Astrological
• Dance
• Dino
• Dragon
• INCOMPLETE Epiphany
• INCOMPLETE Fishing_Beach
• INCOMPLETE Fishing_Boat
• INCOMPLETE Fishing_Jungle
• INCOMPLETE Fishing_Shipwreck
• Geography
• Greenhouse
• Greenhouse_Shop
• Headmaster_Office
• Ninja
• Rain
• Running_Track
• INCOMPLETE Wizard

Contained within the 'tools' directory are related but ancillary tools. These tools include:

• make-archive.py
  • This script will download Transformice.swf, TransformiceChargeur.swf, and the assets which are used by certain maps outside of the normal game assets, and will package them neatly in a folder along with the maps in question. This is important because as things are now, the museum will still cause the game to download certain assets from Transformice's servers, which is unideal for archival purposes. Keeping an archive however allows us to preserve the assets and create facilities to use the archived assets in case they ever become otherwise unavailable.