# cimos/kicad-customdesignrules architecture

> Architecture diagram of the GitHub repository cimos/kicad-customdesignrules, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cimos/kicad-customdesignrules
- Repository: https://github.com/cimos/kicad-customdesignrules

## Overview

##### Project type and purpose
- This is an open-source configuration library for KiCad’s PCB Editor (“KiCad-Custom-Design-Rules”).
- It supplies vendor-specific design-rule sets (JLCPCB, PCBWay) as KiCad Custom Rules (.kicad_dru files) that integrate into KiCad’s Design Rules Checker (DRC).

##### File structure
- Top-level:
- JLCPCB/
– JLCPCB.kicad_dru (custom rule definitions)
– JLCPCB.kicad_pcb, .kicad_pro, .kicad_sch (example project files)
- PCBWay/
– PCBWay.kicad_dru (vendor rule definitions)
– PCBWay.kicad_pcb, .kicad_pro, .kicad_sch
- README.md
- No source code or build scripts—just configuration files for KiCad.
- Each directory bundles: rules + sample KiCad project metadata.

##### README
- Describes how to copy a .kicad_dru into your own KiCad 8.0 project folder.
- Explains DRC integration and points to JLCPCB & KiCad documentation.

##### Main components
a. User’s KiCad Environment (UI)
– “PCBnew” Editor → loads Custom Rules via File > Board_Setup > Design Rules
– DRC Engine (built into KiCad)
b. Vendor Rule Sets (Configuration Store)
– File system directories: /JLCPCB/*.kicad_dru, /PCBWay/*.kicad_dru
– These files define geometry constraints, clearance rules, layer checks
c. Sample KiCad Project Files
– .kicad_pcb, .kicad_sch, .kicad_pro (illustrate how vendor rules apply)
d. External Documentation
– JLCPCB manufacturing capabilities (web link)
– KiCad Custom Rules docs

##### Relationships and interactions
- At startup or on demand, the PCB Editor scans project folder for *.kicad_dru
- When the user runs “Design Rules Checker,” the DRC Engine:
1. Reads vendor rule definitions from the .kicad_dru file
2. Analyzes the loaded .kicad_pcb data (traces, pads, zones)
3. Emits PASS/FAIL results back into the UI
- The user can switch between JLCPCB and PCBWay rules by selecting the respective .kicad_dru file.

##### Architectural patterns and design principles
- Plug-in/configuration-driven: The core ("KiCad PCBnew + DRC Engine") stays unchanged; behavior is driven by external rule files.
- Separation of concerns:
- Rule definitions = configuration layer
- DRC Engine = processing layer
- KiCad UI = presentation layer
- Extensibility: To add a new vendor, drop a new folder + .kicad_dru. No code changes required.

##### Technologies and artifacts
- KiCad PCBnew (v8.0)
- Custom Design Rules (.kicad_dru format)
- Example PCB Project Files (.kicad_pcb, .kicad_sch, .kicad_pro)
- Markdown README linking to external docs

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Internal Components
    PCBnew_UI["PCBnew UI"]:::internal
    DRC_Engine["DRC Engine"]:::internal

    %% Vendor Configurations Container
    subgraph "Vendor Configurations"
        direction TB
        JLCPCB_Dir["JLCPCB/"]:::config
        JLCPCB_Dru[(JLCPCB.kicad_dru)]:::config
        JLCPCB_PCB["JLCPCB.kicad_pcb"]:::config
        JLCPCB_PRO["JLCPCB.kicad_pro"]:::config
        JLCPCB_SCH["JLCPCB.kicad_sch"]:::config

        PCBWay_Dir["PCBWay/"]:::config
        PCBWay_Dru[(PCBWay.kicad_dru)]:::config
        PCBWay_PCB["PCBWay.kicad_pcb"]:::config
        PCBWay_PRO["PCBWay.kicad_pro"]:::config
        PCBWay_SCH["PCBWay.kicad_sch"]:::config
    end

    %% External Documentation
    External_Docs["README.md & External Docs"]:::docs

    %% Relationships
    JLCPCB_Dir --> JLCPCB_Dru
    JLCPCB_Dir --> JLCPCB_PCB
    JLCPCB_Dir --> JLCPCB_PRO
    JLCPCB_Dir --> JLCPCB_SCH

    PCBWay_Dir --> PCBWay_Dru
    PCBWay_Dir --> PCBWay_PCB
    PCBWay_Dir --> PCBWay_PRO
    PCBWay_Dir --> PCBWay_SCH

    JLCPCB_Dru -->|"loads rules"| DRC_Engine
    PCBWay_Dru -->|"loads rules"| DRC_Engine

    JLCPCB_PCB -->|"board data"| DRC_Engine
    JLCPCB_PRO -->|"project metadata"| DRC_Engine
    JLCPCB_SCH -->|"schematic data"| DRC_Engine

    PCBWay_PCB -->|"board data"| DRC_Engine
    PCBWay_PRO -->|"project metadata"| DRC_Engine
    PCBWay_SCH -->|"schematic data"| DRC_Engine

    DRC_Engine -->|"PASS/FAIL results"| PCBnew_UI

    External_Docs -->|"references"| PCBnew_UI

    %% Click Events
    click JLCPCB_Dir "https://github.com/cimos/kicad-customdesignrules/tree/main/JLCPCB/"
    click JLCPCB_Dru "https://github.com/cimos/kicad-customdesignrules/blob/main/JLCPCB/JLCPCB.kicad_dru"
    click JLCPCB_PCB "https://github.com/cimos/kicad-customdesignrules/blob/main/JLCPCB/JLCPCB.kicad_pcb"
    click JLCPCB_PRO "https://github.com/cimos/kicad-customdesignrules/blob/main/JLCPCB/JLCPCB.kicad_pro"
    click JLCPCB_SCH "https://github.com/cimos/kicad-customdesignrules/blob/main/JLCPCB/JLCPCB.kicad_sch"

    click PCBWay_Dir "https://github.com/cimos/kicad-customdesignrules/tree/main/PCBWay/"
    click PCBWay_Dru "https://github.com/cimos/kicad-customdesignrules/blob/main/PCBWay/PCBWay.kicad_dru"
    click PCBWay_PCB "https://github.com/cimos/kicad-customdesignrules/blob/main/PCBWay/PCBWay.kicad_pcb"
    click PCBWay_PRO "https://github.com/cimos/kicad-customdesignrules/blob/main/PCBWay/PCBWay.kicad_pro"
    click PCBWay_SCH "https://github.com/cimos/kicad-customdesignrules/blob/main/PCBWay/PCBWay.kicad_sch"

    click External_Docs "https://github.com/cimos/kicad-customdesignrules/blob/main/README.md"

    %% Styles
    classDef internal fill:#bee3f8,stroke:#3182ce,color:#1a365d
    classDef config fill:#c6f6d5,stroke:#2f855a,color:#22543d
    classDef docs fill:#fbd38d,stroke:#dd6b20,color:#7b341e
```
