Skip to main content
Running tscircuit

Custom Platform Config

Use tscircuit.config.ts when your project needs a custom platformConfig, such as a private parts engine or a custom footprint library.

Example​

export default () => (
<board width="10mm" height="10mm">
  <resistor name="R1" resistance="1k" footprint="ti:C1234" />
</board>
)
PCB Circuit Preview

The CLI reads tscircuit.config.json for project settings and tscircuit.config.ts for runtime platform customization. Use footprintLibraryMap to resolve custom footprint prefixes such as ti:*.

PlatformConfig Structure​

The structure of platformConfig is defined by the PlatformConfig type in @tscircuit/props.

For a higher-level overview of common fields such as partsEngine, registryApiUrl, cloudAutorouterUrl, and footprintLibraryMap, see Platform Configuration.