# ach-k/cubic-11 architecture

> Architecture diagram of the GitHub repository ach-k/cubic-11, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ach-k/cubic-11
- Repository: https://github.com/ach-k/cubic-11

## Overview

This repository is a font project, not an application. Its architecture is centered on one editable font source and two distribution artifact sets.

Main subsystems

1. Font source
- `source/Cubic_11_1.451_R.sfd`
- This is the primary design/master file for the typeface.
- It is a FontForge SFD source, which stores glyph outlines, encoding, metrics, and font metadata in an editable form.
- All actual font production originates from this file.

2. Generated font artifacts
- `fonts/ttf`
- `fonts/web`
- These directories contain built deliverables derived from the source font.
- `fonts/ttf` is the desktop/installation distribution format.
- `fonts/web` is the web-optimized distribution format, intended for browser or embedded use cases where font packaging differs from standard desktop TTF delivery.
- The repo does not show the build process, but architecturally these are downstream outputs from the source master.

3. Licensing and distribution metadata
- `OFL.txt`
- This is the SIL Open Font License document that governs the project.
- It is part of the distributable package boundary and must accompany redistributions.
- The README explicitly treats the font name as a reserved name under OFL and describes redistribution constraints.

4. Project documentation
- `README.md`
- Describes the font’s purpose, lineage, coverage, and licensing.
- It is the human-facing entry point for understanding what the font is, what it includes, and how it may be used.

Primary data flow

- Edit/design phase:
  - Work happens in the SFD source file.
  - Glyph adjustments, additions, and metadata changes are made there.

- Build/export phase:
  - The source font is exported into multiple packaging targets.
  - One target is TTF for standard use.
  - Another target is a web-oriented build for browser distribution.

- Release/distribution phase:
  - The built font files are shipped together with `OFL.txt`.
  - Users consume the artifacts directly; the repository serves as both source archive and release bundle.

Architectural boundaries

- Source boundary:
  - `source/` is the authoritative upstream design asset.
  - It is the only clearly editable master in the repository layout.

- Artifact boundary:
  - `fonts/` contains compiled deliverables, not the design source.
  - These files are meant for use and distribution rather than editing.

- Legal boundary:
  - `OFL.txt` defines how the source and outputs may be reused, renamed, bundled, and redistributed.

Relevant project characteristics

- Typeface domain:
  - This is a bitmap/pixel-style Traditional Chinese font project derived from M+ gothic 12r.
  - The README states it expands and adjusts glyph coverage for Traditional Chinese usage, including punctuation and Taiwan-preferred forms.
  - The repository’s purpose is therefore content production for typography, not runtime software behavior.

- Coverage and use case:
  - The font is designed for pixel-style games and visual art.
  - The included character set spans common Chinese characters, Big5, IICore subsets, Zhuyin, GB 2312 Level-1, and some scientific symbol coverage such as periodic-table elements.
  - This means the important architectural concern is glyph completeness and compatibility, not service orchestration or application state.

How to draw the diagram

A clear architecture diagram for this repository would have:
- A single authoritative source asset: the `.sfd` file.
- Two output lanes from that source: TTF and web font artifacts.
- A documentation/licensing lane alongside the artifacts: README and OFL.
- A release boundary showing that end users consume the generated font packages, while contributors modify the source master.

In short, this repo is a font source-and-release package: one editable master font file feeds multiple distributable font formats, all governed by the included OFL license and described by the README.

Main entry points: [`source/Cubic_11_1.451_R.sfd`](https://github.com/ach-k/cubic-11/blob/HEAD/source/Cubic_11_1.451_R.sfd) (Font source), [`README.md`](https://github.com/ach-k/cubic-11/blob/HEAD/README.md) (README), [`OFL.txt`](https://github.com/ach-k/cubic-11/blob/HEAD/OFL.txt) (OFL license), [`fonts/ttf`](https://github.com/ach-k/cubic-11/tree/HEAD/fonts/ttf) (TTF fonts)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph "Source"
  font_source["Font source<br/>SFD master"]
end

subgraph "Artifacts"
  ttf_fonts["TTF fonts<br/>Desktop build"]
  web_fonts["Web fonts<br/>Web build"]
end

subgraph "Docs & License"
  readme["README<br/>Project guide<br/>[README.md]"]
  ofl["OFL license<br/>[OFL.txt]"]
end

font_source -->|"exports"| ttf_fonts
font_source -->|"exports"| web_fonts
readme -.->|"documents"| font_source
readme -.->|"describes"| ttf_fonts
readme -.->|"describes"| web_fonts
ofl -.->|"governs"| font_source
ofl -.->|"ships with"| ttf_fonts
ofl -.->|"ships with"| web_fonts

click font_source "https://github.com/ach-k/cubic-11/blob/main/source/Cubic_11_1.451_R.sfd"
click ttf_fonts "https://github.com/ach-k/cubic-11/tree/main/fonts/ttf"
click web_fonts "https://github.com/ach-k/cubic-11/tree/main/fonts/web"
click readme "https://github.com/ach-k/cubic-11/blob/main/README.md"
click ofl "https://github.com/ach-k/cubic-11/blob/main/OFL.txt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class font_source toneBlue
class ttf_fonts,web_fonts toneAmber
class readme,ofl toneMint
```

## Components

### Source

Authoritative editable font master.

- [Font source](https://github.com/ach-k/cubic-11/blob/HEAD/source/Cubic_11_1.451_R.sfd): SFD master · Editable FontForge source that defines glyphs, metrics, and font metadata. · `source/Cubic_11_1.451_R.sfd`

### Artifacts

Generated font deliverables for distribution.

- [TTF fonts](https://github.com/ach-k/cubic-11/tree/HEAD/fonts/ttf): Desktop build · Compiled TrueType font deliverables for standard installation and use. · `fonts/ttf`
- [Web fonts](https://github.com/ach-k/cubic-11/tree/HEAD/fonts/web): Web build · Compiled web-optimized font deliverables for browser or embedded delivery. · `fonts/web`

### Docs & License

Human-facing project information and legal terms.

- [README](https://github.com/ach-k/cubic-11/blob/HEAD/README.md): Project guide · Explains the font's purpose, coverage, lineage, and usage constraints. · `README.md`
- [OFL license](https://github.com/ach-k/cubic-11/blob/HEAD/OFL.txt): License · SIL Open Font License governing redistribution, renaming, and packaging. · `OFL.txt`

## Connections

- Font source → TTF fonts: exports · The editable master is the upstream source for desktop font builds.
- Font source → Web fonts: exports · The editable master also feeds the web-oriented font package.
- README → Font source: documents · Describes the design source, lineage, and character coverage.
- README → TTF fonts: describes · Explains the packaged font output for users.
- README → Web fonts: describes · Explains the web distribution output for users.
- OFL license → Font source: governs · License terms apply to the source master and redistribution of derived works.
- OFL license → TTF fonts: ships with · The license accompanies distributed TTF artifacts.
- OFL license → Web fonts: ships with · The license accompanies distributed web font artifacts.
