WIP: Pokemon Gen 1 Game Wrapper Expansion #281

SnarkAttack · 2023-11-07T16:47:58Z

This pull request is meant to add two major features to the Pokemon Generation 1 game wrapper:

Enums/constants for many important values, including IDs of Pokemon, sprites, moves, items, etc., and then relevant mapping to names/other features, to make code more readable.
Classes that encapsulate data accesses to avoid requiring users of the wrapper to look up their own memory addresses/manage multiple data accesses for what is functionally a single data structure (e.g. a single function call to access all of a Pokemon's data)

…onally identical

…monRed references

… human-readable enums rather than raw hex values

…d writing multiple bytes simultaniously, with the default length being 1

…mon Red/Blue so that data can be interacted with in a more Pythonic way

…n in the party

…tle easier to parse the data

…ability/start adding intermediate classes so data chance underneath doesn't affect API calls

…ookup

… class

…ent first pass at Player class write to memory

… and will let us encapsulate memory data for read and write calls

…pen them outside of MemoryManager

…er wrapper functions for ease of testing if memory addresses are useful. SHOULD NOT BE PERMANANT

…n what form the memory is encoded at that address, then added overarching read and write functions that use appropriate memory type functions

…ject OR enum with MemoryAddress object as value

…y into MemoryObjects, which only store that data requested for more efficient loads/stores

…per so we have to pass less things outside of PyBoy

…ant this being commonly used

…emon-gen-1

Maciek Baron and others added 30 commits June 27, 2020 19:09

Add Pokemon Red constants

3e3fe16

Add initial Pokemon Red wrapper code

3e87f78

Merge branch 'master' into feature/pokered

ba72073

Merge branch 'master' into feature/pokered

b1ede15

Merge remote-tracking branch 'origin/master' into pokemon-red

a00f320

Change files from Pokemon Red to PokemonGen1 as both games are functi…

b6229b9

…onally identical

Remove old pokemon_gen1 PLUGIN AS WELL AS now-renamed GameWrapperPoke…

75aa8be

…monRed references

Add debug.pxi

6e41541

Add functions to read/write multiple consecutive bytes of memory

a52ec6c

Create Python file with memory addresses so they can be referenced as…

2b591d3

… human-readable enums rather than raw hex values

Convert get_memory_value and set_memory_value to allow for reading an…

b63f66b

…d writing multiple bytes simultaniously, with the default length being 1

Create Gen1MemoryManager, a class to wrap memory read/writes for Poke…

c6dc375

…mon Red/Blue so that data can be interacted with in a more Pythonic way

Convert moves to an Enum

1815652

Convert Pokemon (previously MONSTERS) into Enum

1f518c0

Convert Items into Enum

c44d925

Convert Sprites into Enum

d3d5398

Convert Maps into Enum

935ac55

Convert Statuses into Enum

24efb7a

Raname Status Enum to Statuses (which was the original intent)

be72c8f

Create Pokemon class to wrap memory loading of all values of a pokemo…

1998390

…n in the party

Start recreating PokemonPOkedexIndex enum

4b08aef

Define pretty print function for Pokemon type

1439fc0

Convert pokedex entry lookup into a dictionary with a Pokemon Enum key

2e4a2dc

Break up constants.py into directory with smaller files so it's a lit…

6abad35

…tle easier to parse the data

Restructure files to break down constants into smaller parts for read…

84dc3e8

…ability/start adding intermediate classes so data chance underneath doesn't affect API calls

Move location constants into new directory and create dict for name l…

4cba7ba

…ookup

Remove location constants from constants.py after their move

6d7e4f7

Change Pokemon enum to PokemonIds to avoid any confusion with Pokemon…

5eb582f

… class

Fix mapping dicts to use newly named PokemonIds

2f23ad9

Continue fleshing out Pokemon class

02815d4

SnarkAttack and others added 29 commits November 8, 2023 14:55

REname all enums to singular form for better readability

f32025b

Fix issue where we needed enum value not enum to get correct list slice

488f56c

Convert all memory address enums to singular as well

754ac34

Add write functions to match corresponding reads in memory and implem…

d196a60

…ent first pass at Player class write to memory

Add MemoryAdressEnum, which all memory address data will inherit from…

e2dacc3

… and will let us encapsulate memory data for read and write calls

Add wrapper functions to write MemoryAddressEnums without having to o…

403f8c2

…pen them outside of MemoryManager

Fix issues with MemoryAddressEnum working in read/write calls

f30bdc3

Fix a few write bugs discovered in Player write testing

e65acb9

Add memory access functions for a variety of common functions

91f1355

Merge branch 'memory_access_functions' into pokemon-gen-1

d0919b9

Merge branch 'master' into pokemon-gen-1

d25ba96

Add function to get player x/y location

bfba88b

Add memory access function in game wrapper that uses the memory manag…

a6c5359

…er wrapper functions for ease of testing if memory addresses are useful. SHOULD NOT BE PERMANANT

Add GameState object to track general game info

19d1905

Fix check on game_state.is_in_battle (was returning opposite of desired)

bc2c544

Rewrite memory address enums so they are now a class and also track i…

2486aad

…n what form the memory is encoded at that address, then added overarching read and write functions that use appropriate memory type functions

Allow read and write super calls tot ake in straight MemoryAddress ob…

759d616

…ject OR enum with MemoryAddress object as value

Convert previous objects that stored representations of data in memor…

3027a8e

…y into MemoryObjects, which only store that data requested for more efficient loads/stores

Rename add_address to add_offset

1e16bec

Remove print statement that was acidentally committed

9623437

Update Player class to use new memory reading approach

5cbb27e

Merge branch 'rewrite_memory_reading' into pokemon-gen-1

974d7d2

Add map_id to player location result and add access to screen in wrap…

0897771

…per so we have to pass less things outside of PyBoy

Add function to return all Pokemon in party

437a8ea

Add experience property to Pokemon

3510133

Merge branch 'master' into pokemon-gen-1

78bb7fd

Add function to read ROM, not exposed out of class because we don't w…

2ac86f3

…ant this being commonly used

Give access to ROM reading memory

7e4f4a8

Merge branch 'pokemon-gen-1' of github.com:SnarkAttack/PyBoy into pok…

4204412

…emon-gen-1

Baekalfen force-pushed the master branch from 634d13d to 36c20d7 Compare February 28, 2025 11:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

WIP: Pokemon Gen 1 Game Wrapper Expansion #281

WIP: Pokemon Gen 1 Game Wrapper Expansion #281

Uh oh!

SnarkAttack commented Nov 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

WIP: Pokemon Gen 1 Game Wrapper Expansion #281

Are you sure you want to change the base?

WIP: Pokemon Gen 1 Game Wrapper Expansion #281

Uh oh!

Conversation

SnarkAttack commented Nov 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants