@cheeseformice/transformice.js v1.2.0

Transformice.js

Transformice.js is a Node.js Client for Transformice that allows you to create bots. It comes with full support for CommonJS and Typescript typings.

• Read the docs
• Read the changelogs

Transformice.js is originally created and maintained by SuspiciousLookingOwl. This is the maintained continuation on Cheeseformice.

Authentication

To use this client, you must have an authenticated account in-game. You will need to apply on this form. If you get accepted, you will be able to choose an account (except your main account) to get the bot role - and thus, being able to use the client.

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.

Development

Clone the repository:

git clone https://github.com/cheeseformice/transformice.js

Install dependencies:

pnpm i

Watch and compile files:

pnpm run dev

Example

const { Client, enums } = require("@cheeseformice/transformice.js");

const client = new Client("username", "password", {
	language: enums.Language.en
});

client.on("roomMessage", (message) => {
	if (client.name === message.author.name) return;
	client.sendRoomMessage(message.author.look);
});

client.run();

Acknowledgements

• Thanks Owl for pioneering the bulk of Transformice.js.
• Thanks to Athes for detfm. I no longer have to read garbled nonsense to get the packet structure.
• Thanks to friedkeenan for maintaining the exhaustive packet documentation in caseus. Saves me the manual labour needing to sherlock holmes those myself.

Similar projects

If you would like a different flavor to write your bot in, you may check out the other similar Transformice clients:

• aiotfm - Python
• Transfromage - Lua
• cheesy.js - Another Node.js client