3.9 KiB
3.9 KiB
Ergogen TODO
CLI
Major
- Restructure pcb point/footprint filtering
- Use the same
what
/where
infrastructure as outlines - Collapse params/nets/anchors into a single hierarchy from the user's POV
- Add per-footprint mirror support
- Add some way for footprints to be able to "resist" the mirroring-related special treatment of negative X shift, rotation, etc.
- Use the same
- Add auto-bind
- Recursive-ize anchors
- This will potentially cause
ref
to be ambiguous, so maybe introduce a separaterefs
plural? - Plus add
orient
/rotate
towards other anchors (again, recursively)
- This will potentially cause
- Merge, generalize, and uniform-ize footprints
- Template for creating them, built-in variables they can use, documentation, external links, etc.
- Also considering how (or, on which layer) they define their silks, universal mirroring behaviour, etc.
- Rename class to designator in this context (https://en.wikipedia.org/wiki/Reference_designator#Designators)
Minor
- 3D orient for cases
- Post-process anchor for global (post-mirror!) orient/shift/rotate for everything
- Even more extreme anchor stuff
- Checkpoints, intersects, distances, weighted combinations?
- Allow both object (as well as arrays) in multiple anchor refs
- SVG input (for individual outlines, or even combinations parsed by line color, etc.)
- And once that's done, possibly even STL or other input for cases or pcb renders
- Support text silk output to PCBs (in configurable fonts, through SVG?)
- Maybe a partial markdown preprocess to support bold and italic?
- Look into gr_curve to possibly add beziers to the kicad conversion
- Support curves (arcs as well as Béziers) in polygons
- Add snappable line footprint
- Figure out a manual, but still reasonably comfortable routing method directly from the config
- Add filleting syntax with
@
? - Eeschema support for pcbs
- Generate ZMK shield from config
- Export to KLE?
- Include 3D models paths in kicad output for visualization
- Also, provide 3D models for built-in footprints
- Look into kicad 5 vs. 6 output format
- Update json schema and add syntax highlight to editors
- Support different netclasses
Patch
- Check unexpected keys at top level, too
- Better error handling for the fillet option?
- Integration and end2end tests to get coverage to 100%
- Add custom fillet implementation that considers line-line connections only?
WEBUI
Major
- Change over to Cache's live preview implementation
- Add missing KLE functionality
- Create browserified version of semver lib
- Or at least a shim with a console warning
- Visualizing multiple outlines at once, with different colors
Minor
- Propagate log output from the ergogen module
- Attempt to auto-compile (if inactive for n secs, or whatever)
- Support saving to gists
- Add kicad_pcb visualization as well
- Get dropdown examples from a separate repo
- Expand the config dropdown with opensource stuff: corne, lily, ergodox, atreus...
Patch
- Streamline (and document) an update pipeline
- Add puppeteer tests
DOCS
- n00b tutorials
- With a progression of increasingly complex steps
- And lots of illustrations!
- Complete reference
- Some known deficiencies:
- Units separated to their own block at the front
- Key-level
width
andheight
are supported during visualization - This key-level example should probably be added from discord:
7731040935
- Change outline fields to have their full anchor support documented
- Mention the ability to opt out of gluing!
- Key-level defaults are based around u's, not 19!
- Some known deficiencies:
- Contribution guidelines
- Include test commands (npm test, npm run coverage, --what switch, --dump switch)
- Changelog, Roadmap
- A public catalog of real-life ergogen configs
- Probably could be the same as the separate examples repo for the dropdown