From 57097d5e66413f3007d9f750cb8a17357f6679aa Mon Sep 17 00:00:00 2001 From: Severin Ibarluzea Date: Sat, 15 Nov 2025 20:20:38 -0800 Subject: [PATCH] Update KiCad import guide --- .../importing-from-kicad.md | 28 +++++++++++++++++-- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/guides/importing-modules-and-chips/importing-from-kicad.md b/docs/guides/importing-modules-and-chips/importing-from-kicad.md index 0ab05ed..130332a 100644 --- a/docs/guides/importing-modules-and-chips/importing-from-kicad.md +++ b/docs/guides/importing-modules-and-chips/importing-from-kicad.md @@ -41,22 +41,44 @@ we can convert KiCad files on the command line. First install the component converter: ```bash -npm install -g kicad-mod-converter +npm install -g kicad-component-converter ``` Next, run the following command to convert your KiCad files: ```bash # Convert a directory ./my-footprints.pretty to a tscircuit project -kicad-mod-converter convert-kicad-directory --input-dir ./my-footprints.pretty --output-dir ./my-tscircuit-footprints +kicad-component-converter convert-kicad-directory --input-dir ./my-footprints.pretty --output-dir ./my-tscircuit-footprints ``` ### Importing KiCad Components Programmatically ```bash -bun add kicad-mod-converter +bun add kicad-component-converter ``` +#### Import `.kicad_mod` files directly + +`kicad-component-converter` registers a bundler loader that lets you import KiCad +footprints like any other module inside your tscircuit project: + +```tsx +import kicadMod from "./footprint.kicad_mod" + +export default () => { + return ( + + + + ) +} +``` + +#### Convert KiCad files manually + +If you need to do the conversion yourself (for example inside a build script), +you can read the `.kicad_mod` file and pass it through the parser: + ```tsx import { parseKicadModToCircuitJson } from "kicad-component-converter" import { readFileSync } from "node:fs"