Repository files navigation

dort is a physically based renderer. It is still under heavy development, sodo not expect it to be usable in general (and correct in particular).

dort carries most of its dependencies in the repository (inextern/), theonly library that is necessary by default islibz.

To builddort, one also needs a C++ compiler (clang andgcc shouldwork),objcopy (part of GNU binutils), andtup.tup can be downloadedfromhttp://gittup.org/tup/, either as a build-it-yourself repository or as aUbuntu package.

The build can be configured using filetup.config (see the templatetup.config.default). By default, only the development version of the programis built; other versions can be enabled usingCONFIG_FAST=y (fast, optimizedbuild) orCONFIG_SLOW=y (slow, debug build). The different versions of thebinary will be built in different directories:

• development version --build/d/dort
• fast version --build/f/dort
• debug version --build/g/dort

To build all enabled versions, runtup. Usetup build/{d,f,g}/dort tocompile only a single version.

If enabled,dort can also link to Gtk to support a simplistic GUI, but this issomewhat deprecated and will probably be removed in the future. Otherwise, theonly runtime dependency is to the defaultlibc, other libraries should belinked in statically.

The produceddort binary is a Lua interpreter that exposes the rendering APIin Lua. To run a Lua program, invokedort <program.lua>.

To obtain the documentation of the Lua API, installldoc and runldoc . in the repository.The generated documentation will be stored in.ldoc/. We do not publish thedocumentation on a public website becausedort is not quite ready for thisyet.

Example Lua scripts that render images are stored in thesamples/ directory.Do not be deceived into openingexamples/! It contains various files that havebeen used during development and that were convenient to store in git.

Some historical images documenting the progress of development can be found inimages/.