TASEmulators / TASEmulators/BizHawk
Move profiles to individual files shipped with BizHawk
Open
Nobody has claimed this yet.
App: EmuHawk
Meta
Request: Feature/Enhancement
- Dominant language
- C#
- Stars
- 2.8k
- Forks
- 468
- PR merge metrics
- No merged PRs in 30d
Description
Benefits:
- Easier for potential contributors to send PRs
- Opens the possibility of custom profiles made for e.g. a particular speedrunning community
- May be easier to spot inconsistencies, compared to hardcoded
Downsides:
- More files in BizHawk folder (I suggest we put them in a subdir and move
defctrl.jsonthere too)- See also https://github.com/TASEmulators/BizHawk/issues/2544#issuecomment-753616456 re: these defaults files being deleted
- Will lose static type checking from being hardcoded, and therefore may be forgotten when someone changes a schema
Contributor guide
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
Locate the hardcoded profiles and defctrl.json, then inspect how their schema and static type checking are currently enforced. Compare the proposed subdirectory layout with the concern about shipped defaults being deleted. Done would mean agreeing on an individual-file layout and preserving or deliberately addressing schema consistency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100