Skip to main content

A python interface for training Reinforcement Learning bots to battle on pokemon showdown.

Project description

The pokemon showdown Python environment

PyPI version fury.io PyPI pyversions License: MIT Documentation Status codecov

A Python interface to create battling pokemon agents. poke-env offers an easy-to-use interface for creating rule-based or training Reinforcement Learning bots to battle on pokemon showdown.

A simple agent in action

Getting started

Agents are instance of python classes inheriting from Player. Here is what your first agent could look like:

class YourFirstAgent(Player):
    def choose_move(self, battle):
        for move in battle.available_moves:
            if move.base_power > 90:
                # A powerful move! Let's use it
                return self.create_order(move)

        # No available move? Let's switch then!
        for switch in battle.available_switches:
            if switch.current_hp_fraction > battle.active_pokemon.current_hp_fraction:
                # This other pokemon has more HP left... Let's switch it in?
                return self.create_order(switch)

        # Not sure what to do?
        return self.choose_random_move(battle)

To get started, take a look at our documentation!

Documentation and examples

Documentation, detailed examples and starting code can be found on readthedocs.

Installation

This project requires python >= 3.9 and a Pokemon Showdown server.

pip install poke-env

You can use smogon's server to try out your agents against humans, but having a development server is strongly recommended. In particular, it is recommended to use the --no-security flag to run a local server with most rate limiting and throttling turned off. Please refer to the docs for detailed setup instructions.

git clone https://github.com/smogon/pokemon-showdown.git
cd pokemon-showdown
npm install
cp config/config-example.js config/config.js
node pokemon-showdown start --no-security

Development version

You can also clone the latest master version with:

git clone https://github.com/hsahovic/poke-env.git

Dependencies and development dependencies can then be installed with:

pip install .[dev]

Acknowledgements

This project is a follow-up of a group project from an artifical intelligence class at Ecole Polytechnique.

You can find the original repository here. It is partially inspired by the showdown-battle-bot project. Of course, none of these would have been possible without Pokemon Showdown.

Team data comes from Smogon forums' RMT section.

Data

Data files are adapted version of the js data files of Pokemon Showdown.

License

License: MIT

Citing poke-env

@misc{poke_env,
    author       = {Haris Sahovic},
    title        = {Poke-env: pokemon AI in python},
    url          = {https://github.com/hsahovic/poke-env}
}

Download files

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

Source Distribution

poke_env-0.10.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

poke_env-0.10.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file poke_env-0.10.0.tar.gz.

File metadata

  • Download URL: poke_env-0.10.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for poke_env-0.10.0.tar.gz
Algorithm Hash digest
SHA256 3c5998396ed2fe64f86e4c3ac553b094a9bc2047f33ac6b1415e4afd49e73e96
MD5 9a3551c379b5366260437ae8adb5c062
BLAKE2b-256 30b1b20c4dfcfb9dfd4dbf995bce6dd4bda326098813a5fa40f0805a13085917

See more details on using hashes here.

File details

Details for the file poke_env-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: poke_env-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for poke_env-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b3c9887cc7f484fdabf32a307940a842e0052022e1090590884857ee9af798f
MD5 1512b480d329bfd18a0c654f1bcd333d
BLAKE2b-256 57c97e1e722d80db6cd8ed302f4c873c05ec8974b2a6c9455f3ab5cd54306ef2

See more details on using hashes here.

Supported by

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