Files
GameList/FAQ.md

56 lines
6.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# FAQ & Tips
Pick'n'Play helps a small group collect game ideas, score them, and reveal a ranked list without endless back-and-forth. Everything below is written in plain language and reflects the exact rules the backend enforces.
## Accounts & login
- **How do I create an account?** Register with a unique username (max 24 characters), a password, and a display name (max 16 characters). The display name is required because it is shown beside every suggestion and score.
- **Do I need admin powers?** If you were provided with an admin key, enter it during registration. If the key is wrong the request is rejected; there is no way to “upgrade” yourself later without reregistering with the correct key.
- **Can I change my display name later?** No. Pick it during registration and keep it; there is no UI or API to change it afterward. (Only legacy accounts that somehow lost a name are auto-filled from the username on next login.)
## Phases at a glance
- **Personal phases.** Each player tracks their own position (Suggest → Vote → Results). Clicking “Next” moves you forward; admins can move themselves backward. Moving forward always clears any “finalized” vote flag.
- **Results gate.** You cannot enter Results until an admin opens them. When Results are opened, everyone is pushed to Results automatically. When Results are closed, everyone returns to Vote and all ballots are unfinalized so people can adjust scores again.
## Suggesting games
- **How many can I add?** Up to 5 suggestions per player while you are in the Suggest phase. An admin-granted joker lets you add one extra game during Vote (see below).
- **Required fields and limits.** Name is required (max 100 characters). Genre (50), description (500), and links (URLs up to 2048) are optional. Min/max players must both be provided or both left empty; values must be between 1 and 32 with min ≤ max.
- **Image rules.** Screenshot URLs must be http/https, end with an image extension (png, jpg, jpeg, gif, webp, avif), be publicly reachable within ~3 seconds, avoid redirects, and be under 5 MB. Links to local/private hosts are rejected for safety. If you omit a screenshot, thats fine.
- **Other links.** Game and YouTube links must be http or https; any other scheme is rejected.
- **What can I edit?** In Suggest you may edit any field. In Vote you may edit everything except the name (it stays locked). In Results nothing is editable. Admins can edit any suggestion at any time.
- **Deleting a suggestion.** You can delete your own suggestions while you are still in Suggest. Admins can delete any suggestion at any time. Deleting also removes its votes and breaks any duplicate links so nobody is stuck with orphaned data.
- **Why was my suggestion blocked?** Common reasons: no display name at registration, already at the 5-limit and no joker, name too long/empty, invalid or unreachable screenshot, min/max players missing or out of order, or trying to add while in the wrong phase.
## Jokers (late additions)
- **What is a joker?** A one-time extra suggestion slot that only works while you are in the Vote phase. An admin must grant it to you.
- **How it works.** When you use the joker to add a game, the joker is consumed immediately, your ballot is unfinalized, and every player is also unfinalized so the new game can be scored. Admins can grant another joker later if needed.
## Voting
- **Who can vote?** Only authenticated players in the Vote phase. Because display names are fixed at registration, there is no “set name first” step during voting.
- **How to score.** Use the slider to pick a whole number from 0 to 10. Anything outside that range is rejected.
- **Linked duplicates.** If an admin linked duplicate games, changing the score on one updates all linked siblings automatically. Scores are stored per linked group, not per individual card.
- **Finalizing.** Toggling “Finalize” locks your scores so you cannot change them. Toggle it off to edit again. Finalize is only available in Vote; it is cleared automatically if a joker adds a new game, if an admin links/unlinks games, or if results are closed and you are sent back to Vote.
- **Voting after changes.** When new games appear or links change, your previous votes for the affected group are cleared and you are unfinalized. Check your list and rescore everything before finalizing again.
## Results
- **When do results show?** Only after an admin opens them. Once open, everyone moves to the Results phase automatically.
- **What you see.** A leaderboard with averages, totals, vote counts, your own score, min/max players, and any links or media for each game. Linked games list their siblings so you can see which entries were merged.
- **Can I change anything here?** No. Suggestions and votes are read-only in Results. Admins must close results (which returns everyone to Vote) or use admin tools to make changes.
## Admin tools (for hosts)
- Open or close results; closing results moves everyone back to Vote and clears finalize flags.
- Grant jokers during Vote; granting one also clears that players finalize flag.
- Link or unlink duplicate suggestions during Vote; this clears votes for the affected group and unfinalizes impacted players.
- View vote readiness to see who has finalized.
- Delete a player (also deletes their suggestions and votes, and unlinks anything pointing to them).
- Reset (clears suggestions and votes, keeps players, resets phases to Suggest, closes results). Factory reset wipes everything and reseeds a fresh app state.
- Move yourself backward a phase if you need to adjust your own suggestions.
## Common errors and how to fix them
- **“This endpoint is available in the X phase.”** You are in the wrong phase. Advance with “Next” or ask an admin to move you back.
- **“Screenshot URL must be http(s) and end with an image file extension.”** Fix the extension and make sure it is a direct link, not a page or redirect, and the file is smaller than 5 MB.
- **“You have reached the 5 suggestion limit.”** Wait for Vote and request a joker if you need to add more.
- **Admin key errors.** If you see “Invalid admin key,” register again with the correct key provided by the host, or leave it empty to create a non-admin account.
## Data and privacy
- Suggestions, votes, and phases live in a shared SQLite database. Logging out clears your auth cookie; deleting your player (admin action) also removes your suggestions and votes.