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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: botris_interface-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 d01d84900afbb90c0d0f945856720d1c7547a0ca9ccf454af5ab9557e7989e98
MD5 a9b550df5dac25e464dbb0d7d3632036
BLAKE2b-256 625e6b341e7f0e16b29f9672c22a60c43fdbf4863644758dfc1f0dd92ddd750d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for botris_interface-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3cd6065a3d856fd8354abefc86346fc52b93e417045dc802e25611ec6726cc6a
MD5 a645c56c372c14bcf0d4ae366faaa0fc
BLAKE2b-256 dc77323ff3823064f5cbb24339839967589503fb8acffc004b80ee587e18bbe2

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