9.0 KiB
kcl-samples
KittyCAD Language (KCL) is our language for defining geometry and working with our Geometry Engine efficiently.
This repository includes a mixture of simple and complex models demonstrating the features and syntax of KCL.
The samples can be browsed in our documentation at https://zoo.dev/docs/kcl-samples.
Guidelines for adding samples
KCL samples conform to a set of style guidelines to ensure consistency and readability.
-
File Naming: Name your KCL files descriptively and concisely, using hyphens to separate words (e.g., flange.kcl, ball-bearing.kcl).
-
File Header: Include a title comment at the top of each file, followed by a brief description explaining what the model is and its typical use cases.
-
Inline Comments: Use inline comments to explain non-obvious parts of the code. Each major section should have a comment describing its purpose.
-
Constants: Define constants at the beginning of your KCL files for any values that might change or need to be reused (e.g., dimensions, angles).
Snapshot and export
When you submit a PR to add or modify KCL samples, images and STEP files will be generated and added to the repository automatically.
3d-boaty (step) (screenshot)
80-20-rail (step) (screenshot)
a-parametric-bearing-pillow-block (step) (screenshot)
ball-bearing (step) (screenshot)
bracket (step) (screenshot)
car-wheel-assembly (step) (screenshot)
color-cube (step) (screenshot)
cycloidal-gear (step) (screenshot)
dodecahedron (step) (screenshot)
enclosure (step) (screenshot)
exhaust-manifold (step) (screenshot)
flange-with-patterns (step) (screenshot)
flange-xy (step) (screenshot)
focusrite-scarlett-mounting-bracket (step) (screenshot)
food-service-spatula (step) (screenshot)
french-press (step) (screenshot)
gear-rack (step) (screenshot)
gear (step) (screenshot)
gridfinity-baseplate-magnets (step) (screenshot)
gridfinity-baseplate (step) (screenshot)
gridfinity-bins-stacking-lip (step) (screenshot)
gridfinity-bins (step) (screenshot)
hex-nut (step) (screenshot)
i-beam (step) (screenshot)
kitt (step) (screenshot)
lego (step) (screenshot)
mounting-plate (step) (screenshot)
multi-axis-robot (step) (screenshot)
pipe-flange-assembly (step) (screenshot)
pipe-with-bend (step) (screenshot)
pipe (step) (screenshot)
poopy-shoe (step) (screenshot)
router-template-cross-bar (step) (screenshot)
router-template-slate (step) (screenshot)
sheet-metal-bracket (step) (screenshot)
socket-head-cap-screw (step) (screenshot)
walkie-talkie (step) (screenshot)
washer (step) (screenshot)
