Repository files navigation

A plugin for Obsidian to draw circuits on a canvas. It is based on thecode-forge-temple/circuit-sketcher-core.

⭐️Love this project? Please considerstarring the repository on GitHub andsupporting development to help me continue building amazing features!

• Features
• Installation
• Usage
• Component Library
• License

• Draw and edit circuit diagrams directly within Obsidian.
• Save and load circuit designs.
• Customizable library for circuit elements.
• Responsive design with automatic resizing.
• Embed circuit diagrams in notes: Reference.circuit-sketcher files in your notes (e.g., by dragging and dropping the file into a note). In read mode, an image of the circuit will be displayed automatically.

1. OpenObsidian and go toSettings ⇒Community Plugins ⇒Browse.
2. Search forCircuit Sketcher.
3. Select theCircuit Sketcher plugin and pressInstall, then pressEnable.

or

1. OpenCommunity Plugins Page in browser.
2. SelectInstall, then pressEnable.

1. Use the ribbon icon, command palette, or right-click on a target folder in the file explorer and selectCreate new Circuit Sketcher file to create a new circuit sketcher file.
2. Start drawing your circuit on the canvas:
   • On the canvas, right-click to show the canvas menu, and selectCreate Node.
   • Right-click on the node to show the node menu, selectChange Image, and choose an image relevant to your circuit node.
   • Right-click on the node to show the node menu, selectAdd Port..., and choose the port location and type.
   • You can rename the circuit node label or port label by double-clicking on the label. The port or port label can also be deleted (right-click on the port to show the port menu and proceed from there).
   • You can relocate ports, either to a different node side or rearrange the ports on the same side, by dragging and dropping the port to the desired location within the dotted blue area.
   • After you are satisfied with your changes to the circuit node, and if you wish to save the circuit node to reuse it in the current or a different.circuit-sketcher file, you can right-click on the circuit node and pressSave Node to Library (this will update the root Obsidian vaultcircuit-sketcher.lib file).
   • You can reuse the node by right-clicking on the canvas and selectingLibrary... then selecting the desired node.
   • Connections between circuit nodes can be made by dragging and dropping one port to the destination port (if it is a compatible port). You can delete a connection by selecting it and then pressing the Delete key.
   • You can drag the entire circuit by holding the mouse scroll button and moving the mouse.

A short video tutorial on how to use the plugin:

To help you get started with Circuit Sketcher, we provide a curated library of circuit components atcircuit-sketcher-lib.

Import the entire library:

• Download the complete component library:library.json
• Import it directly into Circuit Sketcher to get access to all available components (right click on canvas to show the menu, thenLibrary... ->Import Library)

Import individual components:

• Browse individual components:assets/nodes
• Download specific.json files for the components you need
• Import them one by one into your Circuit Sketcher workspace (right click on canvas to show the menu, thenImport Node)

This project is licensed under the GNU General Public License v3.0. See theLICENSE file for more details.

✦Agentic Signal – Visual AI agent workflow automation platform with local LLM integration - build intelligent workflows using drag-and-drop interface, no cloud dependencies required.

✦ScribePal - An Open Source intelligent browser extension that leverages AI to empower your web experience by providing contextual insights, efficient content summarization, and seamless interaction while you browse.

✦Local LLM NPC An interactive educational game built for the Google Gemma 3n Impact Challenge.