Skip to content

Commit

Permalink
Add readme, license, images
Browse files Browse the repository at this point in the history
  • Loading branch information
30350n committed May 16, 2022
1 parent 755d5ab commit 6776b02
Show file tree
Hide file tree
Showing 8 changed files with 750 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.vscode/
__pycache__/
site-packages/
images/template*
*.blend[1-9]
674 changes: 674 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
[![freecad](https://img.shields.io/badge/blender-3.1.0-orange)](https://www.gnu.org/licenses/gpl-3.0.txt)
[![freecad](https://img.shields.io/badge/kicad-6.0.5-blue)](https://www.gnu.org/licenses/gpl-3.0.txt)
[![gplv3](https://img.shields.io/badge/license-GPLv3-lightgrey)](https://www.gnu.org/licenses/gpl-3.0.txt)

<img src="images/header.jpg"/>

The pcb2blender workflow lets you create professionally looking product renders of all your
KiCad projects in minutes! Simply export your board as a `.pcb3d` file in KiCad, import it into
Blender and start creating!

It lets you focus all your time on actually composing and lighting an interesting scene,
skipping all the boring cleanup work that would be required without it.

Its quick export/import times also make it viable to create renders of WIP boards or to update
them, after last minute board revisions.

<div style="display:flex">
<div style="flex:1;padding:5px;">
<img src="images/pcb_material.jpg" width=100%/>
</div>
<div style="flex:1;padding:5px;">
<img src="images/breakout.jpg" width=100%/>
</div>
</div>

## Usage

1. Hit the `Export to Blender (.pcb3d)` button in pcbnew.
2. Import the file in Blender via `File -> Import -> PCB (.pcb3d)`
3. Start creating awesome renders!

## Installation

### Exporter (KiCad)

- (not available yet) via the builtin plugin manager
`Tools -> Plugin and Content Manager -> Plugins -> pcb2blender`

- (manual) Download the `pcb2blender_exporter.zip` from the
[latest release](https://github.com/30350n/free2ki/releases/latest),
unpack the `plugins` directory from it into your
[Kicad Plugin directory](https://dev-docs.kicad.org/en/python/pcbnew/) and rename it to
`pcb2blender_exporter`.

### Importer (Blender)

- (manual) Download the `pcb2blender_importer.zip` from the
[latest release](https://github.com/30350n/free2ki/releases/latest)
and install it in Blender via `Edit -> Preferences -> Add-ons -> Install`.
(You need to install the actual zip file. Don't unpack it!)

## Other Projects

- The [protorack-kicad](https://github.com/30350n/protorack-kicad) KiCad library, contains
all the custom symbols and footprints I use for eurorack module development.

- My [svg2blender](https://github.com/30350n/svg2blender) workflow enables you to export
2D graphical designs from [Inkscape](https://inkscape.org/) to Blender. It's mainly intended
for use with front panel designs, but could be used for other ones as well.

## Credits

- The name of this project is inspired by the awesome
[svg2shenzhen](https://github.com/badgeek/svg2shenzhen) Inkscape extension by
[badgeek](https://github.com/badgeek).

- The PCB Shader node setup this addon comes with is inspired by the
[stylized-blender-setup](https://github.com/PCB-Arts/stylized-blender-setup)
repository by [PCB-Arts](https://www.pcb-arts.com).

## License

- This project is licensed under
[GPLv3](https://github.com/30350n/free2ki/blob/master/LICENSE).
Binary file added images/breakout.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/header.afphoto
Binary file not shown.
Binary file added images/header.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/pcb2blender_banner.blend
Binary file not shown.
Binary file added images/pcb_material.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6776b02

Please sign in to comment.