When building tools utilizing the Transformice network or web endpoints, keep the following guidelines in mind to protect your developer account from being flagged or banned:
: Libraries like Transfromage provide external API access for bot development, though they require specific encryption tokens.
However, always remember to respect the game's rules and the experience of other players.
For retrieving total game stats. GET https://transformice.com/en/api/stats/player/[PLAYER_ID]
The (officially known as the Transformice Module API ) is an in-game development toolkit that allows players to build custom mini-games, design unique mechanics, and script automated map actions using the lightweight Lua programming language . Integrated directly into the Atelier 801 ecosystem, this framework shifts the workload away from complex external chat-bots and places room-wide control directly into the hands of scriptwriters. transformice api
Managing specialized mini-games (e.g., Racing, Bootcamp, Village) by keeping track of scores, times, and winners.
The API provides a tfm.exec namespace with dozens of powerful methods:
: How players create custom "minigames" within rooms.
As of 2025, Transformice remains active, with updates focused on cosmetics and bug fixes. The developers have not announced plans for an external API. However, the Lua scripting system is still beloved by the dedicated core community. When building tools utilizing the Transformice network or
: Executes automatically every 500 milliseconds (0.5 seconds). This acts as the rhythm generator for game clocks, hazard generation, or physics updates.
-- Essential Snippets for Room Control tfm.exec.respawnPlayer("Username#0000") -- Revives a fallen mouse tfm.exec.giveCheese("Username#0000") -- Grants cheese instantly tfm.exec.addShamanObject(2, 400, 200, 0, 0, 0, false) -- Spawns an anvil item tfm.exec.setGameTime(120) -- Forces a 2-minute round clock Use code with caution.
The Module API transforms Transformice from a simple platformer into a development environment. It provides dozens of and methods for creating custom game modes, interactive UI elements, and automated systems.
player_id = profile_res.json()['player_id'] GET https://transformice
Transfromage is the most established bot API for Transformice, written in Lua (5.1+) using the Luvit asynchronous runtime environment.
What (stats, maps, live chat) are you trying to capture?
| | Key Features | Example | |--------------|------------------|--------------| | Events | eventChatCommand , eventKeyboard , eventMouse , eventNewGame , eventLoop , eventPlayerDied , eventPlayerGetCheese , eventPlayerWon , eventSummoningStart | Trigger on player actions | | Methods | tfm.exec.addImage , tfm.exec.addShamanObject , tfm.exec.giveCheese , tfm.exec.killPlayer , tfm.exec.movePlayer , tfm.exec.setGameTime , tfm.exec.setMap | Control game state | | Utilities | print() (debugging), file I/O, map XML loading | Manage game data |