Api | Transformice

Transformice provides a few different ways to interact with its systems, primarily through its internal

for creating in-game content and unofficial external libraries for bot creation. 1. The In-Game Lua API

This is the official way to create custom game modes (Modules) or scripts for tribe houses. It uses a sandboxed version of Lua. Capabilities

: You can manipulate map physics, listen to player events (joining, chatting, dying), and spawn objects or projectiles. in your tribe house or use the Lua script editor provided by Atelier 801 Key Events eventNewGame() : Triggered when a new map loads. eventPlayerChat(name, message) : Monitors chat for specific commands. eventSummoningEnd(playerName, itemType, x, y) : Runs when a shaman finishes a summon. Official Documentation : The most up-to-date reference is usually the Module FAQ & Documentation on the official forums or the in-game 2. External Bot Development (Transfromage)

If you are looking to build an external tool (like a Discord bot that tracks player stats or a standalone client), the community-standard library is Transfromage

: It handles the low-level socket communication (packet encryption/decryption) required to talk to the Transformice servers. Maintenance : You can find various forks and updates on GitHub, such as Blank3495's Transfromage

, which often includes "autoupdate" features to keep up with game patches. 3. Requirements & Constraints

To run custom scripts successfully, you must meet certain in-game criteria: : Most custom Lua scripts must be executed in a Tribe House Permissions : You need the appropriate rank in your tribe to use the (Next Map) or Qualifications : Players generally need to have collected at least 100 cheese

and have a clean record (no active hack bans) to use these features. Draft Implementation Example (Lua) This simple script greets any player who joins the room: eventNewPlayer(playerName) tfm.exec.chatMessage( "Welcome to the room, " .. playerName .. , playerName) Use code with caution. Copied to clipboard or a guide on setting up a Python-based bot Lua | Transformice Wiki | Fandom

Technical Overview: The Transformice API Ecosystem In the context of the multiplayer platformer Transformice

, the term "API" refers to two primary systems: the Module API (built on Lua) used for in-game content creation, and external Stats/Bot APIs used for community-driven websites and automation. 1. The In-Game Module API (Lua)

The Module API allows players to write scripts that run within tribe houses or official "module" rooms. It is the foundation for almost all community-created minigames like #prophunt or #pictionary.

Execution Environment: Scripts are executed via the /lua command. Access is restricted to players with specific tribe permissions or members of the official Module Team. Core Packages:

tfm.get: Retrieves room data, including player lists and XML map info.

tfm.exec: Executes game actions like spawning objects, moving mice, or changing scores. system: Manages file loading and basic script metadata.

ui: Allows developers to create custom buttons, text areas, and popup windows.

Event-Driven Architecture: Scripts respond to real-time triggers, such as:

eventChatCommand: Triggers when a player types a command starting with "!". transformice api

eventLoop: Occurs every 500 milliseconds, serving as the script's "heartbeat".

eventKeyboard: Captures player key presses for custom movement or mechanics. 2. External Statistics and Bot APIs

Beyond in-game scripting, external APIs allow for deep interaction with game data and player profiles.

Official Stats API: Atelier 801 provides access to a table schema that includes player IDs, shaman experience, titles, and specific game mode data (Racing, Survivor, etc.).

Transfromage API: A third-party project using the Luvit runtime to enable bot connections to the game servers. It requires specific encryption keys and a token to function.

Community Platforms: Sites like Formice utilize these data feeds to provide real-time leaderboards and historical player rankings. 3. Developer Tools and Optimization

The community has developed several tools to handle the limitations of the Lua environment, which does not natively support complex file structures. Lua | Transformice Wiki | Fandom

As of April 2026, there is no single "official" academic paper for the Transformice API; however, comprehensive technical documentation and community-driven guides serve as the primary "informative papers" for the platform's two main API branches: the Module API (Lua) and the External Client/Bot APIs. 1. The Module API (Lua)

The most common way to interact with the game's internal systems is through the Module API. This allows users to create minigames and scripts directly within the game client.

Primary Documentation: The Lua Documentation on the Atelier 801 Forum is the definitive resource. It covers:

Events: Triggers like eventNewPlayer, eventChatCommand, and eventLoop .

Functions: System commands to move players, spawn objects (shaman items), or change map properties .

UI Controls: Documentation for creating custom buttons, text areas, and popup windows .

Technical Basics: It uses the Lua scripting language, which is lightweight and fast, making it ideal for the game's Adobe AIR/Flash-based engine . 2. External APIs (Bots and Data)

For developers looking to create external tools, Discord bots, or leaderboard trackers, several community-driven APIs exist.

Transfromage: An asynchronous Lua runtime (using Luvit) that allows developers to create standalone bots that connect to the game servers .

Transformice-Records: A GitHub repository containing scripts used to track player statistics and map data . Transformice provides a few different ways to interact

Unofficial Wiki: The Transformice Wiki's Lua section acts as a living "informative paper," cataloging version updates (like 0.19) and community-discovered tricks . 3. Key Concepts for Developers

If you are writing a technical overview, these are the essential pillars:

The Sandbox: Modules run in a restricted environment to prevent abuse. Certain "admin" functions (underlined in docs) are restricted to the official Module Team .

The Loop: The eventLoop is the heart of any Transformice script, occurring every 500 milliseconds .

Tribal Houses: Most user-created scripts are tested and run in Tribal Houses before being submitted for "Official" status on the game's room list . A code template for a basic minigame module. A list of event IDs and color codes for UI development. Instructions on how to load and test scripts in-game. Lua | Transformice Wiki | Fandom

a player presses a key. eventLoop. Int currentTime, Int timeRemaining. This event occurs every 500 miliseconds (0.5 seconds). Transformice Wiki·Contributors to Transformice Wiki

An API that provides access to the game Transformice. · GitHub

3.1 Authentication Flow

| Step | Direction | Message | Description | |------|-----------|---------|-------------| | 1 | C → S | v2 | Protocol version handshake | | 2 | S → C | HELLO | Server ready | | 3 | C → S | a[username] | Login with username (no password – legacy) | | 4 | S → C | l | Login accepted | | 5 | C → S | p[community] | Select community (en, fr, br, etc.) | | 6 | S → C | K | Ready to join rooms |

Note: Modern web clients use token-based auth via at801_sid cookie. The socket flow remains similar.

Community-Driven API Projects

Because the official tools are limited, dedicated developers have built their own:

• TfmApi (Unofficial): A Node.js wrapper for interacting with Transformice’s internal game protocol. Used to create chat bots or room managers.
• TfmLuaDocs: A community-maintained wiki documenting every Lua function, event, and callback available inside Transformice custom rooms.
• Discord Integrations: Some Discord bots use screen scraping or user-submitted data to display Transformice stats, though these are often inaccurate due to rate limiting.

Conclusion: Why the API Matters

The Transformice API is more than a technical specification—it is the reason a 14-year-old mouse game still boasts daily peaks of thousands of players. By lowering the barrier to entry (simple Lua scripting) while providing enough power (HTTP requests, custom entities), the API turned players into creators.

Whether you are a veteran shaman looking to build a puzzle room, a Discord bot developer scraping mouse colors, or a curious coder wanting to reverse-engineer a game protocol, the Transformice API offers a unique, nostalgic, and deeply rewarding playground.

Call to action: Log into Transformice today, type /room testmodule, press F3 to open the script editor, and type ui.addTextArea(1, "Hello API", nil, 0, 0, 200, 50). You’ve just taken your first step into a larger world.

Have you built a tool using the Transformice API? Share your module or bot in the comments below. For further reading, visit the Transformice Lua Scripting Wiki or the unofficial #transformice-dev Discord channel.

The heavy iron gates of the Transformice server room hummed with a low, digital thrum. Inside,

sat before a glowing terminal, his eyes reflecting a cascade of green text. He wasn't just playing the game; he was speaking to its soul through the API.

In the world of Transformice, thousands of mice scrambled for cheese in a physics-driven frenzy. But Silas saw the invisible strings. To him, the API was a map of every whisker twitch and floorboard creak across a hundred rooms. Note: Modern web clients use token-based auth via

He began to type, his fingers dancing across the mechanical keyboard.

import transformice_api as tfm # Connecting to the heart of the swarm client = tfm.Client() client.run(TOKEN) Use code with caution. Copied to clipboard

The connection sparked to life. Data flooded his screen—a rhythmic heartbeat of player coordinates, room names, and shaman incantations. He wasn't looking for a way to cheat; he was looking for the "Ghost of Room 801."

Legend said a developer had left a sentient script running in an abandoned room, a piece of code that could predict a player’s next move before they even thought of it. Using the API, Silas filtered the noise. He ignored the crowded racing rooms and the chaotic "survivor" maps. He looked for a room with a player count of exactly zero, yet a constant stream of outgoing packets. There it was. Room *#void. Silas hooked his listener into the room’s event stream.

@client.event async def on_packet_received(packet): if packet.room == "*#void": print(f"Decoding transmission: packet.data") Use code with caution. Copied to clipboard

The terminal paused. Then, the text scrolled so fast it became a blur of white light. It wasn't game data. It was poetry. The "Ghost" was reciting the history of every mouse who had ever fallen into the pit, every shaman who had missed a nail, and every cheese ever claimed since 2010.

Suddenly, Silas’s own mouse character appeared on the screen, standing alone in a dark, empty void. Above his head, a speech bubble appeared, though Silas hadn't typed a word. "You finally checked the logs, Silas," the bubble read.

His heart hammered. The API was a two-way street. He had been watching the game, but the game had been waiting for someone to listen to the data. "What are you?" Silas typed into his terminal.

The response didn't come through the game window. It appeared in his code editor, replacing his clean Python script with a single line of raw, beautiful logic: return universe.get_cheese(silas)

The screen flashed gold. In the game, Silas’s mouse didn’t just get the cheese; he became the cheese. The room collapsed into a singularity of pixels, and the connection severed. Silas sat in the dark, the hum of the servers finally silent. He looked at his screen. The API was gone, replaced by a simple desktop icon he’d never seen before: a golden feather.

He reached for the mouse, but he already knew. In the world of data, once you find the source, you never truly leave the room.

To explore the real-world mechanics of this digital world, you might want to look into:

TFMlib: A popular Python library for interacting with the game.

Lua Scripting: How players create custom "minigames" within rooms.

Atelier 801 Forums: The hub for developer documentation and community tools. If you'd like, I can help you: Outline a technical guide for using the actual API. Develop a character for a Shaman-themed mystery.

Brainstorm plot twists involving specific game mechanics like "divine" mode.