Skip to content

Comments

Add external game gift encounters#1417

Open
notblisy wants to merge 8 commits intoPokeAPI:masterfrom
notblisy:gift-external-game
Open

Add external game gift encounters#1417
notblisy wants to merge 8 commits intoPokeAPI:masterfrom
notblisy:gift-external-game

Conversation

@notblisy
Copy link
Contributor

As noted in issue 1416 I thought it important to add the external game encounters from gen 3 and 4 into the API, as they're not quite the same as limited time events and don't require as much documentation and they're still receivable.

The Pokemon I am adding are:

  • Japanese Bonus Disc Celebi
  • Japanese Bonus Disc Pikachu
  • US Bonus Disc Jirachi
  • Pokemon Channel Jirachi
  • Pokemon Ranger Manaphy

To accommodate them, I added a new encounter method called gift-external-game. The idea is that this is used for anytime a pokemon spinoff or side series game can actually send a Pokemon to the main series games. There's a few encounters from pokemon battle revolution that could be added, for example.

I also had to add several new locations, which led me to understanding why this hasn't been folded into the current api yet (aside from someone wanting to do it).

The original idea was to add locations called:

  • US Colosseum Bonus Disc
  • JPN Colosseum Bonus Disc
  • Pokemon Channel
  • Pokemon Ranger

And then make encounters based on these locations. However, the Japanese Bonus Disc can actually send to any gen 3 game, and Pokemon Ranger can send to any gen 4 game.

The current encounter slot and location systems seems to require locations to have a specific region (which makes sense, why would a location be able to exist in two regions?)

So what I did was make two separate jpn-colosseun-bonus-disc locations, one labeled -hoenn and one labeled -kanto, and the same with pokemon-ranger, but for sinnoh and johto. The location areas they use remove the region names, so they wouldn't show up when making calls.

I'm also not sure if this is a huge deal, but encounter slots and encounters end up kind of looking like they have a bunch of repeat values because each Pokemon is a 100% chance to encounter and is the exact same new gift method. I didn't want to have encounters use the same encounter slots, though, even if they functionally could.

Added locations for:
JPN Bonus Disc
US Bonus Disc
Pokemon Channel
Pokemon Ranger

Added their location areas as well.

Added encounter slots and encounters for:

Bonus Disc Celebi
Bonus Disc Pikachu
Bonus Disc Jirachi
Channel Jirachi
Manaphy

added new encounter method called gift-exterrnal-game, to notify it's from an external game.
@jemarq04
Copy link
Contributor

jemarq04 commented Feb 19, 2026

I left a couple comments assuming this format would be kept, but this definitely does raise some interesting discussion points. Does Pokemon Ranger/Colossuem/etc. count as a location? I agree that these would fall under a new encounter method, but I would lean more towards some sort of catch-all location like pokemart with location areas denoting different regions, or something like that.

Can one of the maintainers weigh in with what they think?

Edit: Other than the discussion on locations, the other CSV files were added to appropriately, so format looks good!

@notblisy
Copy link
Contributor Author

I left a couple comments assuming this format would be kept, but this definitely does raise some interesting discussion points. Does Pokemon Ranger/Colossuem/etc. count as a location? I agree that these would fall under a new encounter method, but I would lean more towards some sort of catch-all location like pokemart with location areas denoting different regions, or something like that.

Can one of the maintainers weigh in with what they think?

Edit: Other than the discussion on locations, the other CSV files were added to appropriately, so format looks good!

I see, we could do method: Bonus Disc, Method Ranger, etc and then the location where you accept the Pokemon in-game. This would work and probably be a bit cleaner.

I'll wait on a maintainer to weigh in before I make a change of that scale to this PR.

Fixed location areas having extra long names and pokemon-ranger-johto has correct ID now.
@notblisy
Copy link
Contributor Author

notblisy commented Feb 20, 2026

With this comment from Phalt saying that gifts from events like at game stores are also okay to be modeled, I'll switch this up to have them all be unique methods but locations of "Pokemart" or "Pokecenter" depending on where you receive them in-game.

That makes the most sense for those types of events. I'll try to add some events as well.

A rather large update to this PR, but it's in line with what jemarq04 suggested and I think it's a cleaner way to approach this:

- gift-exterrnal-game removed as an encounter_method

- Added an encounter_method for each way you can receive a Pokemon.

Methods added:
- colosseum-bonus-disc-us
- colosseum-bonus-disc-jpn
- pokemon-channel-pal
- pokemon-ranger
- pokemon-battle-revolution
- new-york-pokecenter-wish-eggs

Currently there's no encounterr data for pokemon-battle-revolution or for new-york-pokecenter-wish-eggs, they're set up for future stuff I'll add.

After that, locations and location_areas have been changed. Most gift pokemon, be it from limited events or from external games have you receive the event in a Pokemart or pokecenter.

This change in structure will now show, celebi in RSE/FRLGs encounter data something like:

Location: hoenn-pokemart
Method: colosseum-bonus-disc-jpn

This covers the same events as before.
@notblisy
Copy link
Contributor Author

notblisy commented Feb 20, 2026

I'll share the commit message here in discussion as well:

A rather large update to this PR, but it's in line with what @jemarq04 suggested and I think it's a cleaner way to approach this:

  • gift-exterrnal-game removed as an encounter_method

  • Added an encounter_method for each way you can receive a Pokemon.

Methods added:

  • colosseum-bonus-disc-us
  • colosseum-bonus-disc-jpn
  • pokemon-channel-pal
  • pokemon-ranger
  • pokemon-battle-revolution
  • new-york-pokecenter-wish-eggs

Currently there's no encounter data for pokemon-battle-revolution or for new-york-pokecenter-wish-eggs, they're set up for future stuff I'll add.

After that, locations and location_areas have been changed. Most gift pokemon, be it from limited events or from external games have you receive the event in a Pokemart or pokecenter. So I removed the previous disc-based locations, and replaced them with:

  • kanto-pokemart
  • kanto-pokecenter
  • hoenn-pokemart
  • hoenn-pokecenter
  • johto-pokemart
  • sinnoh-pokemart

Currently kanto and hoenn pokemarts are unused locations, since most gen 3 events are received in pokecenters.

This change in structure will now show, celebi in RSE/FRLGs encounter data something like:

Location: hoenn-pokemart
Method: colosseum-bonus-disc-jpn

I'm fairly happy with how this looks, hope ya'll find it acceptable to merge!

@jemarq04
Copy link
Contributor

Other than the comment above on the encounter slots, the content itself looks accurate!

Erroneously had encounter methods for jpn bonus disc, channel, and manaphy as us bonus disc.
Copy link
Contributor

@jemarq04 jemarq04 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! I think this is a good addition to have, I hadn't realized we didn't have it in the API.
(Side note: big fan of yours, blisy lol)

@notblisy
Copy link
Contributor Author

notblisy commented Feb 20, 2026

Looks good to me! I think this is a good addition to have, I hadn't realized we didn't have it in the API. (Side note: big fan of yours, blisy lol)

Thanks! After this is merged I'll add CXD encounters and maybe some extra gifts/old events.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants