This release:
- Contains breaking changes!
- It restructures the library - as described in #223 - making it compatible with the KiCad PCM
- The major changes are:
- The
Symbolsfolder has been renamedsymbols - The
Footprintsfolder has been renamedfootprints - The 3D models have moved from the
footprintsfolder to3dmodels/Capacitor.3dshapes,3dmodels/Resistor.3dshapes, etc.
- During the release process, two zip file Assets are created and attached to the release
- The with-pcm zip file contains self-consistent symbols and footprints. The footprint paths include the default
PCM_Library nickname prefix. If you are installing via the PCM, this is the version which is installed. - The without-pcm zip file contains self-consistent symbols and footprints without the
PCM_prefix. If you have cleared the Library nickname prefix in the Preferences, you need to install the without-pcm zip file manually using the PCM "Install from File..." option. The installation instructions contain more detail. - Internally, these libraries use an Environmental Variable named
SPARKFUN_KICAD_LIBRARYto reference the footprints and 3D models. This is converted intoKICAD9_3RD_PARTYduring the release process. The release zip file Assets useKICAD9_3RD_PARTYpaths. At SparkFun, we use the library as-is with the originalSPARKFUN_KICAD_LIBRARYenvironmental variable paths. Our open-source KiCad designs will contain those same environmental variable paths. If you want to be able to edit existing SparkFun schematics and board designs directly, rather than just make use of our components, you need to manually install a true copy or clone of the library. The installation instructions provide more detail here and here.
- The with-pcm zip file contains self-consistent symbols and footprints. The footprint paths include the default
- Users at SparkFun will need to update their symbol and footprint paths, by deleting the current libraries and selecting the new ones with the modified paths. This issue comment provides more detail on the reason for the change.
- Timeline:
- Step 1: the changes have now been merged into the
mainbranch - Step 2: the
build_asset_releaseworkflow will run imminently and will attach the zip file Assets to release v9.0.0 - Step 3: we will submit a PR to the KiCad Package Metadata on GitLab, adding our metadata with SHA checksum etc.. If KiCad are happy with the submission, the metadata will be added and the library will be available via the PCM as described above. It may take KiCad a few days to respond to the Pull Request. If all goes well, the libraries should appear in the PCM by October 24th 2025. If we need to resubmit, the process will take longer...
- Step 1: the changes have now been merged into the
As always, if you identify any difficulties or any problems with this release, please open an Issue and we will resolve it.
- Your friends at SparkFun