Skip to main content

A performant library designed for creating and managing bots in a Tetris-like game environment. This library offers various tools and features to build, test, and deploy bots efficiently to Botris.

Project description

botris-interface

GitHub license GitHub issues GitHub stars GitHub forks

botris-interface is a performant library designed for creating and managing bots in a Tetris-like game environment. This library offers various tools and features to build, test, and deploy bots efficiently to Botris.

Installation

To install the library, use the following command:

pip install botris-interface

Usage

Creating a Bot

To create a bot, you need to implement the Bot interface provided by the library. Here is an example:

from botris.bots import Bot

class CoolBot(Bot):
    async def analyze(
        self, game_state: GameState, players: List[PlayerData]
    ) -> Awaitable[List[Command]]:
        # Implement your bot logic here
        pass

Running the TetrisGame

You can run the TetrisGame using the following code:

from botris import TetrisGame
from botris.engine import Move

gs = TetrisGame()
gs.execute_move(Move.move_left)

Connecting a Bot to the Server

To connect your bot to the server, use the following code:

import asyncio
from botris import Interface

async def main():
    bot = MyBot()
    itf = Interface.create(TOKEN, ROOM_KEY, bot)
    await itf.connect()

asyncio.run(main())

License

This project is licensed under the MIT License - see the LICENSE file for details.

GitHub Repository

For more information, visit our GitHub repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

botris_interface-0.1.14.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

botris_interface-0.1.14-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file botris_interface-0.1.14.tar.gz.

File metadata

  • Download URL: botris_interface-0.1.14.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.1 Windows/11

File hashes

Hashes for botris_interface-0.1.14.tar.gz
Algorithm Hash digest
SHA256 d99e4e600e530cba13200e98a8dfe7da93e698e20182dc521e4097074f817aee
MD5 0cfdbcc6b8e1407e14404c28e358fc78
BLAKE2b-256 b64726ac6a635cddba0154f07f463f8059ff399fcb050cd84375329b4ba92f61

See more details on using hashes here.

File details

Details for the file botris_interface-0.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for botris_interface-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 2f50d5254250db3fb52dae0d9eaa67dec28857a97e8e775099e61cfe1a1f54f6
MD5 965e576e89626c1731d626a4c2fdf3fd
BLAKE2b-256 203308c89af05b0166904ac065ae1abe8d13c91a3e02140e10e556017546919c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page