Feature/update docs (#6)

Do some changes to README.md, CREDITS.md and the screenshots
This commit is contained in:
Philippe Symons
2024-08-27 20:23:29 +02:00
committed by GitHub
parent b87b1ac093
commit bcf71ef421
9 changed files with 10 additions and 9 deletions

View File

@@ -12,7 +12,9 @@ Furthermore I like to develop the developers of the [libdragon](https://github.c
Thanks to the [PkHex](https://github.com/kwsch/PKHeX) project as well, because its code was useful to me to get the event flag offsets for G/S/C games and figure out the GS ball event flags. I may also use their codebase as a reference in the future in order to try to support the gen 1/2 games in other languages.
I'd also like to extend my thanks to "[The Gears of Progress](https://github.com/GearsProgress)", [LJ Birdman](https://x.com/LJSTAR_), [LuigiTKO](https://x.com/LuigiTKO), [GuiAbel](https://x.com/guiabel/) and [SourApple](https://github.com/SoupPotato) of the [Poke Transporter GB](https://github.com/GearsProgress/Poke_Transporter_GB) project for allowing me to use their logo and even create the Fennel picture asset for this project. It looks amazing, you guys! Much better than anything I could've created!
And of course I'd like to extend my thanks to everyone else in the pokémunity who wrote documentation or code for these old pokémon games.
I've listed the specific resources I used for reading the rom/save game data in the CREDITS.md file of the libpokemegb project.

View File

@@ -4,9 +4,9 @@ This project lets you acquire past Distribution Event Pokémon in Gen1/Gen2 Pok
The rom is based on [libpokemegb](https://github.com/risingPhil/libpokemegb) and [libdragon](https://github.com/DragonMinded/libdragon).
![Screenshot 1](docs/images/screen1.png)![Screenshot 2](docs/images/screen2.png)![Screenshot 3](docs/images/screen3.png)
![Screenshot 1](docs/images/screen1.png)![Screenshot 2](docs/images/screen2.png)![Screenshot 3](docs/images/screen3.png)![Screenshot 4](docs/images/screen4.png)![Screenshot 5](docs/images/screen5.png)![Screenshot 6](docs/images/screen6.png)![Screenshot 7](docs/images/screen7.png)
Right now the UI is extremely barebones. I aim to improve this in future versions.
Right now the UI is still barebones. I aim to improve this in future versions.
I'm happy to accept pull requests if the community wants to do them.
@@ -16,6 +16,7 @@ I'm happy to accept pull requests if the community wants to do them.
- Inject GS Ball into an actual Pokémon Crystal gameboy cartridge
- Teach Pikachu Surf/Fly on Gen 1 cartridges
- You don't have to use the transfer pak in controller 1. You can have it in a separate controller if you want. But the UI is still controlled with controller 1.
- Unlock Mystery Gift decorations like the Pikachu Bed and Tentacool Doll that were left inaccessible in Gold/Silver/Crystal due to bugs in Pokemon Stadium 2 (suggested by /u/MermaidRaccoon on reddit)
# Limitations
- Right now, this rom only supports the international (English) versions of the games.
@@ -50,16 +51,12 @@ But having it done with a Nintendo 64 feels more "real"/"official" and is easier
# Future potential improvements (ideas/roadmap)
## UI ideas
- Make the initial transfer pack detect screen show the gameboy cartridge image of the game that was detected and some kind of icon when there's an error.
- Add stats screen after receiving the pokémon which shows the original gameboy sprite but without the white background.
- In the pokémon list, show the mini menu sprite that you would also see in the party menu in the gameboy games
- add some background images and potentially sprites here and there.
- add some acquisition sound effects from the gameboy games
- add a skippable "trade" 3D animation sequence when you receive a distribution pokémon. The idea is to have a pokéball go into a green mario pipe on either a Nintendo 64 3D model or Nintendo 64 3D logo model. Then follow the pipe with the camera and have the pokéball drop onto a huge 3D representation of the gameboy cartridge before opening the pokéball which then triggers the stats screen.
- Have a 3D intro animation that shows a pokeball opening, a Nintendo 64 logo appearing, slightly jumping and playing the "NINTENDO sixtyfoouuuuuuuuur" meme sound
- Add a menu item to let you buy missing version exclusive pokémon from other versions of the generation with in-game currency. (such as Mankey for Blue or Vulpix for Red). The original games are getting expensive, so this would be a good help for people who can only afford/are willing to buy/play a single game for the generation.
- Add Credits screen
- Add a menu item that informs you about the existence of [Poke Transporter GB](https://github.com/GearsProgress/Poke_Transporter_GB) for transferring to Gen3
- Add some background music (Creative commons remakes/remixes of the original music (Maybe a looped chunk of [Ramstar - Route 24](https://www.youtube.com/watch?v=ih53Nb34vbM)?)
- Have a "music" widget that shows up to name the song(s) that I end up using when it/they start(s) playing. (similar to how [Need For Speed - Most Wanted (original)](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhWk37230YvbMHaMchN8dzQiRrO66VofThpcbvUTFMoplDbkQKBVUFcIabbNCnzZ0KpuxcAQmrXQjBlqv_bvi6v6xpjmPxs3tJ-ZI_GhOn3xe5DW7XpMbtnCKFcbBQ-l_zzbrIIV4smBpth/s1600/_mwmusic.jpg) used to show this)
@@ -68,15 +65,17 @@ But having it done with a Nintendo 64 feels more "real"/"official" and is easier
- Support other language versions (in libpokemegb)
- Make it possible to backup your cartridge save file onto the flashcart PokeMe64 is running from.
- Make it possible to display your cartridge save file as a QR code and contribute to the 3DS' [PKSM](https://github.com/FlagBrew/PKSM) project to migrate the save file easily from gameboy cartridge to 3DS.
- Unlock Mystery Gift decorations like the Pikachu Bed and Tentacool Doll that were left inaccessible in Gold/Silver/Crystal due to bugs in Pokemon Stadium 2 (suggested by /u/MermaidRaccoon on reddit)
- Make it possible to swap gameboy cartridge after using the reset button on the N64. (suggested by /u/bluemooncinco on reddit)
I'm likely going to postpone the 3D stuff (intro and "trade" sequence) until I have implemented a lot of the other ideas here.
Originally I had the idea of showing a professor character in the rom. But then I found out on YouTube that GearsProgress recently released the "Poke transporter GB" which did the exact same thing. So I'm not sure about that idea anymore. Then again, maybe it could be an option to have some lore that these professors would know eachother. Right now this remains unimplemented though.
Maybe at some point I might introduce a professor character in PokeMe64. I originally had this idea when starting the project, but when I discovered the existence of the Poke Transporter GB project by GearsProgress, I kinda let that go.
Anyway, how many of these ideas actually get implemented kinda depends on how quickly I get burned out of the project. We'll see how far we get.
# Credits
You can find the Credits and special thanks section here: [Credits](CREDITS.md)
# Help wanted
Hi! I would very much like some people to join the project and add some sprites/graphics design to this rom. I'm not asking you to edit the code for those things. But I don't exactly have the skillset to
effectively design images or create music.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 14 KiB

BIN
docs/images/screen4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

BIN
docs/images/screen5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

BIN
docs/images/screen6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

BIN
docs/images/screen7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB