Welcome to Karamba3D Scripting Guide

The official scripting guide using Karamba3D 1.3.3

This manual describes how to use Karamba3D inside C#-scripts. Since C# is a member of the .NET family everything said also applies to code in IronPython, F#, Visual Basic or any other scripting language being based on the Common Language Infrastructure (CLI).

This manual is not an introduction to C#. For introductional material see e.g. [1] or [3]. More advanced topics – useful yet not necessary for reading this manual – can be found in the fantastic book “C# in Depth” see [4].

The previous version of this guide contained sections on how to integrate Karamba3D (K3D) in Java, C++ and native Python. Judging from user feedback these options are not widely used. This is why those chapters where left out in this manual. Instead this manual dwells more on the C#-interface of Karamba3D.

Examples detailed in this guide can be found in the "Karamba3D Scripting Examples Github"-collection.

The help files (“Karamba3D_1_3_3_SDKDoc.chm”) can be found inside this archive, which is also accessible online: Karamba3D 1.3.3 SDK Documentation.

Navigate through the following chapters below or in the menu on the left.

Citing Karamba3D

In case you use Karamba3D for your scientific work, please cite the following paper:

Preisinger, C. (2013), Linking Structure and Parametric Geometry. Architectural Design, 83: 110-113 DOI: 10.1002/ad.1564.


Although being tested thoroughly Karamba3D probably contains errors – therefore no guarantee can be given that Karamba3D computes correct results. Use of Karamba3D is entirely at your own risk. Please read the license agreement that comes with Karamba3D in case of further questions.

This manual is written by Clemens Preisinger. Editing by Georg Lobe.