[Question] `type: export_3d` not showing colors when using the docker images

[wico-sarin]

Describe the bug
When exporting from KiCad 9 via PCB editor->Export>STEP I get a nice looking colored 3D file. However, when using type: export_3d in kibot with standard configuration the result is without colors, all gray.

To Reproduce
Run KiBot with the following configuration file:

  - name: step
    comment: 3D model using KiCad's built-in export
    type: export_3d

Expected behavior
A colored 3D model the same as when using PCB editors built-in export option.

Screenshots
If applicable, add screenshots to help explain your problem.

Environment (please complete the following information):
CI workflow using the GitHub action with the tag **INTI-CMNB/KiBot@v2_dk9.

[set-soft]

Might be a KiCad CLI limitation.
I need a very simple test example and a mechanism to verify it.
I tried using FreeCAD and I always get gray.

[wico-sarin]

When exporting using kicad-cli pcb export step Test.kicad_pcb I get a STEP file including colors. Only if using KiBot export_3d the problem occurs.

I tried using FreeCAD and I always get gray.

Yes I also use FreeCad to view the output. Same observation as you.

[set-soft]

When exporting using kicad-cli pcb export step Test.kicad_pcb I get a STEP file including colors. Only if using KiBot export_3d the problem occurs.

Then please provide a test case, the export_3d output uses kicad-cli.

I tried using FreeCAD and I always get gray.

Yes I also use FreeCad to view the output. Same observation as you.

So then I need some mechanism to verify colors are there.

[wico-sarin]

I can confirm that using the latest docker image ghcr.io/inti-cmnb/kicad9_auto_full:latest I get a STEP with colors both, using KiCad and KiBot on my local machine.

The problem seems to be related to the environment using the Github Action INTI-CMNB/KiBot@v2_dk9.

[set-soft]

Hmmm ... in the docker images we don't have the 3D models, it might be related to it.
Are you using STEP or WRL models in your footprints? Are both available in the repo?
I suggest making your project self contained and make sure that both formats are available.
Are you getting warnings about missing 3D models?

[wico-sarin]

I switched now to the latest GitHub action INTI-CMNB/KiBot@v2_k9 which uses ghcr.io/inti-cmnb/kicad9_auto_full:latest docker I am not wrong. However, I still end up with a grey board.

I don't get any warnings. STEP models are available in my own library, no WRL. But most of the components are using the KiCad library were I guess both is available.

It is very interesting. When I run the KiBot configuration with a GitHub action, I get a mostly grey model. But I see a little LED with colors (everything else is grey).

When I run it locally using KiCad 9 and the exact same output command I end up with a color-full model.

What does it mean to be "self-contained"?

[set-soft]

What does it mean to be "self-contained"?

That all the needed stuff is in your project, in particular all 3D models.

When I use freecad I always get gray PCBs, so I need some tool to see when it happens, without it I can investigate the source of the problem.

[set-soft]

Hi @wico-sarin !

Do you get colors using https://3dviewer.net/ ?

I tried exporting with the GUI and I got only one color, used for the core, the rest is gray.

What software are you using to see the step file generated locally?

[wico-sarin]

Hi @set-soft,

I created a sample project for this problem, see attached. Just some random components on a board.
3DExportTest.zip

I use the following configuration file:

kibot:
  version: 1
  
outputs:
  # 3D Model (KiCad 9)
   - name: step
     type: export_3d
     options:
       output: "Export with KiBot"
       include_pads: true
       include_silkscreen: true
       include_soldermask: true
       include_tracks: true

Exporting using KiBot from the latest docker ghcr.io/inti-cmnb/kicad9_auto_full:latest release ends with a green board and grey components viewed from FreeCad 1.0.

The same step file viewed in 3dviewer.net looks all grey.

Viewed with KiCad 9.0, I got colors.

Exporting out of KiCad 9.0 I get colors when viewed with FreeCad and 3dviewer.net

Update: I tested the behavior in two environments. I get colors from the GUI export in my Windows environment. I don't get colors out of the GUI installed in my Ubuntu environment. Both use KiCad 9 with standard configuration. Both show colors when using the KiCad internal 3D viewer.

[set-soft]

The KiCad internal 3D viewer doesn't show STEP files, is an OpenGL render done by KiCad.
If it works for Windows, but not for Ubuntu this is most probably related to the occt libs.
I have v7.6 on my system, the same used by the docker images, but the KiCad from Debian testing uses v7.8.
I know that PLY files can't be generated using v7.6, so I guess the Windows binaries has v7.7 or v7.8 included.
So it looks like this problem is completely outside KiBot.

[oliv3r]

What does it mean to be "self-contained"?

While 'End of Life' with KiCad 10 due to API changes, https://github.com/MitjaNemec/Archive3DModels is a plugin that does this for you.

Basically it ensures all your 3D models are stored 'relative' to your project, e.g. if you commit them to the repo, and someone else clones your repo, everything that is needed is there (and properly referenced).

Technically, your file would look like hello.kicad_pcb: (model "${KIPRJMOD}/packages3D/BatteryHolder_Keystone_103_1x20mm.wrl"
for example, instead of some path somewhere in the filesystem.

New in KiCad 9 is to 'embed' files in your project, which is also an option (hopeing for a plugin depending on the API availability), which in sort changes ${KIPRJMOD} to kicad-embed:// in the above.

[set-soft]

@oliv3r : KiBot can also export your project containing all the 3D models, the copy_files output can do it using source_type: prj

[oliv3r]

No denying that! I was just trying to help explain self-contained. And I do use this for other reasons myself (and when using it via the cli this works too) I think its a little chicken and egg story when looking at CI workflows.