Poke-env: A Python Interface for Pokémon Showdown Bots

Poke-env is a Python library for building scripted agents, self-play experiments, and reinforcement learning workflows on Pokémon Showdown.

It provides a battle-centric API around Players, Battles, Pokémon, and Moves, alongside a Farama Gymnasium interface for reinforcement learning.

Attention

While poke-env aims to support all Pokémon generations, it was primarily developed with the latest generations in mind. If you discover any missing or incorrect functionalities for earlier generations, please open an issue to help improve the library.

Start Here

• New to the library: Getting Started

• Looking for runnable guides: Examples

User guide

• Getting Started
  • Installing poke-env
  • Configuring a Pokémon Showdown Server
  • Your First Local Battle
  • Creating Agents
  • Configuring Showdown Players
  • Connecting Bots to Showdown
  • What Next
• Examples
  • Choose an Example

Main modules documentation

• The Battle object
  • Abstract Battle
  • Battle
  • Double Battle
  • Target
• The player object and related subclasses
  • Player
  • Baselines
  • Battle orders
  • Utilities
• The pokémon object
  • Pokemon
• The move object
  • DynamaxMove
  • Move
  • MoveSet
• The env object and related subclasses
  • PokeEnv
  • SinglesEnv
  • DoublesEnv
  • SingleAgentWrapper
• Other objects
  • Effect
  • Field
  • Move category
  • Pokemon gender
  • Pokemon Type
  • Side condition
  • Status
  • Weather
  • Z Crystal

On top of the main modules dedicated to building Pokémon Showdown bots, Poke-env encompasses standalone submodules to cater to various facets of Pokémon Showdown interactions:

Standalone submodules documentation

• Data - Access and manipulate pokémon data
• PS Client - Interact with Pokémon Showdown servers
• Teambuilder - Parse and generate showdown teams
• Concurrency utilities
• Damage calculator
• Stats utilities
• Exceptions

Acknowledgements

Originated from a group project at École Polytechnique. Inspired partially by showdown-battle-bot and built upon Pokemon Showdown.

Data

Data adapted from Pokemon Showdown and team data sourced from Smogon forums’ RMT section.

License

Released under the MIT License.