|
1 | | - |
| 1 | +# BlendLuxCore |
2 | 2 |
|
3 | | -<sup> [LuxCoreRender.org](https://luxcorerender.org/) | [Forums](https://forums.luxcorerender.org/) | [Wiki](http://wiki.luxcorerender.org/LuxCoreRender_Wiki) </sup> |
| 3 | + |
| 4 | + |
| 5 | +This addon integrates the LuxCore render engine into Blender. It offers advanced features like accelerated rendering of indirect light and efficient rendering of caustics. |
4 | 6 |
|
5 | 7 | ## BlendLuxCore Wheels |
6 | 8 |
|
7 | | -This addon integrates the LuxCore render engine into Blender. It offers advanced features like accelerated rendering of indirect light and efficient rendering of caustics. |
| 9 | +**This is a special, experimental version of the add-on, based on LuxCore Python wheels.** |
| 10 | +**This version is not recommended for production use.** |
8 | 11 |
|
9 | | -**This is a special, experimental version of the add-on, based on LuxCore Python wheels.** It may not be suitable for production use. |
| 12 | +## Supported Blender Versions |
10 | 13 |
|
11 | | -### Supported Blender Versions |
| 14 | +* Blender 4.2+ is supported by the latest version |
| 15 | +Supported platforms are Windows, Linux, MacOS Intel, MacOS ARM |
12 | 16 |
|
13 | | -* Blender 4.2 is supported for Windows, Linux, MacOS Intel, MacOS ARM |
| 17 | +**Old BlendLuxCore releases (non-wheel):** |
| 18 | +* Blender 2.93 is supported by BlendLuxCore v2.6. |
| 19 | +* Blender 2.83-2.92 are supported by BlendLuxCore v2.5. |
| 20 | +* Blender 2.83 is supported by BlendLuxCore v2.4. |
| 21 | +* Blender 2.80, 2.81 and 2.82 are supported by BlendLuxCore v2.2 and v2.3. |
| 22 | +* Blender 2.79 is supported by BlendLuxCore v2.0, v2.1 and v2.2. |
| 23 | +Supported platforms are Windows, Linux, MacOS Intel |
14 | 24 |
|
15 | | -### Installation |
| 25 | +## Installation |
16 | 26 |
|
17 | | -#### From latest release (recommended) |
| 27 | +### From latest release (recommended) |
18 | 28 |
|
19 | | -- Find latest release of **BlendLuxCore Wheels** (https://github.com/LuxCoreRender/BlendLuxCore/releases). Caveat: do not get confused with plain BlendLuxCore. |
20 | | -- From the release assets, download extension `BlendLuxCore*.zip` |
| 29 | +- Find the latest suitable release of **BlendLuxCore Wheels** on the release page: |
| 30 | +https://github.com/LuxCoreRender/BlendLuxCore/releases |
| 31 | +(Caveat: do not get confused with plain BlendLuxCore!) |
| 32 | +- Note: the release labelled "latest" is a nightly build and may be particularly unstable even compared to alpha or beta release versions! |
| 33 | +- From the release assets, download extension `BlendLuxCore-*.zip` |
21 | 34 | - Open Blender and follow "Install from disk" procedure (https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html) |
22 | 35 |
|
23 | | -Beforehand, you may want to uninstall previous version of BlendLuxCore: look in "Get Extensions" panel. |
| 36 | +Beforehand, you may want to uninstall previous version of BlendLuxCore: look in the "Get Extensions" panel. |
24 | 37 |
|
25 | | -#### From last commit |
| 38 | +### Building locally from source |
26 | 39 |
|
27 | 40 | Prerequisites: you need `cmake` and `blender` installed and in your `PATH` |
28 | 41 |
|
29 | 42 | Build extension: |
30 | 43 | - clone this repository: `git clone https://github.com/LuxCoreRender/BlendLuxCore.git --branch for_blender_4.2_wheels` |
31 | | -- configure: `cmake -S BlendLuxCore -B blc-build` |
| 44 | +- configure: `cmake -S BlendLuxCore -B blc-build -DCMAKE_BUILD_TYPE=Release` |
32 | 45 | - build: `cmake --build blc-build` |
33 | 46 |
|
34 | | -The extension should be in `blc-build` subfolder |
| 47 | +To create a `Latest` release, use the option `-DCMAKE_BUILD_TYPE=Latest` in the step `configure`. |
| 48 | + |
| 49 | +The build script then places the collected zip-file in the `blc-build` subfolder. |
35 | 50 |
|
36 | 51 | Open Blender and follow "Install from disk" procedure (https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html) |
37 | 52 |
|
38 | | -Beforehand, you may want to uninstall previous version of BlendLuxCore: see in "Get Extensions" panel. |
| 53 | +Beforehand, you may want to uninstall previous version of BlendLuxCore: look in the "Get Extensions" panel. |
39 | 54 |
|
40 | | -### [Gallery](https://luxcorerender.org/gallery/) |
| 55 | +## Links |
41 | 56 |
|
42 | | -### [Download example test scenes](https://luxcorerender.org/example-scenes/) |
| 57 | +**Homepage:** **https://luxcorerender.org/** |
| 58 | +**Forums:** **https://forums.luxcorerender.org/** |
| 59 | +**Wiki:** **https://wiki.luxcorerender.org/** |
| 60 | +**Discord:** **https://discord.com/invite/chPGsKV** |
| 61 | +**Gallery:** **https://luxcorerender.org/gallery/** |
| 62 | +**Example Scenes:** **https://luxcorerender.org/example-scenes/** |
0 commit comments