@haelp/teto

Triangle.js

A Typescript library and client for interacting with the TETR.IO main game API and the ch.tetr.io channel API.

Disclaimer:

This library is not officially supported nor endorsed by TETR.IO. Use of the main game API is only permitted with an official bot account. You assume all responsibility for any actions that result in staff action (warnings/bans, etc). The main game API is not documented and this library may break at any time. This restriction includes the use of the Client class and the API class.

The Tetra Channel section of this library (imported through '@haelp/teto/ch') is open to use by anyone.

Installation

npm i @haelp/teto

or

git clone https://github.com/Genius6942/triangle triangle

Note: Only looking to use the ch.tetr.io api? Check out the documentation here.

Setup (git installation only)

It is highly recommended that you use a Typescript project for this library if you choose to clone from source. If you are not using Typescript, you will need to use a tool like tsc to compile the source code. This is because the TETR.IO api is complex and being able to use type checking will greatly reduce the chance of errors. Incorrectly formatted messages sent to the server may cause an account ban.

It is also recommended (but not required) that you add a typescript path mapping to the src directory in your tsconfig.json file. This will allow you to import the library like so:

import { Client } from "@triangle";

To do this, add the following to the "compilerOptions" object in your tsconfig.json file:

"paths": {
		"@triangle": ["./path/to/triangle/src"]
}

Usage

The following usage examples assume you are using Typescript. They also assume you can use top level await. If you cannot, you will need to wrap the code in an async function.

Import

Bun:

import { Client } from "@haelp/teto/bun";

Warning: Bun currently segfaults when running the codec vm required for ribbon. This will not be fixed, the issue will only be resovled if a new bun version fixes this bug. For now, we recommend using 'esbuild' to compile/run your code if you use typescript.

Node:

import { Client } from "@haelp/teto";

Creating a client

const client = await Client.connect({
  username: "your-username",
  password: "your-password"
});
// or {token: "your-token"}

Creating a room

const room = await client.rooms.create("private");
console.log("Joined room", room.id);

Joining a public room

const rooms = await client.rooms.list();
const room = await client.rooms.join(rooms[0].id);
console.log("Joined room", room.id);

Starting a game

The following example presses the hard drop key every 1/2 second

room.start();
const tick = await client.wait("client.game.start");
tick(async (data) => {
  if (data.frame % 30 === 29) {
    return {
      keys: [
        {
          frame: data.frame,
          key: "hardDrop",
          type: "keydown"
        },
        {
          frame: data.frame + 0.5,
          key: "hardDrop",
          type: "keydown"
        }
      ]
    };
  }
  return {};
});

await client.wait("game.end");
console.log("game over");

Chatting

room.chat("Hello, world!");
// send a pinned message (when host)
room.chat("Hello, world!", true);

Listening for chat messages

client.on("room.chat", (data) => {
  console.log(data.user, "says", data.content);
});

Events

The triangle.js client follows an async/await based method, while TETR.IO generally has a event/callback based system. To help facilitate the connection between these two systems, the client provides several helper methods.

All of these methods are typed, so your ide will likely assist with autocomplete. All events are in src/types/events

client.emit - Takes in an event (sent as "command" to TETR.IO) and optionally a data parameter (sent as "data")

client.emit(<event>, <data>);

client.wait - Waits for an event to occur and returns a promise of the data in the event.

const data = await client.wait(<event>);

client.wrap - Sends an event and waits for a return event. Throws an error if the server responds with an "err" message while waiting.

const data = await client.wrap(<send event>, <data>, <receive event>);

For events that you might want to handle multiple times, you can use client.on, client.off, and client.once (node EventEmitter methods).

Client Events

Client events are not sent by TETR.IO. They are events sent by the triangle.js client itself, to help make creating a bot easier.

For example the client.room.players event fires every time a player moves their bracket, joins, or leaves. Rather than listening to several events and managing a players list yourself (with room.player.add, room.player.remove, room.update, room.update.bracket, etc) you can use the single client.room.players. See src/types/events/in/client for more events you can use.

Other notes

To run and debug your code, it is best to use bun

You should store credentials in a .env file. Bun will automatically load this file and make the variables available in your code. You can also use the dotenv package to load the file manually.

The code should only be used on an authorized bot account (or you risk being banned) It is recommended to set a custom userAgent in the client options to identify your bot to the server.

Be careful with what variables you save and where. Due to the event-based nature of TETR.IO and this library, it is easy to accidentally create a memory leak. For example, the "tick" function exposed on the "client.game.start" event is used for this reason.

Building

Install bun if you haven't already:

curl -fsSL https://bun.sh/install | bash

Then run:

bun run build

Contributing

File an issue and make a pull request on github

Credits

• Made by halp (website under construction)

• Thanks to luke and redstone576 for testing this library.

Interested in contribute to the project? Contact haelp on discord (Please come with some experience with TETR.IO api and an understanding of this library).