joaorb64 / joaorb64/TournamentStreamHelper
Idea : export the round ID when possible
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 139
- Forks
- 59
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 6
Description
Round name display has always been an issue, between localization and people just generally having different ways to call each round beyond Winner semis / loser quarters. This has led me to make multiple overlays that straight up have a hard-coded table with the names I want for each round, which is probably the best solution but would be made way easier if the program state contained the numerical ID of the round.
There are 2 ways to achieve this :
- simple way, we simply take the round ID from the start.gg request and export it. Unfortunately it means having an information that's controlled exclusively by the data provider again, with no control through the GUI, like seeds used to be. We don't really want that, but again it's the simpler solution
- more difficult : the premade round names that TSH already has (that appear in the dropdown) are each tied to a round ID, selecting one exports the corresponding round ID, BUT if the user types an arbitrary string into the input, no round ID is exported (overlays that rely on round ID should in turn do something like "if there is a round ID in the state, I use that to display one of my hard-coded round names, if there is not I use the round name text from the state directly").
This is pretty much a reminder to myself to do this when I have more time, but if someone wants to look into this ...
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the start.gg round data into the program state, then inspect how the GUI's premade and arbitrary round names are selected and exported. Compare the two proposed approaches and confirm that overlays can distinguish a selected round ID from user-entered text; done when the chosen behavior is documented and covered by the relevant state or export checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100