| API / Library | Language | Type | Primary Use | Status | |---|---|---|---|---| | | Lua | Official | In-game minigames | Active, fully supported | | Transfromage | Lua (Luvit) | External | Bot development | Active, requires token | | aiotfm | Python (asyncio) | External | Bot development | Active | | caseus | Python | External | Networking, deobfuscation | Active | | cheesy.js | Node.js | External | Bot development | Active | | transformice-web-client | JavaScript (Vue/Quasar) | External | Web client | Active |
The Transformice API (Application Programming Interface) allows external applications to interact with the game's servers, fetching data such as:
Transformice servers are highly sensitive to spam. Sending too many packets or chat whispers in a short window will result in an automatic IP mute or a socket disconnection. Implement delays (e.g., 500ms to 1000ms) between automated actions.
Because the official API can be rate-limited or complex to parse raw JSON responses, the community has built excellent wrappers in various languages.
Used to get a player’s ID and rank. GET https://transformice.com/en/api/profile/username/[NAME] transformice api
Since its release in 2010, has defied the typical life cycle of a flash-based browser game. Developed by Melibellule and Tigrounette, the game tasks players (as mice) with collecting cheese and returning to their hole, guided by a shaman. But beneath its charming, chaotic surface lies a robust, often underappreciated engine for creativity: the Transformice API .
The , primarily referred to as the Module API , is a Lua-based scripting system that allows players to create custom minigames (modules) directly within the game environment. Unlike external bots, these modules run natively on the game's servers, enabling developers to modify game physics, handle player interactions, and create unique objectives. Core Functionality
// Initialize with your API key (if required by the wrapper) const api = new tfapi.Client('YOUR_API_KEY');
that allows players with "Module" permissions to create custom rooms and minigames. Creating scripts for rooms (like The API is event-driven . Your script waits for things like eventNewGame eventPlayerWon eventChatCommand Key Functions: tfm.exec.addShamanObject() : Spawns objects. tfm.exec.movePlayer() : Teleports mice. tfm.exec.setPlayerScore() : Updates the leaderboard. tfm.exec.displayParticle() : Adds visual effects. Where to learn: Official Lua Documentation | API / Library | Language | Type
: The client connects to the Transformice server ports (usually 443 or 5555).
A multi-threaded event-based version of Transfromage (originally by Tocuto) has been discontinued, but served as a foundation for later iterations.
, which allows you to create custom minigames (modules) or tribe house scripts. To display and manipulate text within the game, you use the tfm.enum.addTextArea function and its related events. Transformice Wiki Creating a Text Area
— A Node.js client library for Transformice that allows developers to create bots using JavaScript. Notable aspects include: Because the official API can be rate-limited or
function eventPlayerDied(name) local data = json.encode(player = name, map = tfm.get.room.currentMap, time = os.time()) tfm.exec.httpRequest("https://your-api.com/log_death", "POST", data, "application/json") end
: If the API returns a 429 Too Many Requests status code, increase the delay between subsequent requests exponentially.
What can you actually build with this? Here are a few ideas: