The Transformice API, primarily accessed through the in-game Lua system and external community-driven tools, allows players to create custom game modes, automate tribe functions, and track player statistics . Key Capabilities
Lua Scripting Engine: Players can write scripts for tribe houses and official "Modules" . Common functions include custom object spawning, gravity manipulation, and mini-game creation (e.g., racing or parkour modules) .
Tribe Bots: The API enables the creation of automated bots that can manage tribe recruitment, play music (historically via YouTube API), and test maps .
Player Statistics: Unofficial leaderboards like Cheeseformice utilize the API to scrape and display global rankings, cheese counts, and first-place statistics . Developer Experience & Tools
Accessibility: Documentation and function trees can be accessed directly in-game by typing /luahelp .
Community Resources: Developers often use pshy_merge, a community-developed Lua compiler, to manage complex scripts and import external modules .
Limitations: Security constraints prevent certain sensitive game code (like the "Fortoresse" codebase) from being open-sourced to prevent exploit discovery . Review Perspective Pros Cons
High Versatility: Allows for entirely new game modes within the platform . transformice api
Complexity: Shaman and Lua controls can have a steep learning curve .
Active Ecosystem: Extensive GitHub repositories for bot templates and script compilers .
Volatility: Official API changes (e.g., YouTube API removal) can break legacy bot features .
Community Integration: powers widely-used third-party leaderboards and stat trackers .
Limited Support: Sensitive security features remain closed-source . Transformice | Review // Test Transformice ist ein Physik-basiertes Plattformspiel, YouTube·GamingClerks Lua | Transformice Wiki | Fandom
Transformice , the "API" typically refers to the Lua scripting engine
, 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 The Transformice API , primarily accessed through the
To develop a text element, you must define its ID, the content, and its position on the screen. -- Basic script to show text to all players
"
Welcome to my Map!
"-- tfm.enum.addTextArea(id, text, targetPlayer, x, y, width, height, backgroundColor, borderColor, alpha, fixedPos) tfm.exec.addTextArea(textId, content, Use code with caution. Copied to clipboard Interactive Text (Buttons) You can make text clickable by using the
(anchor) tag with a custom event name. When a player clicks it, the eventTextAreaCallback is triggered. Transformice Wiki Define the Link: Wrap your text in Text Handle the Click:
Use the callback function to run code when that specific action is clicked. -- Example: A clickable "Close" button tfm.exec.addTextArea( "[ Close ]" eventTextAreaCallback(id, player, callback) callback == "close_menu" tfm.exec.removeTextArea(id, player) Use code with caution. Copied to clipboard Key Formatting Tags including their title
Transformice text areas support a limited subset of HTML/CSS for styling: ... ... Alignment:
...
(Supported values: (Underline) External ToolsIf you are looking to develop external tools like bots or forum integration rather than in-game scripts: Transfromage A documented Lua API for creating game bots. Fromage API Specifically for interacting with the Atelier801 forums. , such as a leaderboard or a shop menu? Lua | Transformice Wiki | Fandom
Older libraries used raw TCP sockets to emulate a game client. As of the HTML5 migration (2021+), this is nearly impossible without breaking the Terms of Service (ToS). Stick to the HTTP endpoints and Lua modules.
at801_sid cookie. Botting should use disposable guest accounts.For retrieving total game stats.
GET https://transformice.com/en/api/stats/player/[PLAYER_ID]
Response includes:
total_cheesetotal_roundstime_played_secondsfirst_roundtitlesGET https://transformice.com/en/joueur/profil/[username]
Returns HTML page. Community parsers scrape the following:
The API is logically divided into namespaces. Here are the critical ones you need to know: