Handle game configuration more dynamically
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reading the per-game classes in VisualPinball.Engine.PinMAME/Games and the registration and dropdown logic around line 65 of VisualPinball.Engine.PinMAME.Unity/Editor/PinMameGamelogicEngineInspector.cs. Done means both the non-Unity solution and Unity package can load JSON game data with inheritance, support the listed metadata and mappings, and provide searchable game selection.
Written by the indexing model from the issue text.
Description
Right now, for every game, we create a class here and register them here. This is sub-optimal, because this configuration needs to be compiled, and it sits outside of Unity, so it needs to be compiled manually on every change.
A better approach would be to serialize the data as JSON and add the possibility to load them from anywhere. Since at some point there will be many games, the existing drop-down should be replaced by a more user-friendly search field.
The data should be the following:
- Metadata about the game
- Name
- ID (short name, but unique)
- Year
- Manufacturer
- IPDB Number
- Available ROMs
- ROM ID (name of the zip file of the ROM)
- Version (readable name of the ROM)
- Description (optional notes)
- Aliases (common items that we globally identify by name)
- Switches
- Lamps
- Coils
Depending on the game's system, some configurations are identical across multiple games. Thus, there should be a way of inheriting data, where a config can extend another, overriding existing values.
We need to be smart about how to set this up. The long-term goal is that if a table author works on a game that hasn't got a configuration yet, it can be easily created in the editor, and at some point submitted back to the repository for other authors to use.
Note that this issue applies to both the non-Unity .sln solution as well as the Unity-specific package.
- Dominant language
- C#
- Stars
- 4
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
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.
More from VisualPinball/VisualPinball.Engine.PinMAME
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
VisualPinball/VisualPinball.Engine.PinMAME#4 · 1 comment ·
All issues in VisualPinball/VisualPinball.Engine.PinMAME
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·