Skip to content

Parnassius/cerbottana

Repository files navigation

cerbottana

Python 3.13 Code style: black Tests status Coverage

cerbottana is a Pokémon Showdown bot, originally developed for the room Italiano.

Getting started

These instructions assume you are in the root directory of a cloned cerbottana repository. If you use Windows, it is strongly advised to work within the WSL.

If you are going to test your bot locally, you will also need an active instance of a Pokémon Showdown server.

This project uses Poetry to manage its dependencies, so you will need to install that as well.

Generating complementary files

Copy .env-example into .env and edit the file accordingly. Optional environment variables are commented out.

Running a bot instance

First of all, you need to install the dependencies (drop --only main if you wish to contribute):

poetry install --only main

If you are running a local Pokémon Showdown instance, make sure it is active. Then, to start cerbottana, run:

poetry run cerbottana

To stop the execution just raise a SIGINT (Ctrl + C) in the console.

Contributing

Before submitting a pull request, please make sure that poetry run poe all passes without errors.

The bulk of cerbottana code is plugins (see plugins reference). Working on a simple plugin is a good first contribution.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks