Altium Toolkit

Altium Toolkit is an ESM JavaScript library for parsing native Altium schematic and PCB documents and rendering deterministic, non-interactive outputs from the recovered model.

The package was extracted from ECAD Forge, where it is used for browser-based Altium document parsing and deterministic render output. It is also used in PCB Styler. Its parser behavior, normalized model shape, and renderer output can be reused by other browser or Node-based tools.

Features

• Parse standalone native .SchDoc, .PcbDoc, .PcbLib, and .PrjPcb files from ArrayBuffer
• Recover schematic records, PCB outlines, placements, PCB library footprints, project document references, variants, parameters, primitives, embedded schematic images, component annotations from PrimitiveParameters/Text streams, embedded PCB STEP payload metadata, and embedded PCB/PcbLib font payloads with basic text metrics
• Preserve raw PCB primitive records through a read-only record registry so unsupported or partially decoded stream data remains inspectable
• Emit versioned normalized model roots with a machine-readable JSON Schema contract
• Render schematic SVG, PCB SVG, and grouped BOM HTML
• Build non-interactive PCB 3D scene-description data for host applications
• Render a static 3D board summary
• Run entirely with local input data; no network calls are made by the parser

Install

The package is published on npm as altium-toolkit.

npm install altium-toolkit

Usage

import {
    AltiumParser,
    SchematicSvgRenderer,
    PcbSvgRenderer,
    preparePcbSideResolvedRenderModel,
    BomTableRenderer,
    PcbScene3dBuilder
} from 'altium-toolkit'

const documentModel = AltiumParser.parseArrayBuffer(file.name, arrayBuffer)
const backRenderModel = preparePcbSideResolvedRenderModel(documentModel, {
    side: 'back'
})

const schematicMarkup = SchematicSvgRenderer.render(documentModel)
const pcbMarkup = PcbSvgRenderer.render(backRenderModel)
const bomMarkup = BomTableRenderer.render(documentModel.bom || [])
const sceneDescription = PcbScene3dBuilder.build(documentModel)

Optional renderer CSS is available through:

import 'altium-toolkit/styles/altium-renderers.css'

Documentation

• API
• Model Format
• Normalized Model Schema
• Testing
• Scope

Examples

• Arduino Uno Altium example based on Mehdi KHALFALLAH's public My-Arduino-UNO-Design project. The example fetches credited source documents from raw.githubusercontent.com at runtime and does not redistribute them.

Run the local example server with:

npm start

Test

npm test

The test suite uses repo-owned, obfuscated fixture shards only. Do not add native customer, vendor, or source project files to this repository.

License

This project is available under two licensing options.

1. Open-source software license

GNU General Public License v3.0 or later (GPL-3.0-or-later).

You may use, modify, and distribute this project under the GPL. If you distribute modified versions or larger works based on this project, they must comply with the GPL, including source-code availability requirements.

2. Commercial/proprietary license

For use in closed-source, proprietary, or otherwise GPL-incompatible products, a separate paid commercial license is required.

Commercial licensing contact: https://github.com/SunboX

Documentation and notices

Documentation and non-code text are licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA-4.0) unless otherwise marked.

Copyright (C) 2026 André Fiedler.

Copyright, license, attribution, and source-origin notices must be preserved as required by the GPL, CC-BY-SA-4.0, and the notice files in this repository. See LICENSE, COMMERCIAL-LICENSE.md, and NOTICE.md.