Export blender scenes to the Nori educational raytracer. Proposed and used by many in the Computer Graphics course at ETH Zurich, Fall 2020, and more recently, in the Modelling and Simulation of Appearance course at Universidad de Zaragoza
This was originally an extension and partial reimplementation to the legacy Nori plugin for Blender 2.80+ (tested on 2.90). Now, it has been adapted for modern versions of Blender (>=4.0), which introduced many breaking changes in the scripting API.
In order to use this plugin, you need to install an appropriate Blender version. This extension supports versions of Blender 4.0 and above. If you are using a Blender version below 4.0, please refer to the legacy Nori plugin. You will also need a working executable of the Nori renderer in order to test your scenes and your implementation.
The in-depth instructions with screenshots can be found at the Wiki.
Firstly, you can download the appropriate version from the Releases tab. After that, open Blender and go to Edit -> Preferences -> Add-ons. On the top-right corner, open the drop down and install the .zip file. Finally, enable "Export Nori scenes format.". Then, you can export your scene from File -> Export -> Export Nori scenes... .
Alternatively, if you want to try the latest source distribution, you can clone this repo and copy the io_nori folder into the scripts/addons folder of your Blender distribution.
- Only "visible" objects are exported, so by switching the eye icon of your objects on/off you can decide what to export.
- Object instances are also supported. The exporter silently unrolls the instances into a single mesh, exports it and sets it back to the state before.
- By enabling the option "Export lights", the exporter will export : Point Lights as point lights and Objects with a "Emission" BSDF as area lights. Thus, you can export mesh area lights to Nori. Note: For now Blender area lights are not exported (they only support simple geometry). When "Export lights" is selected, the default integrator is "path_mis", otherwise "normals".
- By enabling the option "Export BSDF properties", the exporter will export the mesh and add a translated BSDF entry to the xml file for this object (multiple materials for different faces of a single object are also supported). Otherwise, a diffuse BSDF with the viewport color of the object is added to the XML. The following translations are currently available:
- Principled BSDF -> disney
- Diffuse BSDF -> diffuse
- Specular -> mirror
- Glass BSDF -> dielectric (also exports values for rough dielectric, so change the name in the xml afterwards if you have implemented this)
- Glossy BSDF -> Microfacet
- All other materials will be exported as diffuse. If you have some kind of hierarchical materials (mix shader etc), the exporter will do some heuristics to decide what to export, so change it afterwards in the XML.
- By enabling the option "Export textures", the exporter adds a texture to your BSDF entry if available. Note that only image textures are supported atm. If no texture is found, the default BSDF color is exported. To use this feature, add an Image Texture Node and connect it to the "Color" or "Base Color" socket of your object. The path to the image will be copied relative to the blender file for now, so if you want to use the output right away save the XML in the same folder as the blender file.
- The checkbox "Export OBJ in world coords" defines how your obj files are exported: If enabled, we export the mesh in world coordinates of Blender. Otherwise, we export the mesh in local coordinates and add a toWorld transform to the XML entry.
- The checkbox "Triangular Mesh" exports all your meshes as triangular meshes. This is helpful if your mesh has complex polygons that Nori does not support. Note that after this export your mesh in Blender stays triangular.
- The "Number of Camera Rays" input box sets the sampleCount parameter of your sampler.
Note that the Plugin is in an early stage and thus might have its problems/limitations. I would be happy to hear your feedback, so we could improve this together. I hope it helps someone in their final projects!
The Nori description doesn't work!
Note that this plugin creates the skeleton for the Nori scene description, but you will have to tweak some things yourself!
The description works, but Nori throws an exception while reading LDR textures!
Nori only accepts 1/2/4/8-bit PNG textures, so you will have to convert them to this format first.
The UV mappings are mirrored! What do I do?
This is a known issue but I haven't found a solution yet, but from what I know, it probably comes from Blender, which flips the UVs. As a workaround, you can flip the UVs manually in Blender in order to fit the texture correctly.