LuxBlend 2.5 installation instructions - LuxRender Wiki
Luxrender GPL Physically Based Renderer

LuxBlend 2.5 installation instructions

Personal tools

From LuxRender Wiki

Jump to: navigation, search

This page contains installation instructions for LuxBlend25, LuxRender's interface and export script for Blender 2.6x and 2.7x.

LuxBlend will only work with LuxRender 1.0 or higher (preferably the latest stable version), not with earlier versions. Please be aware that LuxBlend for Blender 2.49 is a different script and will not work on Blender 2.5x/2.6x or any release after it.


Installing LuxBlend

1. Download LuxRender

Download the latest stable release of LuxRender from the LuxRender main page. Extract the download and put it in a convenient location (for example in the Program Files folder on Windows). The download also includes LuxBlend, the interface and export script for Blender.

2. Install LuxBlend script

Start Blender and open user preferences and go to the addons tab. Click Install addon and select the LuxBlend zip file from where you extracted the LuxRender download in step 1. LuxRender will show up as an option, click it once and wait a few seconds until it's enabled. Blender will extract the zip and place the files where they belong.

3. Add the path to LuxRender in Blender

Click the Show More Info arrow and enter the path to the LuxRender installation where you extracted the files in step 1. Save User Settings and close the preferences window. Select LuxRender from the list of render engines on the Info bar. Save Startup File to have LuxRender as the default render engine.


3.b. LuxRender settings in Blender

This page shows which options you might want to set - GPU_in_blender while it describes it for GPU users, everyone can use it as well.

4. Material previews

(Windows only) In order to get material previews in the materials tab in Blender you will need one more thing. Download and install the one you need of these two. If you don't know which one, get them both.
32 bit:
64 bit:

5. That's it!

You now have LuxRender and the LuxBlend script installed and with material previews from within Blender.
When getting started with LuxRender it's recommended to have a look at the new user tips and tricks, frequently asked questions, common error messages and of course the LuxRender manual.

The LuxBlend script uses Blender's system console (Window > Toggle System Console) to provide information and error messages, so it's good practice to check there in case LuxRender doesn't start when you hit render (missing path to LuxRender from step 3, no lights in the scene and such).

6. Troubleshooting

If you have troubles activating the add-on, please restart Blender and try again. As with any script issue, you may be able to find more information on the issue in Blender's console. On OS X or Linux, you can see this by starting Blender from a terminal. On Windows, you can bring it up using Window > Toggle System Console. If this still doesn't work there is a workaround: download a .blend file that has LuxBlend activated (for example here), open it in Blender and save preferences. Please note that unfortunately this will overwrite your preferences.

For more help be sure to check out New_User_Tips_and_Tricks.

Installing development builds

This section is meant for installing the latest development code. If you are new to LuxRender please use the section above instead for installing LuxBlend. Development builds are not required to get LuxRender up and running.

A. Download LuxRender

Download LuxRender for the operating system you use. Only LuxRender 1.0 and 1.1 works well with Blender 2.6x; Older versions do not. Either get LuxRender from the main page or get a weekly build from the forum. Extract the download and put it in a convenient location. If your download includes a LuxBlend install package, follow the included instructions for installing it or proceed to step B.

B. Get LuxBlend

(Skip this step if you installed LuxBlend in step A.)
The very latest development version can be found here:

Once you have downloaded the zip file and unpacked it, you should see a folder called "src" inside the "luxblend25" folder. Inside the "src" folder there is a folder called "luxrender". Copy this "luxrender" folder (the folder, not just the contents) into your <blender scripts>/addons/ folder. The exact location of the folder we are looking for depends on your operating system:

  1. on Windows XP, it is either in Program Files\Blender Foundation\Blender\.blender\scripts\addons (or C:\Program Files\blender-2.60-windows32\2.63\scripts\addons) or C:\Documents and Settings\[username]\Application Data\Blender Foundation\Blender\2.63\scripts\addons. This latter folder is normally hidden, so you may need to make hidden folders visible first. Note that "2.63" corresponds to your Blender your version number, newer releases will have their own folder.
  2. on Vista and Windows 7 it may either be the same location as XP or otherwise C:\Users\[username]\AppData\Roaming\Blender Foundation\Blender\2.63\scripts\addons. This folder is normally hidden, so you may need to make hidden folders visible first.
  3. on Linux it should be /usr/lib/blender/scripts/addons. (Blender currently says /home/$user/.config/blender/$version/scripts/addons source:
  4. for OS X, please follow the instructions that are part of the LuxRender download. However, if you are doing a completely manual install, such as for a development build, check /Users/[username]/Applications Support/Blender/2.63/scripts/addons. Note that "2.63" corresponds to your Blender your version number, newer releases will have their own folder.

You should end up with the following structure: <blender scripts>/addons/luxrender/ which contains an file and several other directories.

Then, copy the content of the "preset" folder (inside the "src" folder of luxblend25) in the "preset" folder of Blender: <blender scripts>/presets/, thus giving you the following structure: <blender scripts>/presets/luxrender/engine/ which contains lots of python scripts.

C. Get Pylux /PyluxCore

Pylux is a binary add-on for LuxBlend25 which will allow you to do fully integrated rendering inside Blender. PyluxCore is a complimentary library for the next-gen LuxRender architecture (a.k.a. Lux 2.0) serving the same purpose.

On Windows the Pylux file is called pylux.pyd and comes with the LuxBlend download, on Linux and Mac OS X it's called And PyluxCore library is called pyluxcore.pyd or respectively. If you have a copy, you can copy the pylux / pyluxcore file into the folder <blender scripts>/addons/luxrender/. On OS X and Linux, do the same with the file called liblux.dylib or Finally, if you have OpenImageIO library in your Lux distribution, copy its file too.

D. Activate LuxBlend25 within Blender

After installing the addon, you should see an entry for LuxRender in User Preferences -> Add-Ons -> Render, where you can enable the exporter. Please note that it may take a few seconds for the box to be checked after you click it, so click it once and wait a few seconds while Blender copies some files.

In Blender's Info window (the bar at the top), select LuxRender as your render engine. This changes the available options in the properties window, giving you control over LuxRender’s own render settings. Note that some of the panels (such as the dimensions and output panels) don't change as they contain settings that are shared between render engines.

E. Add the path to LuxRender in Blender

Next you need to tell the LuxBlend script where to find LuxRender. Go to the User Preferences, navigate to Addons -> Render -> LuxRender and select the path to the LuxRender installation where you extracted the download in step A. Save user settings (CTRL-U) to have LuxRender as the default render engine and to save the path to the LuxRender installation.

User prefs.PNG