Skip to content
Back to search

lanshu-animated-architecture-diagram

Premium hand-drawn animated architecture diagram Codex skill

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/cclank--lanshu-animated-architecture-diagram/badge.svg)](/listings/cclank--lanshu-animated-architecture-diagram)

HTML

<a href="/listings/cclank--lanshu-animated-architecture-diagram"><img src="/api/listings/cclank--lanshu-animated-architecture-diagram/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

git clone https://github.com/cclank/lanshu-animated-architecture-diagram.git
cd lanshu-animated-architecture-diagram
python3 -m pip install -r requirements.txt
python3 scripts/render_animated_diagram.py \
  --spec assets/default-spec.json \
  --outdir outputs \
  --basename sample \
  --verify

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

SKILL.md · Manifest · 97 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. ---
  2. name: lanshu-animated-architecture-diagram
  3. version: 1.0.0
  4. display_name: 岚叔动态架构图
  5. display_name_en: Lanshu Animated Architecture Diagram
  6. description_zh: 创建岚叔风格的高质感黑底手绘架构图和流程图,输出可编辑的 Excalidraw 文件、PNG 预览和带流动高亮效果的 GIF。
  7. description_en: Create premium black-canvas hand-drawn architecture and process diagrams with editable Excalidraw files, PNG previews, and animated GIFs with moving flow highlights.
  8. description: Create premium hand-drawn architecture and process diagrams in the Lanshu animated GIF style, with editable .excalidraw files, static PNG previews, and genuinely animated GIFs with moving flow highlights. Use this skill whenever the user asks for 岚叔动态架构图, Excalidraw-like diagrams, DailyDoseOfDS-style black-background sketches, animated architecture/process GIFs, polished flowcharts, visual explanations of articles or system designs, or asks to replicate or improve a reference diagram with hand-drawn animated effects.
  9. ---
  10. # Lanshu Animated Architecture Diagram
  11. Create a polished black-background hand-drawn technical diagram with:
  12. - Editable `.excalidraw` source
  13. - Static `.png` preview
  14. - Animated `.gif` with moving glow points and pulsing module highlights
  15. Use the bundled renderer for deterministic output. Avoid external icon libraries unless the user explicitly provides audited assets.
  16. ## Workflow
  17. 1. Extract the diagram content.
  18. - For an article or long post, identify the core architecture, actors, stages, data flow, decisions, and final outputs.
  19. - For a reference image, preserve the visual grammar: title structure, panels, arrows, density, and signature placement.
  20. 2. Create a spec JSON.
  21. - Start from `assets/default-spec.json`.
  22. - Keep labels short. Read `references/spec-format.md` when field details or copy length guidance are needed.
  23. - Use the user’s language for explanatory labels unless the reference style clearly calls for English titles.
  24. 3. Render the outputs.
  25. ```bash
  26. python /path/to/skill/scripts/render_animated_diagram.py \
  27. --spec /path/to/spec.json \
  28. --outdir /path/to/output-dir \
  29. --basename descriptive-name \
  30. --verify \
  31. --check
  32. ```
  33. 4. Validate before delivery.
  34. - Confirm GIF dimensions, FPS, frame count, and duration with `ffprobe`.
  35. - Use `--verify` output or `--check` to prove the GIF is not static.
  36. - Confirm `.excalidraw` JSON has unique IDs, text uses `fontFamily: 5`, and `files` is empty. `--check` validates these output contracts automatically.
  37. - Open the PNG preview visually and fix overlap, cramped text, or weak hierarchy.
  38. 5. Deliver the three files.
  39. - Show the GIF preview when the interface supports local images.
  40. - Link the PNG and `.excalidraw` source.
  41. ## Style Rules
  42. - Use a dark canvas with a thin outer rounded frame.
  43. - Use one highlighted title phrase in a green capsule.
  44. - Put the author signature in the top-right brand slot unless the user asks otherwise.
  45. - Prefer clean white main arrows. Use colored motion only in the GIF overlay.
  46. - Keep static diagrams restrained. Let animation add motion, not clutter.
  47. - Use short text. If a phrase cannot fit, rewrite it instead of shrinking until unreadable.
  48. - Use built-in simple icons: `folder`, `file`, `scan`, `shield`, `db`, `hash`, `package`.
  49. ## Spec Authoring Hints
  50. Map common content to the fixed layout:
  51. - `inputs`: source systems, triggers, documents, tools, or user actions
  52. - `core.cards`: the three main stages of the process
  53. - `decision`: the quality gate or readiness check
  54. - `left_panel`: memory/context/source material
  55. - `center_panel`: internal layers, safeguards, archive stores, or pipeline internals
  56. - `right_panel`: packaged outputs, reusable assets, generated reports, or agent-facing artifacts
  57. If the subject has more than three stages, group adjacent steps into three core cards and move details into the lower panels.
  58. ## Verification Commands
  59. Use these checks after rendering:
  60. ```bash
  61. ffprobe -v error -select_streams v:0 -count_frames \
  62. -show_entries stream=width,height,r_frame_rate,avg_frame_rate,nb_read_frames \
  63. -show_entries format=duration \
  64. -of default=noprint_wrappers=1 output.gif
  65. ```
  66. ```bash
  67. python /path/to/skill/scripts/render_animated_diagram.py \
  68. --spec spec.json \
  69. --outdir outputs \
  70. --basename diagram \
  71. --verify \
  72. --check
  73. ```
  74. The `--verify` report should show nonzero changed pixels between sampled GIF frames.
  75. The `--check` report should return `"ok": true`; it exits nonzero on contract failures.
README.md · README · 267 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. # Lanshu Animated Architecture Diagram
  3. **岚叔动态架构图: premium hand-drawn animated architecture diagrams for articles, systems, and workflows.**
  4. [![Codex Skill](https://img.shields.io/badge/Codex-Skill-22C86F?style=for-the-badge)](./SKILL.md)
  5. [![Python](https://img.shields.io/badge/Python-3.9%2B-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
  6. [![Pillow](https://img.shields.io/badge/Pillow-Renderer-8A2BE2?style=for-the-badge)](https://python-pillow.org/)
  7. [![Excalidraw](https://img.shields.io/badge/Excalidraw-JSON-6965DB?style=for-the-badge)](https://excalidraw.com/)
  8. [![Animated GIF](https://img.shields.io/badge/Animated-GIF-FFB000?style=for-the-badge)](./scripts/render_animated_diagram.py)
  9. [![License](https://img.shields.io/badge/License-MIT-111827?style=for-the-badge)](./LICENSE)
  10. `JSON spec` -> `.excalidraw` + `.png` + animated `.gif`
  11. </div>
  12. <p align="center">
  13. <a href="#gallery">Gallery</a> ·
  14. <a href="#quick-start">Quick Start</a> ·
  15. <a href="#features">Features</a> ·
  16. <a href="#spec-structure">Spec</a> ·
  17. <a href="#verification">Verification</a>
  18. </p>
  19. `lanshu-animated-architecture-diagram` is a Codex skill and local renderer for creating premium black-canvas technical diagrams with hand-drawn typography, editable Excalidraw output, static PNG previews, and genuinely animated GIFs.
  20. It is designed for article explanations, system architecture diagrams, process diagrams, and DailyDoseOfDS-style black-background technical sketches.
  21. ## Gallery
  22. The default visual system uses a dark canvas, moving flow highlights, pulsing modules, subtle grain, vignette, and a top-right hand-drawn signature.
  23. <table>
  24. <tr>
  25. <td width="50%" align="center">
  26. <strong>Claude Loops</strong><br />
  27. <img src="./assets/previews/claude-loops.gif" alt="Claude Loops animated architecture diagram" width="100%" />
  28. </td>
  29. <td width="50%" align="center">
  30. <strong>Memory Pack</strong><br />
  31. <img src="./assets/previews/memory-pack.gif" alt="Memory Pack animated architecture diagram" width="100%" />
  32. </td>
  33. </tr>
  34. </table>
  35. ## Features
  36. - Generates `.excalidraw`, `.png`, and animated `.gif` from one JSON spec
  37. - Produces real animation with moving glow points and pulsing module highlights
  38. - Keeps the `.excalidraw` source editable and text-based
  39. - Uses local Python rendering through Pillow
  40. - Does not require Excalidraw, browser automation, ImageMagick, remote APIs, or external icon libraries
  41. - Includes frame-diff verification to prove GIF motion
  42. - Uses a fixed high-quality layout for clean technical storytelling
  43. ## Outputs
  44. Each render produces:
  45. ```text
  46. <basename>.excalidraw
  47. <basename>.png
  48. <basename>.gif
  49. ```
  50. The default canvas is:
  51. ```text
  52. 1210 x 1138
  53. 20 fps
  54. 41 frames
  55. 2.05 seconds
  56. ```
  57. ## Quick Start
  58. ```bash
  59. git clone https://github.com/cclank/lanshu-animated-architecture-diagram.git
  60. cd lanshu-animated-architecture-diagram
  61. python3 -m pip install -r requirements.txt
  62. python3 scripts/render_animated_diagram.py \
  63. --spec assets/default-spec.json \
  64. --outdir outputs \
  65. --basename sample \
  66. --verify
  67. ```
  68. ## Installation
  69. Place this folder in your Codex skills directory:
  70. ```bash
  71. ~/.codex/skills/lanshu-animated-architecture-diagram
  72. ```
  73. Typical local install path:
  74. ```bash
  75. ${CODEX_HOME:-$HOME/.codex}/skills/lanshu-animated-architecture-diagram
  76. ```
  77. Install the runtime dependency:
  78. ```bash
  79. python3 -m pip install -r requirements.txt
  80. ```
  81. ## Use With Codex
  82. Invoke the skill by name:
  83. ```text
  84. Use $lanshu-animated-architecture-diagram to turn this article into a premium hand-drawn animated architecture GIF.
  85. ```
  86. Chinese prompt example:
  87. ```text
  88. 用 $lanshu-animated-architecture-diagram 把这篇文章整理成岚叔动态架构图,输出 GIF、PNG 和 Excalidraw。
  89. ```
  90. ## CLI Usage
  91. Start from the bundled template:
  92. ```bash
  93. cp assets/default-spec.json work/my-diagram-spec.json
  94. ```
  95. Render:
  96. ```bash
  97. python3 scripts/render_animated_diagram.py \
  98. --spec work/my-diagram-spec.json \
  99. --outdir outputs \
  100. --basename my-diagram \
  101. --verify \
  102. --check
  103. ```
  104. The `--verify` flag prints sampled frame differences. Nonzero changed pixels confirm that the GIF is genuinely animated.
  105. The `--check` flag validates the generated PNG, GIF, and Excalidraw output
  106. contract and exits nonzero if a required property fails. It checks dimensions,
  107. GIF frame count and frame duration, sampled GIF motion, unique Excalidraw IDs,
  108. text font family, and that no external files are embedded.
  109. ## Spec Structure
  110. The renderer uses `assets/default-spec.json` as a compact art-directed template.
  111. Most edits happen in these fields:
  112. ```text
  113. signature
  114. title.prefix
  115. title.highlight
  116. title.subtitle
  117. inputs
  118. core.cards
  119. decision
  120. output
  121. left_panel
  122. center_panel
  123. right_panel
  124. ```
  125. Supported icon keys:
  126. ```text
  127. folder
  128. file
  129. scan
  130. shield
  131. db
  132. hash
  133. package
  134. ```
  135. For details, see [references/spec-format.md](./references/spec-format.md).
  136. ## Verification
  137. Validate the skill structure:
  138. ```bash
  139. python3 ${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-creator/scripts/quick_validate.py \
  140. ${CODEX_HOME:-$HOME/.codex}/skills/lanshu-animated-architecture-diagram
  141. ```
  142. Validate GIF media parameters:
  143. ```bash
  144. ffprobe -v error -select_streams v:0 -count_frames \
  145. -show_entries stream=width,height,r_frame_rate,avg_frame_rate,nb_read_frames \
  146. -show_entries format=duration \
  147. -of default=noprint_wrappers=1 outputs/my-diagram.gif
  148. ```
  149. Validate animation:
  150. ```bash
  151. python3 scripts/render_animated_diagram.py \
  152. --spec assets/default-spec.json \
  153. --outdir outputs \
  154. --basename sample \
  155. --verify \
  156. --check
  157. ```
  158. ## Dependencies
  159. Required:
  160. - Python 3.9+
  161. - Pillow 10.0.0+
  162. Install Python packages with:
  163. ```bash
  164. python3 -m pip install -r requirements.txt
  165. ```
  166. Optional:
  167. - `ffprobe` for media inspection
  168. - Excalidraw web app or editor plugin for manual editing of generated `.excalidraw` files
  169. ## Project Layout
  170. ```text
  171. lanshu-animated-architecture-diagram/
  172. ├── SKILL.md
  173. ├── README.md
  174. ├── LICENSE
  175. ├── requirements.txt
  176. ├── agents/
  177. │ └── openai.yaml
  178. ├── assets/
  179. │ ├── default-spec.json
  180. │ └── previews/
  181. │ ├── claude-loops.gif
  182. │ └── memory-pack.gif
  183. ├── references/
  184. │ └── spec-format.md
  185. └── scripts/
  186. └── render_animated_diagram.py
  187. ```
  188. ## Design Notes
  189. This project intentionally keeps the visual system narrow:
  190. - Dark canvas
  191. - Hand-drawn title treatment
  192. - Top input strip
  193. - Middle core pipeline
  194. - Bottom source, layer, and pack panels
  195. - Top-right signature
  196. - Clean static diagram with motion added only in GIF overlays
  197. That constraint keeps outputs consistent and polished across different architecture topics.
  198. ## License
  199. MIT

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.