Important

This version of transfromage is discontinued and needs a patch to work with the new transformice protocol. That won't be applied. If you're using this version, you must switch to aiotfm.

_{sh dont tell anyone but this is just an edit of this readme}

Transformice's API written in Python 3.6 using threads

About

Transformice is an online independent multiplayer free-to-play platform video game created by the french company Atelier801.

TransFromage API is a documented API that allows developers to make bots for the mentioned game.

Join the Fifty Shades of Lua discord to discuss about this API and to have special support.

This API had many indirect contributors, including @Lautenschlager-id, @Turkitutu and @Athesdrake.

Keys Endpoint

This API depends on an endpoint that gives you access to the Transformice encryption keys.

To use it you will need a token which you can get by applying on this form. See below to know the names of Transfromage managers who handle the token system.

• Tocutoeltuco @discord=> Tocu#0018 212634414021214209;
• Blank3495 @discord=> 󠂪󠂪 󠂪󠂪 󠂪󠂪󠂪󠂪 󠂪󠂪 󠂪󠂪󠂪󠂪 󠂪󠂪 󠂪󠂪#8737 436703225140346881;
• Bolodefchoco @discord=> Lautenschlager#2555 285878295759814656.

Installation

• The module is in the PyPI so all you need to run is pip install --upgrade transfromage

API Update

To update the api all you need to do is run the same installation command.

Contribution

The best way to contribute for this API is creating pull requests with bug fixes and new events / methods (like joining the map editor, getting a map XML, loading Lua...)

Base example

import transfromage

client = transfromage.Client()

@client.event
def on_ready():
	client.login("Username#0000", "password", "start room")

client.start("Owner ID", "API Token")