Add extensible component inspectors to DevTools
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
Research direction
Start by reviewing the smaller inspector issues and the connector registered through DevToolsService.registerConnector in flame_behavior_tree. Read doc/flame/other/debug.md for the existing debugging context. Done means the inspector API and JSON format are documented, a custom inspector can add a section without changing flame_devtools, read-only properties remain uneditable, and a throwing inspector does not break the panel.
Written by the indexing model from the issue text.
Description
Problem to solve
The fields in the DevTools extension are hardcoded for a few component types. Games and bridge packages can't show their own properties, so each new type needs changes to both flame and flame_devtools.
Proposal
Add a data-driven inspector API, where the game describes each component's properties and the extension renders them generically.
- A game-side inspector takes a
Componentand returns a titled section, or nothing if it doesn't apply. Sections appear in order. - Each property has a label, type, current value, optional description, and whether it is editable. Types should cover at least double, int, bool, string,
Vector2andAnchor. Doubles can also have a step, min and max. - Getters and setters are closures, so they stay in the game. Only the description goes to the extension as JSON. Writes come back by section and property name.
- Packages register inspectors through
DevToolsService.registerConnector, likeflame_behavior_treedoes for its connector.
Acceptance criteria
- The JSON format is documented.
- A custom inspector can add a section without changing
flame_devtools. - Read-only properties can't be edited.
- An inspector that throws doesn't break the rest of the panel.
- The built-in fields are moved to the new API, or a follow-up issue covers that.
- The API is documented in
doc/flame/other/debug.md.
More information
Part of the work to move the flame_studio debugging features to flame_devtools. This is best done after the smaller inspector issues, so the design covers the real cases.
- Dominant language
- Dart
- Stars
- 10.8k
- Forks
- 1.1k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 61
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from flame-engine/flame
-
Timer with tickCount stays finished after start() or reset()Possibly taken @matthewalberto claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
flame-engine/flame#4240 · 1 comment ·
Maintainers usually reply within 1 day
-
`CameraComponent.follow` follows the local position of a nested targetPossibly taken @ufrshubham claimed this today. Openbug
flame-engine/flame#4238 · 1 assignee ·
Maintainers usually reply within 1 day
-
`ComponentPool` returns components to the pool while they are still in use, and loses components removed before mountingPossibly taken @ufrshubham claimed this 18 days ago. Openbug
flame-engine/flame#4191 · 1 assignee ·
Maintainers usually reply within 1 day
-
Move the flame_studio debugging features to flame_devtoolsPossibly taken A pull request linked to this issue is open or already merged. Openenhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
flame-engine/flame#4176 ·
Maintainers usually reply within 1 day
-
discussion enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
flame-engine/flame#4175 ·
Maintainers usually reply within 1 day
All issues in flame-engine/flame
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
spotiflacapp/SpotiFLAC-Mobile#935 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
chriskelly/wish-together#193 ·
Maintainers usually reply within 1 day
-
area: player feature request
Difficulty 2/5 1-3 hours Newbie friendliness 65/100