Adding Ribbons and Marks

[ItsMeJoji]

Hi,

I wanted to work on adding in the sprites for Ribbons and Marks into the API.

Before starting, is there any sort of name formatting I need to be aware of for pngs?

I planned to make a new folder to hold them ..sprites\ribbons_marks\ and formatting as earth-ribbon.png, partner-mark.png, etc.

[Naramsim]

Hi! Are you planning to add the resource also to the API? If the ribbons and marks are limited to a specific version of the the game, I'd put the into a folder with that generation's name. Second, marks and ribbons are different? I see that the term mark is introduced in swsh? and the later re-used in scvi?

[ItsMeJoji]

Hi! Are you planning to add the resource also to the API?

I'd like to be able to call the images via the API, yes. Haven't dug into it as to how it maps sprites normally.

If the ribbons and marks are limited to a specific version of the the game, I'd put the into a folder with that generation's name.

A good majority of them are tied to specific version, but a few reappear in later generations (ie. Effort Ribbon, Master Rank Ribbon, Daily Ribbons, etc.) so I might need figure out the best way to handle if they are available across generations.

Second, marks and ribbons are different? I see that the term mark is introduced in swsh? and the later re-used in scvi?

From a code sense, probably no. They work the same way. But there is still a distinction between the two.

[FallenDeity]

ribbons and marks are two different things right shouldnt they go under different categories afaik ribbons are for achievements or special events while marks are more oriented towards unique features or traits of the pokemon like time met/caught, size etc

also iirc ribbons have been around for way longer than marks which was pretty recent gen 8 iirc

functionally both seem to be the same both add a flavor text when u send a pokemon to battle and I think as such bulbapedia also says this

Due to marks and Ribbons being treated as the same mechanic internally, they are stored in the same index table. As a result, the index values for marks do not begin at 0 or 1, and are non-sequential. Currently they occupy index values 53-97, 101-105, and 107-109, with the index values prior to 53 and in-between mark index values being occupied by Ribbons instead

so it seems like the ids are unified across marks and ribbons but method of acquisition and concepts around it are different while functionally they are the same. I dont think using the index is the right idea since it might shift across games if new ribbons or marks are added

its also not that simple right
https://bulbapedia.bulbagarden.net/wiki/List_of_Ribbons_in_the_games

for example hoenn champion ribbon is shared across all gens even when trading so this is a shared asset for later generations while the contest and tower ribbons have some segregation in terms of shared assets, some are only 3, 4, 5 gen and then 6 onwards another shared set, would it make more sense to divide the folders category wise and then handle logic on the pokeapi code side based on these categories I think we should first figure out the nuances where these assets are available or shared across which gens

[ItsMeJoji]

Besides knowing which ribbon/mark comes from what generation, we'll also need to take into account when a ribbon/mark becomes obtainable in more than one generation with future releases.

Here's a list I've compiled of ribbon and marks based on their Generation exclusivity. This doesn't include any Ribbons that were removed/replaced later on. (https://bulbapedia.bulbagarden.net/wiki/List_of_Ribbons_in_the_games/Deprecated_Ribbons)

• Gen 3 Exclusive:

  • National Ribbon
  • Earth Ribbon
  • Champion Ribbon
  • Cool Ribbons (Base, Super, Hyper, and Master)
  • Beauty Ribbons (Base, Super, Hyper, and Master)
  • Cute Ribbons (Base, Super, Hyper, and Master)
  • Smart Ribbons (Base, Super, Hyper, and Master)
  • Tough Ribbons (Base, Super, Hyper, and Master)
  • Battle Tower Ribbons (Winning and Victory)
  • Artist Ribbon
  • World Ribbon

• Gen 4 Exclusive:

  • Sinnoh Champion Ribbon
  • Cool Ribbons (Base, Great, Ultra, and Master)
  • Beauty Ribbons (Base, Great, Ultra, and Master)
  • Cute Ribbons (Base, Great, Ultra, and Master)
  • Smart Ribbons (Base, Great, Ultra, and Master)
  • Tough Ribbons (Base, Great, Ultra, and Master)
  • Battle Tower Ribbons (Ability, Great Ability, Double Ability, Multi Ability, Pair Ability, World Ability)
  • Legend Ribbon
  • Record Ribbon (never made available)

• Gen 5 Exclusive:

  • Regional Champion Ribbon (actually never released)
  • National Champion Ribbon (same as above)

• Gen 6 Exclusive:

  • Battle Memory Ribbon (2 Versions)
  • Contest Memory Ribbon (2 Versions)
  • Kalos Champion Ribbon
  • Training Ribbon
  • Skillful Battler Ribbon
  • Expert Battler Ribbon
  • Hoenn Champion Ribbon

• Gen 7 Exclusive:

  • Alola Champion Ribbon
  • Battle Royal Master Ribbon
  • Battle Tree Great Ribbon
  • Battle Tree Master Ribbon

• Gen 8 Exclusive:

  • Galar Champion Ribbon
  • Tower Master Ribbon
  • Twinkling Star Ribbon
  • Hisui Ribbon
  • Fishing Mark
  • Curry Mark
  • Dry Mark

• Gen 9 Exclusive:

  • Paldea Champion Ribbon
  • Gourmand Mark
  • Itemfilder Mark
  • Partner Mark
  • Mini Mark
  • Jumbo Mark
  • Titan Mark
  • Alpha Mark
  • Mightiest Mark
  • Once-in-a-Lifetime Ribbon (unobtainable due to obtaining code never being implemented)
  • Partner Ribbon (Exclusive to certain in-game trades and Event Distributions)

• Multi-Gen:

  • Effort Ribbon
  • Footprint Ribbon
  • Daily Ribbons (Alert, Shock, Downcast, Careless, Relax, Snooze, Smile)
  • Money Ribbons (Gorgeous, Royal, Gorgeous Royal)
  • Contest Ribbons (Coolness Master, Beauty Master, Cuteness Master, Cleverness Master, Toughness Master, Contest Star)
  • Best Friends Ribbon
  • Master Rank Ribbon
  • Lunchtime Mark
  • Sleepy-Time Mark
  • Dusk MArk
  • Dawn Mark
  • Cloudy Mark
  • Rainy Mark
  • Stormy Mark
  • Snowy Mark
  • Blizzard Mark
  • Sandstorm Mark
  • Misty Mark
  • Destiny Mark
  • Uncommon Mark
  • Rare Mark
  • Rowdy Mark
  • Absent-Minded Mark
  • Jittery Mark
  • Excited Mark
  • Charismatic Mark
  • Calmness Mark
  • Intense Mark
  • Zoned-Out Mark
  • Joyful Mark
  • Smiley Mark
  • Teary Mark
  • Upbeat Mark
  • Peeved Mark
  • Intellectual Mark
  • Ferocious Mark
  • Crafty Mark
  • Scowling Mark
  • Kindly Mark
  • Flustered Mark
  • Pumped-Up Mark
  • Zero Energy Mark
  • Prideful Mark
  • Unsure Mark
  • Humble Mark
  • Thorny Mark
  • Vigor Mark
  • Slump Mark
  • Country Ribbon
  • Classic Ribbon
  • Premier Ribbon
  • Event Ribbon
  • Birthday Ribbon
  • Special Ribbon
  • Souvenir Ribbon
  • Wishing Ribbon
  • Battle Champion Ribbon
  • World Champion Ribbon (an odd one since it was introduced in gen 5, but given out only once in Gen 7)

We could split these by generation, plus a multi-generation folder, and if or when some generation-specific ribbons become available in later games, we move that data to the given folder.

As for IDs, we might have to make use of composite IDs. possibly relying on the generation of introduction, whether mark or ribbon, and then lowercase version of the ribbon name. So something like mark-9-partner-mark.