init

Author: linalinn

.github/workflows/image.yaml

@@ -0,0 +1,32 @@
+name: build docker image
+on:
+  push:
+jobs:
+  push_to_registry:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          build-args: |
+            "VERSION=${{ github.sha }}"
+          tags: ghcr.io/linalinn/kicad:nightly

Dockerfile

@@ -0,0 +1,12 @@
+FROM kicad/kicad:nightly
+
+RUN sudo apt update -y && \
+    sudo apt install -y ffmpeg
+
+ARG DEBIAN_FRONTEND=noninteractive
+
+ARG VERSION=no-version
+
+ENV VERSION=$VERSION
+
+COPY *.sh /usr/bin/

action.yaml

@@ -0,0 +1,22 @@
+# action.yml
+name: 'kicad render pcb'
+description: 'Render KiCad PCBs top, bottom optionally render and gif or mp4 of the PCB rotating'
+inputs:
+  pcb_file:  # id of input
+    description: 'Path to your .kicad_pcb'
+    required: true
+  output_path:
+    description: 'path to where top.png and bottom.png should be created'
+    required: true
+  backgroud:
+    description: 'Image background. Options: transparent, opaque. Default: transparent for PNG, opaque for JPEG'
+    required: false
+  animation:
+    description: 'If an animation of the PCB rotating should be rendered (backgroud dose not apply)'
+    required: false
+runs:
+  using: 'docker'
+  image: 'ghcr.io/linalinn/kicad-render:nightly'
+  args:
+    - if [ -n "$INPUT_ANIMATION") ]; then render-pcb.sh -f $INPUT_PCB_FILE -o $INPUT_OUTPUT_PATH -b INPUT_BACKGROUND -a $INPUT_ANIMATION else render-pcb.sh -f $INPUT_PCB_FILE -o $INPUT_OUTPUT_PATH -b INPUT_BACKGROUND if
+

kicad_animation.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# 
+# Original by: arturo182
+# gist: https://gist.github.com/arturo182/57ab066e6a4a36ee22979063e4d5cce1
+#
+FORMAT="$1"
+OUTPUT_DIR="${3:-/pwd}"
+FRAME_DIR="/tmp/render"
+INPUT_FILE="$2"
+ZOOM=0.7
+WIDTH=1080
+HEIGHT=1080
+ROTATE_X=0
+ROTATE_Z=45
+ROTATION=360 # Total rotation angle
+STEP=3 # Rotation step in degrees
+FRAMERATE=30 # Framerate for the final video
+
+KICAD_CLI=$(which kicad-cli || which kicad-cli-nightly)
+
+mkdir -p $OUTPUT_DIR
+mkdir -p $FRAME_DIR
+
+let FRAMES=ROTATION/STEP
+for ((i = 0; i < FRAMES; i++)); do
+    ROTATE_Y=-$(($i * STEP))
+    OUTPUT_PATH="$FRAME_DIR/frame$i.png"
+    echo "Rendering frame $i ($ROTATE_Y degrees) to $OUTPUT_PATH"
+    $KICAD_CLI pcb render --rotate "$ROTATE_X,$ROTATE_Y,$ROTATE_Z" --zoom $ZOOM -w $WIDTH -h $HEIGHT --background opaque -o $OUTPUT_PATH $INPUT_FILE > /dev/null
+done
+
+# Combine frames into an MP4 with the specified framerate
+if [[ $FORMAT == "mp4" ]]; then
+    echo "Combining frames into an MP4..."
+    ffmpeg -y -framerate $FRAMERATE -i "$FRAME_DIR/frame%d.png" -c:v libx264 -r 30 -pix_fmt yuv420p "$OUTPUT_DIR/rotating.mp4"
+    echo "MP4 created successfully."
+elif [[ $FORMAT == "gif" ]]; then
+    echo "Combining frames into an GIF..."
+    ffmpeg -y -framerate $FRAMERATE -i "$FRAME_DIR/frame%d.png" "$OUTPUT_DIR/rotating.gif"
+    echo "GIF created successfully."
+else
+    # TODO: this should be vaildated before rendering anything
+    echo first argument must be mp4 or gif
+fi

render-pcb.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+
+help() {
+    echo "Convert .kicad_pcb file to front and back image and optionaly render an animation"
+    echo
+    echo "Syntax: render-pcb.sh [-f|o|a|h]"
+    echo "options:"
+    echo "f     Path to .kicad_pcb file"
+    echo "b     Image background. Options: transparent, opaque. Default: transparent for PNG, opaque for JPEG"
+    echo "o     Directory where the images and optinally the animation should be written to."
+    echo "a     Render animation and select animation output format (mp4 or gif)."
+    echo "v     Print protgram version"
+    echo "h     Print this Help."
+    echo
+    exit
+}
+
+output_path="/pwd"
+background="transparent"
+
+while getopts :f:o:a:hv option
+do
+    case "${option}" in
+        f) kicad_pcb=${OPTARG};;
+        o) output_path=${OPTARG};;
+        a) animation=${OPTARG};;
+        b) background=${OPTARG};;
+        h) help;;
+        v) echo "IMAGE version: ${VERSION:-none}" && exit;;
+        \?)
+            echo "Error: Invalid option"
+            exit;
+    esac
+done
+
+if [[ -z "$kicad_pcb" ]]; then
+    help
+fi
+
+if [[ -n "$animation" ]]; then
+    if [ "$animation" != "gif" ] -a [[ "$animation" != "mp4" ]]; then
+        help
+    fi
+fi
+
+
+
+KICAD_CLI=$(which kicad-cli || which kicad-cli-nightly)
+
+echo $output_path
+
+mkdir -p $output_path
+echo "rendering top"
+$KICAD_CLI pcb render --side top --background $background -o $output_path/top.png $kicad_pcb > /dev/null
+
+echo "rendering bottom"
+$KICAD_CLI pcb render --side bottom --background $background -o $output_path/bottom.png $kicad_pcb > /dev/null
+
+if [[ -n "$animation" ]]; then
+    echo "rendering animation"
+    kicad_animation.sh $animation $kicad_pcb $output_path
+fi
+
+ls $output_path