The Ultimate Guide to the Transformice API: Building Tools for the Mouse Community
, 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
Atelier 801 exposes raw data via specific web URLs, often used to feed the official standalone forums and profile pages. These endpoints return structured text or XML data containing player IDs, registration dates, and basic profile info. Developers cache this data to build external leaderboard websites. 2. Socket-Based Connections (Live Data & Bots)
Which of those would you like next?
-- Simple entry point: Spawn a piece of cheese when a round begins function eventNewGame() local roomData = tfm.get.room print("Now playing on map code: " .. roomData.currentMap) end Use code with caution. 2. Event-Driven Programming Model
if not profile_res.json().get('success'): return None
Maintained by Atelier 801 to serve basic forum, profile, and community data. transformice api
Unlike modern multiplayer games that offer standardized REST APIs with neat JSON documentation, Transformice relies on a mix of official endpoints, community-driven database dumps, and direct socket connections. Official Web Endpoints
: Browse through existing open-source scripts on the Transformice GitHub Topic to read clean code written by veteran creators.
-- This function runs automatically when a mouse joins the room function eventNewPlayer(playerName) print("Welcome to the room, " .. playerName .. "!") tfm.exec.giveCheese(playerName) end Use code with caution. Copied to clipboard 📚 Essential Resources The Ultimate Guide to the Transformice API: Building
const WebSocket = require('ws');
: Developers often use pshy_merge , a community-developed Lua compiler, to manage complex scripts and import external modules .
Mastering the Cheese: A Deep Dive into the Transformice API If you’ve ever wanted to track your stats, build a custom leaderboard, or create a unique tribe tool, the is your ticket to the back-end of the cheese-loving universe. Developed by Atelier 801, this API allows the community to pull real-time data from the game and build the fansites we all rely on. These endpoints return structured text or XML data
: Room changes, map loads, and real-time player actions via custom socket bots. Key Data Retrieval Methods
tfm.exec.giveCheese() : Instantly awards cheese to a specific mouse.