slyacezeta / ribbons.guide Goto Github PK

would like if you add something like Contest statts

suggested by u/Acno_Cero on Reddit

According to Reddit, contest stats carry over between games, but sheen does not. We could probably ignore sheen.

Consider allowing the editing of all fields

GitHub Pages has a server-side cache of only 10 minutes and this cannot be changed. As such, consider implementing a loading screen and loading all vital assets (UI, Ribbons, balls, current Pokemon, etc.) behind the loading screen to avoid poor user perception of site performance.

This surfaces a (rhetorical?) question: Does a fast loading screen that disappears to a ready-to-use page provide better user perception than an even faster site which sequentially paints CSS and renders images in front of the user?

• If any Gen VI+ Ribbon is added, hide the Ribbons they replace from the main display.*
• If both colors of Battle Memory or Contest Memory Ribbon are added, hide the blue Ribbon from the main display.*
• Add a check mechanic for whether a Pokémon can be safely moved to a later generation/game and not lose out on any Ribbons. Depends on #11

* Consider making the automatic hiding of Ribbons from the main display a user option.

Distinct from #17 which is about sorting in direction by a property, this is about moving a Pokémon in the unsorted list in the JSON

Summary

• Level
• Current Game
• Height
• Weight
• Language

Stats

• IVs
• EVs
• Ability
• Moveset

Memories

• Met Level
• Met Date
• Characteristic

Notes

• A text field for Notes?

Reported by Pikapal52 on Discord, see attached

This site isn't intended to be an online version of PKHeX; we don't need every possible data field a Pokemon can have. Removing some of the data fields can help downscale the site's scope so we can focus on improvements to what matters for this site.

In addition, the notes field exists specifically to allow players to write down whatever they want for each mon, including the following fields if so desired.

Consider removing the following for the respective reasons:

• IVs: difficult for most people to calculate
• EVs: easily changed at any time
• Mint: easily changed at any time, difficult to discern/remember for traded or previously-minted mons
• Ability: changes on a per-game basis as of HOME v3.0.0
• Characteristic: Gen III/IV mistranslation makes this overly complicated, and without IVs, EVs, or Mint, this serves no purpose

From Reddit:

filters for which Pokemon can go to what game. For example, if I want to filter by Sw/Sh compatibility, the list would only populate with Pokemon that can go to Sw/Sh.

It looks like the Backup JSON file is not properly formatted for the JSON format.

When entering in my Melmetal, I noticed that either the GMax form for the Pokemon or the GMax factor wasn't listed anywhere.

Japanese especially, obviously, but a modular system to allow for multiple translations would be handy. If someone has not selected a language, we could have a modal pop-up when they first enter the site and then have it also accessible from the settings modal.

• Interface (form labels, placeholders, etc.)
• Species dropdown
• Ball dropdown
• Origin Mark dropdown
• Origin Game dropdown
• Current Game dropdown
• Nature dropdown
• Title dropdown
• #43
• Mint dropdown removing per #62
• Ability dropdown removing per #62
• Characteristic dropdown removing per #62

Fulfill PWA criteria to allow Ribbons.Guide to be "installed" on any device.

It would be neat to have something like one of those trainer cards, but themed more towards info and ribbons for an RM. Something like a "profile" page?

I've seen some people already post their RM through a screenshot posted on the subreddit. for their RM, but it doesn't have all of the other interesting info.

The footer must remain visible by default to 1) confirm no affiliation with Nintendo/GF/TPCI, 2) assure users that no data is transmitted, and 3) provide a visible GitHub link. However, an option to hide the footer after seeing it would be useful for mobile users to regain some valuable screen real estate.

Now that the 3-4 contest and battle tower ribbons are auto-hidden if the Pokemon's current game is in 5 or later (which should really be 6), the hover text for the resulting Contest Memory or Battle Memory Ribbon should include a parenthetical note such as (20) or (40) to reflect what official games other than BDSP do with those, counting the number of ribbons that were folded up.

I've already added a property to those older ribbons, merge: "contest" or merge: "battle", in ribbons.js if that helps to identify the appropriate ribbons to iterate over and generate dynamic hover text.

The Add/Edit Pokémon and Filter/Sort modals especially need this, as certain dropdowns result in stretching out the form horizontally on mobile devices. A grid layout allows us to specify widths for certain elements like form labels while setting the width of form elements to "auto" with a minimum width of 0, ensuring they don't overflow the layout. Doing this would allow us to remove a lot of the mobile tricks being done to reduce these dropdowns' widths i.e. style.css#L1044

Would love to have a ribbon counter for total current obtained ribbons to make crossrefrencing easier

Add a pop-up that allows users to view a Pokémon's full details, functionally similar to their details in a main series game. This ties into #11.

From Reddit:

I'd like to be able to sort by the column names at the top

This would require a lot of development to make happen since all functions currently assume we're editing one Pokémon at a time. Which fields would we even allow for such editing? Arguments can be made for "Current Game" and "Box", but other than that... maybe if it's just these two, we could create dedicated functions to handle this instead of messing with the current edit form?

Currently, the GitHub Pages site is re-published every time a commit occurs on the main branch and it only publishes the site as is. Instead, create a workflow as follows:

• Run manually or when a commit includes special text. Maybe "updating changelog" or "changelog updated", or "site publish" or "publish site"...
• Minify CSS and JS files so we don't need to do it every time they change.
• Publish the site.
• Post an update via webhook that can be used for sending messages on places like Twitter or Discord.

The action should halt if any step fails, but this order of steps ensures that any successful steps before halting won't mess things up.

I have no idea what's possible in Actions, all of this will need research, but it would be an improvement over the current auto system.

If SV doesn't update to show Pokérus when it gets the HOME update, it may mean the end of Pokérus, making this less of a priority, but some players may still want to keep track of it on their Pokémon.

Adding or editing a Pokémon is currently done through the last row in the table. This can get unwieldy if there's a lot of rows. This is also poor UX for editing, since editing an entry near the top of the page requires moving to the bottom of the page.

• Create modular modal system (input rows with left-aligned labels, button rows... this will be important if/when making future modals)
• Migrate existing form to modal system

Inspired by Josh Lemmy#5942 on Discord, we can run into situations where we get Ribboned Pokemon from older games in trades and we see the origin mark but we don't know exactly which game they came from.

Suggested by u/UW_Unknown_Warrior

We will not add export support, as this isn't a Pokémon creator to that detail.

Files to support:

• .pk9 -- Scarlet/Violet
• .pa8 -- Legends: Arceus
• .pb8 -- Brilliant Diamond/Shining Pearl
• .pk8 -- Sword/Shield
• .pb7 -- Let's Go, Pikachu!/Eevee!
• .pk7 -- Sun/Moon/Ultra Sun/Ultra Moon
• .pk6 -- X/Y/Omega Ruby/Alpha Sapphire
• .pk5 -- Black/White/Black 2/White 2
• .pk4 -- Diamond/Pearl/Platinum/HeartGold/SoulSilver
• .pk3 -- Ruby/Sapphire/Emerald/FireRed/LeafGreen
• .ck3 -- Colosseum/XD
• .pk2 -- Gold/Silver/Crystal
• .pk1 -- Red/Blue/Green/Yellow

This would either be in the Memories section or its own section, but not in the Ribbons section since this data does not travel between games. We may also need to avoid displaying it on the main display since we don't have a lot of space and should not include them in the Ribbons area to avoid confusing people. Thanks to BrdKeeperAaron for suggesting this on Discord!

Current ideas:

• RGBYFRLGLGPE: Kanto Champion (Professor Mor)
• GSCHGSS: Johto Champion (Professor Mor)
• HGSS: Shiny Leaf and Shiny Crown (BrdKeeperAaron)
• HGSS: Pokéathlon Victor (Professor Mor)
• BWB2W2: Unova Champion (Professor Mor)
• B2W2: PokéStar Shine (BrdKeeperAaron)
• XYORASSMUSUMLGPE: Mega Evolved (Professor Mor)
• ORASBDSP: Time Travel Awards (Professor Mor)
• GO: Best Buddy "Ribbon" (BrdKeeperAaron)
• SwSh: Dynamax level (@Tyropopsicle)

Update: We're only going to track the achievements that are actually tracked by the games for the specific Pokemon. Dynamax Level isn't an achievement so we're not adding that either (and despite having 0-10 there's no point in tracking it below 10 anyway).

In German, as well as the Asian languages, the title associated with a ribbon is placed before the Pokemon's name, rather than afterward as it does in ENG/FRE/SPA/ITA. Is it worth creating an extra semantic property for each language and possibly reversing the placement of name and title if a language is set that calls for it?

Originally posted by @SadisticMystic in #20 (comment)

Consider a modal prompt when clicking "Backup" that further prompts the user for a file format. Also consider supporting TSV import/restore.

I suppose this is more of a QoL improvement than anything else.

Mobile users aren't able to search through the list of Pokemon species like PC users are able to.

The current selection feature is functional, although they can greatly benefit from a search function instead of scrolling through a long list of items.

• New item sprites (balls, mints)
• New Pokemon
• New Pokemon sprites
• New Ribbons and Marks
• New Ribbon and Mark sprites
• New abilities

Since the shutdown of Nintendo Wi-Fi, the World Ability Ribbon can only be obtained if the player is willing to go through the arduous process of connecting to insecure fan-run servers.

On mobile, multiple warnings can take up a lot of space. Always show these upon opening the guide, but allow the user to collapse them to actually be able to scroll through the ribbon list.

• Add titles to internal data
• Add title selection and storage
• Display title next to nickname below nickname similar to mints

From Firescratcher 🐗#6186 on Discord:

I thought a cool feature would be to add a catch location option! I have pokemon ribbon masters caught in cool places, and as long as the pokemon is gen 5 and up it still shows up in pokemon home! I thought it'd be a neat addition here.

Maybe clicking/tapping a Ribbon in the Ribbon Guide would show another modal on top with instructions on earning that specific Ribbon? Could/should we integrate this into the add/edit form?

Vertical card view? Some kind of condensed format for people with tons of Pokemon