Transformice Api
: Documentation for creating custom buttons, text areas, and popup windows .
Because the official API can be rate-limited or complex to parse raw JSON responses, the community has built excellent wrappers in various languages.
Key features include:
If you want to experiment with the Transformice Lua API: transformice api
: 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
While Transformice doesn’t have a sprawling, public REST API like Twitter or Google Maps, its internal Lua API for custom rooms and an unofficial external data API have allowed the game to thrive through user-generated content, bots, and third-party tools.
: Executes automatically every 500 milliseconds (0.5 seconds). This acts as the rhythm generator for game clocks, hazard generation, or physics updates. : Documentation for creating custom buttons, text areas,
While the real-time logic uses WebSockets, certain static data can be fetched via HTTP:
eventNewGame() : Runs immediately when a new round generates, clearing out older physics bodies. Common Core Functions Matrix Function Namespace Common Use Case tfm.exec.respawnPlayer() Revives a defeated mouse. Continuous action loops / Bootcamp tfm.exec.addShamanObject() Spawns planks, anvils, boxes. Procedural obstacle creation tfm.exec.setGameTime() Changes the level countdown. Extending puzzle rounds tfm.exec.displayParticle() Draws visual graphics elements. Creating user rewards/visual trails 3. Designing a Custom Mini-Game Module
async function getPlayerStats(username) try const player = await api.player.get(username); console.log(`Player: $player.name`); console.log(`Cheese Gathered: $player.cheese`); console.log(`Firsts: $player.firsts`); console.log(`Tribe: $player.tribeName`); catch (error) console.error("Mouse not found! Did they get banned?"); This acts as the rhythm generator for game
: Sites like Formice utilize these data feeds to provide real-time leaderboards and historical player rankings. 3. Developer Tools and Optimization
Welcome to my Map!
: Member rosters, ranks, and aggregate tribe statistics.
: eventChatCommand detects "!" commands in chat, while eventKeyboard and eventMouse track physical inputs.