Transformice's API written in Lua (5.1▲) using the Luvit runtime environment
Luvit is an open-source, asynchronous I/O Lua runtime environment that makes requests and connections possible for the Lua programming language.
Transfromage API is a documented API that allows developers to make bots for the mentioned game.
See also the Fromage API for the Atelier801's forum.
This API depends on an endpoint that gives you access to the Transformice encryption keys.
To get access to it you need to request a token, after explaining your project, to one of the following players:
- Tocutoeltuco @discord=>
- Blank#3495 @discord=>
- Bolodefchoco @discord=>
- To install Luvit, visit https://luvit.io and follow the instructions provided for your platform.
- If you have problems installing it on Windows, please use Get-Lit
- To install Transfromage, run
lit install Lautenschlager-id/transfromage
- Run your bot script using, for example,
To update the API automatically all you need to do is to create a file named
autoupdate in the bot's path.
You can create it running
cd. > autoupdate (for Windows) or
touch autoupdate (for Linux);
The update will overwrite all the old files and dependencies.
For semi-automatic updates (asks permission before updating), create the file
The best way to contribute for this API is
donating creating pull requests with bug fixes and new events / methods (like joining the map editor, getting a map XML, loading Lua...)
Read CONTRIBUTING to learn more about contributions for the API.
local api = require("transfromage") local client = api.client:new() client:once("ready", function() client:connect("Username#0000", "password") end) client:start("Owner ID", "API Token")