Metroid ii wrapper #362
Open
Metroid ii wrapper #362
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…figure out why the values are diff from in game
…o calculate things like health, and possibly add a more human readable upgrade field rather than just using the games constants
Baekalfen
requested changes
Feb 8, 2025
|
|
||
|
|
||
| cdef class GameWrapperMetroidII(PyBoyGameWrapper): | ||
| cdef readonly int _game_over |
There was a problem hiding this comment.
readonly makes it available on the API. No need to have this, when we have the game_over method as well.
|
|
||
| def __init__(self, *args, **kwargs): | ||
| self._game_over = False | ||
| # may need to change game area section. Copied from the kirby code |
There was a problem hiding this comment.
Can you check out what the game area should be?
Comment on lines
37
to
43
| # Access RAM for a ton of information about the game | ||
| # I'm getting all of the values from datacrystal | ||
| # https://datacrystal.tcrf.net/wiki/Metroid_II:_Return_of_Samus/RAM_map | ||
| # I've skipped some of the values like music related ones | ||
|
|
||
| # Constants from decomp project | ||
| # https://github.com/alex-west/M2RoS/blob/main/SRC/constants.asm |
There was a problem hiding this comment.
Maybe condense this down to:
# RAM addresses and constants sourced from:
# https://datacrystal.tcrf.net/wiki/Metroid_II:_Return_of_Samus/RAM_map
# https://github.com/alex-west/M2RoS/blob/main/SRC/constants.asm
Comment on lines
47
to
49
| # this could be done much faster by checking health | ||
| # There's a death animation so the extra few seconds over thousands of | ||
| # runs *could* add up? |
There was a problem hiding this comment.
Then shouldn't we use this method instead?
Comment on lines
55
to
59
| # X position within area (pixels/screen) | ||
| self.x_pos_pixels = self.pyboy.memory[0xD027] | ||
| self.y_pos_pixels = self.pyboy.memory[0xD029] | ||
| self.x_pos_area = self.pyboy.memory[0xD028] | ||
| self.y_pos_area = self.pyboy.memory[0xD02A] |
There was a problem hiding this comment.
What's the difference between "pixels" and "area"?
| Kwargs: | ||
| * timer_div (int): Replace timer's DIV register with this value. Use `None` to randomize. | ||
| """ | ||
| # TODO implement me, I don't know if I really need to do anything here? |
There was a problem hiding this comment.
Should be fine as is. We can remove the comment
| def __init__(self, *args, **kwargs): | ||
| self._game_over = False | ||
| # may need to change game area section. Copied from the kirby code | ||
| super().__init__(*args, game_area_section=(0, 0, 20, 16), game_area_follow_scxy=True, **kwargs) |
There was a problem hiding this comment.
Could you add all the attributes you've added here and give them a default value? And underneath each attribute add a docstring?
Comment on lines
+132
to
+151
| ```text | ||
| 0 1 2 3 4 5 6 7 8 9 | ||
| ____________________________________________________________________________________ | ||
| 0 | 383 383 383 301 383 383 383 297 383 383 383 301 383 383 383 297 383 383 383 293 | ||
| 1 | 383 383 383 383 300 294 295 296 383 383 383 383 300 294 295 296 383 383 299 383 | ||
| 2 | 311 318 319 320 383 383 383 383 383 383 383 383 383 383 383 383 383 301 383 383 | ||
| 3 | 383 383 383 321 322 383 383 383 383 383 383 383 383 383 383 383 383 383 300 294 | ||
| 4 | 383 383 383 383 323 290 291 383 383 383 313 312 311 318 319 320 383 290 291 383 | ||
| 5 | 383 383 383 383 324 383 383 383 383 315 314 383 383 383 383 321 322 383 383 383 | ||
| 6 | 383 383 383 383 324 293 292 383 383 316 383 383 383 383 383 383 323 383 383 383 | ||
| 7 | 383 383 383 383 324 383 383 298 383 317 383 383 383 383 383 383 324 383 383 383 | ||
| 8 | 319 320 383 383 324 383 383 297 383 317 383 383 383 152 140 383 324 383 383 307 | ||
| 9 | 383 321 322 383 324 294 295 296 383 325 383 383 383 383 383 383 326 272 274 309 | ||
| 10 | 383 383 323 383 326 383 383 383 2 18 383 330 331 331 331 331 331 331 331 331 | ||
| 11 | 274 383 324 272 274 272 274 272 274 272 274 334 328 328 328 328 328 328 328 328 | ||
| 12 | 331 331 331 331 331 331 331 331 331 331 331 328 328 328 328 328 328 328 328 328 | ||
| 13 | 328 328 328 277 278 328 328 328 328 328 328 328 328 277 278 328 328 277 278 277 | ||
| 14 | 328 277 278 279 281 277 278 328 328 277 278 277 278 279 281 277 278 279 281 279 | ||
| 15 | 278 279 281 280 282 279 281 277 278 279 281 279 281 280 282 279 281 280 282 280 | ||
| ``` |
There was a problem hiding this comment.
Remember to update this view, as this is copied from Kirby.
Even better, you can make it a test as in the Super Mario Land wrapper (without the mapping):
>>> pyboy = PyBoy(supermarioland_rom)
>>> pyboy.game_wrapper.start_game()
>>> pyboy.game_wrapper.game_area_mapping(pyboy.game_wrapper.mapping_compressed, 0)
>>> pyboy.game_wrapper.game_area()
array([[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 13, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 14, 14, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 14, 14, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10],
[10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10]], dtype=uint32)| # yapf: disable | ||
| return ( | ||
| f"Metroid II:\n" + | ||
| # TODO add relevant variables to print for debugging purposes |
There was a problem hiding this comment.
Please add the attributes you find relevant
Comment on lines
184
to
189
| # I don't like seeing the huge grid whne trying to develop | ||
| # The sprite list can be messy too, since many things (especially | ||
| # samus) are composed of multiple sprites, so simply running causes | ||
| # the output to constantly change "shape", making it very difficult | ||
| # to read | ||
| # super().__repr__() |
There was a problem hiding this comment.
Although I understand, please add it back in, so each game wrapper follows the same structure.
…ver check, pixels vs area difference, check difference between displayed/current hp/missiles, verify hp calculation equations commented out, game initialzation ticks could be shrunk, view needs updating. Mostly functional/api changes for this commit
Rebasing after large update to main, only really impacted manager and manager_gen
…figure out why the values are diff from in game
…o calculate things like health, and possibly add a more human readable upgrade field rather than just using the games constants
…ver check, pixels vs area difference, check difference between displayed/current hp/missiles, verify hp calculation equations commented out, game initialzation ticks could be shrunk, view needs updating. Mostly functional/api changes for this commit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Metroid II wrapper.
Most of the essential things are there, and I can make as many changes as needed, but this should have the core functionality. The RAM mapping values were taken from Datacrystal's RAM mappings and they all seem to be valid from my testing. I only implemented the ones that seemed relevant for AI purposes. (I skipped weird music timers and pause flags.