Pykemon

Pykemon is a python package for Pokemon that emulates Pokemon battle as seen in the original Pokemon games.

This package is a fork on the original poke-battle-sim package, which can be found on Github and on PyPI.

Poke-battle-sim

Pokemon Battle Simulator (poke-battle-sim) is an open-source Python package that provides efficient, customizable simulation of Pokemon battles. Thanks for checking it out.

Differences

Here are the distinctions between Pykemon and PokeBattleSim:

Features

• Possibility to create a battle with a weather.

Fixes

• The is_valid_action function now ask the correct test function for item action.
• Public function now verify that Trainer or Pokemon are initialized to throw custom error if needed.
• Pokemons can now be initialized with id.
• Damage calculations now occurs only once.
• Stat modification now occurs only once instead of twice by turn for each turns.
• The last move is now correctly saved after each turns.
• Burning multiplier now only occurs for physical moves.
• Precision modifier items now correctly modify the precision.
• Thick Fat ability now reduce damage instead of reducing precision of the move.
• Compound Eyes precision boost is now correctly applied.
• A pokemon can now have only one max HP (particularly useful for Shedinja).
• A pokemon can't be used multiple time in a same team anymore.
• Max Stats are increased to 1000 as some pokemon can reach more than 500 HP.
• Max EVs are decreased to 252 instead of 255, as it may be consider a bug patched in games after the 6th generation.
• Using an unstarted battle now raises a personalized exception.
• The number of moves for Pokemons is now limited to 4.
• Crashes upon using items have been corrected.
• Fix messages on cure with natural-cure ability.
• Weather ball move now use rock type on sandstorm.
• Embargo mechanics now cancel item usage as intended.
• Nature Power now launch by default Tri Attack or the move associated with the terrain defined in the battle.
• Hyper Beam, Blast Burn, Hydro Cannon, Frenzy Plant, Giga Impact, Rock Wrecker, Roar Of Time, Fury Cutter, Razor Wind, Earthquake, Gust and Surf damages are now calculated.
• Ice Ball, Fly, Dive, Bounce, Dig and Shadow Force pps are now correctly consumed.
• Fly, Dig, Bounce, Dive and Shadow Force now apply correctly the damage and on the second turn of the move instead of the first.
• Shadow Force is now able to hit pokemon under protection.
• Whirlpool and Low Kick now deal double damage on under water pokemons.
• Heal Block now work as intended.
• Stomp now break through opponent evasion if caused by Minimize.
• Stealth Rock is now taken into account.
• Defog now clear all hazards on the attacking pokemon side and remove fog from the battlefield.
• Rapid Spin now clean stealth rocks.
• Thunder now apply his damage and have correct precision on sun and rain weather.
• Seismic Toss and Night Shade can't hit invulnerable pokemon anymore and display the correct message when attack is avoided.
• Rollout and Ice Ball now apply the correct amount of damage considering the different bonuses.

Overview

Pykemon emulates the mechanics present in the original Generation IV Pokemon games (Diamond, Pearl, and Platinum) while also providing the ability to modify and expand upon traditional Pokemon battles.

Currently the package supports all content from Gen I to IV including:

• 493 Pokemon
• 467 Moves
• 122 Abilities
• 535 Items

Getting Started

Setting up a battle is as simple as a few lines of code.

import poke_battle_sim as pb

pikachu = pb.Pokemon(...)
ash = pb.Trainer('Ash', [pikachu])

starmie = pb.Pokemon(...)
misty = pb.Trainer('Misty', [starmie])

battle = pb.Battle(ash, misty)
battle.start()
battle.turn(...)

print(battle.get_all_text())

Check out the docs or tests for more details.

Features

Pykemon includes all functionality present in both (Single) Link Battles and (Single) Trainer Battles in the original Gen IV games.

Although this package was developed with large-scale simulation in mind, it can be used with little modification as the backend for Pokemon or Pokemon-style games.

Double Battles or other battle formats introduced in later generations are not currently supported.

Limitations

Certain mechanics present in the original games were not possible or practical to implement due to hardware-specific and region-specific behavior.

Mechanics not implemented in poke-battle-sim include:

• Using Nintendo DS audio volume data in damage calculation
• Using terrain-based type and power modifications
• Any glitches in the original games that were patched in subsequent generations

Credit

This package was originally created and managed by Vincent Johnson.

References used during development:

Bulbapedia

PokemonDB

Serebii.net

Pokemon Fan Wiki

Supporting packages:

Black was used to reformat this repository.

Setuptools was used to build this package.