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.6.tar.gz (843.0 kB view details)

Uploaded Source

Built Distribution

botris_interface-0.1.6-py3-none-any.whl (852.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: botris_interface-0.1.6.tar.gz
  • Upload date:
  • Size: 843.0 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.6.tar.gz
Algorithm Hash digest
SHA256 1902faf3762c92df904cec133a5211f24f687b12d964fb510089849dad9ace07
MD5 7cd6758378c1c0e51e306712cc42c242
BLAKE2b-256 37c6029b1480314c72d42bf555da4a580c5c6657c0d357cb574bcf55d0a249b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for botris_interface-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 918515a2f1111c0147444baa49f579ea6dc62922fdc8dc41e5a946a33ea5806c
MD5 b73c01d95d460ca66948e9291a4ee54e
BLAKE2b-256 05e3176ac5e1fccfb3f6d5159bafda24e54b63c6a6a8db8e0dec224c5caf5ad6

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