WIP: Pokemon Red plugin #176

MaciekBaron · 2020-06-27T18:38:08Z

I was hoping to do a WIP review as there's a lot of code, please let me know what you think - thanks!

TODO

Add player position/location functions (currently we only get current map)
Determine game_area size and logic (there is overworld mode, battles and menus)
Determine (if needed) fitness scoring

Baekalfen

I haven't looked into all details, but what you've done so far looks really good!

Baekalfen · 2020-06-30T20:17:49Z

pyboy/plugins/game_wrapper_pokemon_red/wrapper.py

+    def get_int_at_address(self, address, size=2):
+        """Returns an integer from a given address of a specified size."""
+        bytes = []
+        for i in range(size):
+            bytes.append(self.pyboy.get_memory_value(address + i))
+        return int.from_bytes(bytes, byteorder=BYTE_ORDER)
+
+    def set_int_at_address(self, address, value, size=2):
+        """Sets an integer at a given address of a specified size."""
+        bytes = value.to_bytes(2, byteorder=BYTE_ORDER)
+        i = 0
+        for byte in bytes:
+            self.pyboy.set_memory_value(address + i, byte)
+            i += 1


These probably belong elsewhere. Maybe on the PyBoy object itself. Are these for the user of the plugin?

Baekalfen · 2020-06-30T20:18:27Z

pyboy/plugins/game_wrapper_pokemon_red/wrapper.py

+    def set_text(self, text, address):
+        """Sets text at address.
+
+        Will always add a string terminator (80) at the end.
+        """
+        i = 0
+        for character in text:
+            try:
+                self.pyboy.set_memory_value(address + i, get_character_index(character))
+                i += 1
+            except:
+                pass
+        self.pyboy.set_memory_value(address + i, constants.STRING_TERMINATOR)
+
+    def set_rom_text(self, text, bank, address):
+        i = 0
+        for character in text:
+            try:
+                self.pyboy.override_memory_value(bank, address + i, get_character_index(character))
+                i += 1
+            except:
+                pass


These helper functions look like they should be hidden?

hexiro · 2022-09-07T12:25:09Z

This looks very good, but it hasn't been updated in a while. Do you think it would be a good idea to merge the WIP state so more people can view it and update it? If not, that's okay, I'll just clone it into my local codebase.

Baekalfen · 2022-09-07T12:34:44Z

This looks very good, but it hasn't been updated in a while. Do you think it would be a good idea to merge the WIP state so more people can view it and update it? If not, that's okay, I'll just clone it into my local codebase.

AFAIK, it's not in a complete working state, so I think it would give the wrong impression to people if we merged it. But you are more than welcome to clone it and work on it. I'll gladly merge it, if we can get it to a workable state.

hexiro · 2022-09-07T13:09:13Z

This looks very good, but it hasn't been updated in a while. Do you think it would be a good idea to merge the WIP state so more people can view it and update it? If not, that's okay, I'll just clone it into my local codebase.

AFAIK, it's not in a complete working state, so I think it would give the wrong impression to people if we merged it. But you are more than welcome to clone it and work on it. I'll gladly merge it, if we can get it to a workable state.

I can attempt to expand it
based on existing information. How much more needs to be done for it to be worthy of a merge?

Baekalfen · 2022-09-08T12:00:24Z

How much more needs to be done for it to be worthy of a merge?

Practically anything that shows a useable example. For example a proof-of-concept of doing a battle and/or navigating the world.

MaciekBaron · 2022-09-08T12:39:06Z

Hey guys, sorry for abandoning this. There's a proof of concept showing this working in my interactive Twitch app: https://github.com/MaciekBaron/poke-rb-interactive

Can help with progressing this further.

hexiro · 2022-09-08T13:22:30Z

Hey guys, sorry for abandoning this. There's a proof of concept showing this working in my interactive Twitch app: https://github.com/MaciekBaron/poke-rb-interactive

Can help with progressing this further.

This is very cool!

As for suggestion I have, I think it would be cool to have more commands to handle interactive aspects of the game.
some examples of possibilities:

battle:
active_moves() -> tuple of 1-4 moves of current mon
attack_with_move(MOVE) -> finds what move slot that move is in or errors?
attack_with_move_slot(1)
run()
bag_items()
use_item(ITEM)
is_attacking() -> enemies' mon's healthbar is being drained after attacking
is_being_attacked() -> users' mon's healthbar is being drained after being attacked

overworld:
is_facing_obstacle()
is_in_dialogue / is_in_cutscene()

These are some things that I think would make the overall experience of using the wrapper easier for the user, although all of these might not be worth the effort. If you would like, i could attempt to implement the ones that don't require reading or setting memory namely, run, use_item, attack_with_move.

let me know what you think about these suggestions!

MaciekBaron · 2022-09-08T13:44:18Z

I think those sound good!

We can also nick the constants I prepared for the other project: https://github.com/MaciekBaron/poke-rb-interactive/blob/master/pkmn/constants.py

hexiro · 2022-09-08T21:42:23Z

I think those sound good!

We can also nick the constants I prepared for the other project: https://github.com/MaciekBaron/poke-rb-interactive/blob/master/pkmn/constants.py

Quite and extensive list you've got there. Very nice! Although might I suggest making, Moves, Status, etc enums.

hexiro · 2022-09-09T00:42:19Z

after a lot of testing i've found that the memory address FFB0 - Value copied to WY at VBlank (description from https://datacrystal.romhacking.net/wiki/Pokémon_Red/Blue:RAM_map#Graphics_scroll_values)

is set to 144 when playing normally,
or it's set to 0 if things in the overworld are not moving (my best guess at what's happening).

I'm not sure the technical reason, but It appears as though one could check if the user is in some kind of dialogue with an NPC or object (like a sign) around the world if they're not in battle (can be checked more precisely) and they're not in the start menu, (again, has exact memory locations for checking this specifically)

Hopefully this information can be useful, and let me know if you know a more consistent method of checking this.

SnarkAttack · 2023-11-03T18:36:48Z

Is there any interesting in continued work on this particular pull request? Intending to do some RL on Pokemon Red and some of the features added in here would be interesting to have access to, but it's been a hot second since anyone touched this branch and I'm unsure whether I should be respecting this branch or just roll my own code in a different fork.

Baekalfen · 2023-11-06T07:57:02Z

Is there any interesting in continued work on this particular pull request? Intending to do some RL on Pokemon Red and some of the features added in here would be interesting to have access to, but it's been a hot second since anyone touched this branch and I'm unsure whether I should be respecting this branch or just roll my own code in a different fork.

If you want to restart the efforts in a new fork/PR, then that's very welcome. I don't think the original author will come back and finish this.

Once you submit a PR, we can consider if it replaces all the features in this PR. But we'll keep it here as reference until then

MaciekBaron · 2023-11-06T10:07:39Z

Sorry everyone, got really busy and didn't get to finish this. Happy for people to use the data/code from this.

SnarkAttack · 2023-11-06T14:50:52Z

Thanks for the work you did @MaciekBaron, I am using this PR to get a head start.

Pokeglitch · 2023-11-07T12:39:56Z

Is there any interesting in continued work on this particular pull request? Intending to do some RL on Pokemon Red and some of the features added in here would be interesting to have access to, but it's been a hot second since anyone touched this branch and I'm unsure whether I should be respecting this branch or just roll my own code in a different fork.

I have started a pokered plugin as well: https://github.com/Pokeglitch/PyBoyPokered

I have it separate from the "built in" game_wrapper_pokemongen1 for now, since I am using the "dynamic plugins" branch for ease of development, but incorporating it in the future should only require a few tweaks.

But I'll be happy to make this part of a group effort

Baekalfen · 2023-11-07T12:54:49Z

I have it separate from the "built in" game_wrapper_pokemongen1 for now, since I am using the "dynamic plugins" branch for ease of development, but incorporating it in the future should only require a few tweaks.

I'm glad that somebody found it. If you join on Discord and provide examples and feedback on how you use it, I might be able to merge it in soon.

EDIT:
"it" being the dynamic plugins

SnarkAttack · 2023-11-28T13:34:37Z

@Pokeglitch I'm fine if you want your branch to be the main dev branch and we cherry pick things out of mine here that we want to keep. Having the dynamic plugins working as well as the breakpoints seem like really nice core features, most of what I've done at this point is just Python classes for encapsulating data access calls and is probably easier to drag and drop to another repo.

Baekalfen · 2023-11-29T13:51:16Z

Linking this to: #233

Baekalfen reviewed Jun 30, 2020

View reviewed changes

krs013 marked this pull request as draft September 30, 2020 02:17

Maciek Baron added 2 commits November 6, 2023 08:57

Add Pokemon Red constants

4a40250

Add initial Pokemon Red wrapper code

384e644

Baekalfen force-pushed the feature/pokered branch from b1ede15 to 384e644 Compare November 6, 2023 07:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Pokemon Red plugin #176

WIP: Pokemon Red plugin #176

MaciekBaron commented Jun 27, 2020

Baekalfen left a comment

Baekalfen Jun 30, 2020

Baekalfen Jun 30, 2020

hexiro commented Sep 7, 2022

Baekalfen commented Sep 7, 2022

hexiro commented Sep 7, 2022

Baekalfen commented Sep 8, 2022

MaciekBaron commented Sep 8, 2022

hexiro commented Sep 8, 2022

MaciekBaron commented Sep 8, 2022

hexiro commented Sep 8, 2022

hexiro commented Sep 9, 2022

SnarkAttack commented Nov 3, 2023

Baekalfen commented Nov 6, 2023

MaciekBaron commented Nov 6, 2023

SnarkAttack commented Nov 6, 2023

Pokeglitch commented Nov 7, 2023

Baekalfen commented Nov 7, 2023 •

edited

SnarkAttack commented Nov 28, 2023

Baekalfen commented Nov 29, 2023

WIP: Pokemon Red plugin #176

Are you sure you want to change the base?

WIP: Pokemon Red plugin #176

Conversation

MaciekBaron commented Jun 27, 2020

TODO

Baekalfen left a comment

Choose a reason for hiding this comment

Baekalfen Jun 30, 2020

Choose a reason for hiding this comment

Baekalfen Jun 30, 2020

Choose a reason for hiding this comment

hexiro commented Sep 7, 2022

Baekalfen commented Sep 7, 2022

hexiro commented Sep 7, 2022

Baekalfen commented Sep 8, 2022

MaciekBaron commented Sep 8, 2022

hexiro commented Sep 8, 2022

MaciekBaron commented Sep 8, 2022

hexiro commented Sep 8, 2022

hexiro commented Sep 9, 2022

SnarkAttack commented Nov 3, 2023

Baekalfen commented Nov 6, 2023

MaciekBaron commented Nov 6, 2023

SnarkAttack commented Nov 6, 2023

Pokeglitch commented Nov 7, 2023

Baekalfen commented Nov 7, 2023 • edited

SnarkAttack commented Nov 28, 2023

Baekalfen commented Nov 29, 2023

Baekalfen commented Nov 7, 2023 •

edited