LuxCoreRender: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Removed the Render_project links.)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:1-->
<!--T:1-->
{{VeryImportantMessage|LuxCoreRender is not officially supported by the [[Raytracing Workbench|Raytracing Workbench]], it is instead supported by the by the new [https://github.com/FreeCAD/FreeCAD-render Render Workbench], which is intended as its replacement. This must not be confused with the halted and outdated [[Render_project|Render project]]. The Render Workbench can be installed through the [[AddonManager|Addon Manager]].
{{VeryImportantMessage|LuxCoreRender is not officially supported by the [[Raytracing_Workbench|Raytracing Workbench]], it is instead supported by the by the new [https://github.com/FreeCAD/FreeCAD-render Render Workbench], which is intended as its replacement. The Render Workbench can be installed through the [[Std_AddonMgr|Addon Manager]].}}
}}


=Description= <!--T:2-->
=Description= <!--T:2-->

[https://luxcorerender.org LuxCoreRender] is a phisically based rendering engine, reboot of the now outdated [[LuxRender]]. It is not officially supported by the [[Raytracing Workbench|Raytracing Workbench]], although it might work.
<!--T:40-->
[https://luxcorerender.org LuxCoreRender] is a physically based rendering engine, reboot of the now outdated [[LuxRender|LuxRender]]. It is not officially supported by the [[Raytracing_Workbench|Raytracing Workbench]], although it might work.


=Installation= <!--T:3-->
=Installation= <!--T:3-->
==Raytracing Workbench==
{{VeryImportantMessage|Officially the [[Ray Tracing Workbench|Raytracing workbench]] does not work with LuxCoreRender, only with the outdated [[LuxRender]]. Also the [[Ray Tracing Workbench|Raytracing workbench]] is being superseded by the new [https://github.com/FreeCAD/FreeCAD-render Render Workbench], which is intended as its replacement. This must not be confused with the halted and outdated [[Render_project|Render project]]. The Render Workbench can be installed through the [[AddonManager|Addon Manager]]. The information here is provided because by default FreeCAD is still shipped (as of 0.19-24276) with the Raytracing Workbench}}


===Stable Version=== <!--T:4-->
==Raytracing Workbench== <!--T:41-->

<!--T:42-->
{{VeryImportantMessage|Officially the [[Raytracing_Workbench|Raytracing workbench]] does not work with LuxCoreRender, only with the outdated [[LuxRender|LuxRender]]. Also the [[Raytracing_Workbench|Raytracing workbench]] is being superseded by the new [https://github.com/FreeCAD/FreeCAD-render Render Workbench], which is intended as its replacement. The Render Workbench can be installed through the [[Std_AddonMgr|Addon Manager]]. The information here is provided because by default FreeCAD is still shipped (as of 0.19-24276) with the Raytracing Workbench}}

===Stable Version=== <!--T:43-->

<!--T:4-->
LuxCoreRender is under active development, so to know which is the [https://github.com/LuxCoreRender/LuxCore/releases/latest latest stable version check on GitHub].
LuxCoreRender is under active development, so to know which is the [https://github.com/LuxCoreRender/LuxCore/releases/latest latest stable version check on GitHub].


====Linux==== <!--T:5-->
====Linux==== <!--T:44-->

<!--T:5-->
'''''Compiled binaries'''''
'''''Compiled binaries'''''


Line 37: Line 46:


<!--T:11-->
<!--T:11-->
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences_Editor|Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].


<!--T:12-->
<!--T:12-->
Set the Luxrender executable path to point to your installation of LuxCoreRender, usually it is ''/usr/bin/luxcoreui'' (or if you installed it manually something like ''~/LuxCoreRender/luxcoreui''), and apply.
Set the Luxrender executable path to point to your installation of LuxCoreRender, usually it is ''/usr/bin/luxcoreui'' (or if you installed it manually something like ''~/LuxCoreRender/luxcoreui''), and apply.


====macOS==== <!--T:13-->
====macOS==== <!--T:45-->

<!--T:13-->
[https://github.com/LuxCoreRender/LuxCore/releases/latest Check on GitHub for the latest stable release], scroll down to the ''Assets'' section (expand it if needed) and download the macOS file. It will be something like ''luxcorerender-{version number}-mac64.dmg''.
[https://github.com/LuxCoreRender/LuxCore/releases/latest Check on GitHub for the latest stable release], scroll down to the ''Assets'' section (expand it if needed) and download the macOS file. It will be something like ''luxcorerender-{version number}-mac64.dmg''.


====Windows==== <!--T:14-->
====Windows==== <!--T:46-->

<!--T:14-->
[https://github.com/LuxCoreRender/LuxCore/releases/latest Check on GitHub for the latest stable release], scroll down to the ''Assets'' section (expand it if needed) and download the Windows file. It will be something like ''luxcorerender-{version number}-win64.zip''.
[https://github.com/LuxCoreRender/LuxCore/releases/latest Check on GitHub for the latest stable release], scroll down to the ''Assets'' section (expand it if needed) and download the Windows file. It will be something like ''luxcorerender-{version number}-win64.zip''.


Line 53: Line 66:


<!--T:16-->
<!--T:16-->
After installing dependancies, extract the downloaded archive in a suitable folder, like ''C:\Tools\LuxCoreRender''.
After installing dependencies, extract the downloaded archive in a suitable folder, like ''C:\Tools\LuxCoreRender''.
Avoid using system folders like ''C:\Program Files'' or ''C:\Program Files (x86)''.
Avoid using system folders like ''C:\Program Files'' or ''C:\Program Files (x86)''.


<!--T:17-->
<!--T:17-->
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences_Editor|Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].


<!--T:18-->
<!--T:18-->
Set the Luxrender executable path to point to your installation of LuxCoreRender, that will be something like ''C:/Tools/LuxCoreRender/luxcoreui.exe'', and apply.
Set the Luxrender executable path to point to your installation of LuxCoreRender, that will be something like ''C:/Tools/LuxCoreRender/luxcoreui.exe'', and apply.


===Development Version=== <!--T:19-->
===Development Version=== <!--T:47-->

<!--T:19-->
LuxCoreRender is under active development, so to know which is the [https://github.com/LuxCoreRender/LuxCore/releases latest development version] you have to manually check on GitHub for the latest marked as Pre-release.
LuxCoreRender is under active development, so to know which is the [https://github.com/LuxCoreRender/LuxCore/releases latest development version] you have to manually check on GitHub for the latest marked as Pre-release.


====Linux==== <!--T:20-->
====Linux==== <!--T:48-->

<!--T:20-->
'''''Compiled binaries'''''
'''''Compiled binaries'''''


Line 87: Line 104:


<!--T:26-->
<!--T:26-->
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences_Editor|Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].


<!--T:27-->
<!--T:27-->
Set the Luxrender executable path to point to your installation of LuxCoreRender, usually it is ''/usr/bin/luxcoreui'' (or if you installed it manually something like ''~/LuxCoreRender/luxcoreui''), and apply.
Set the Luxrender executable path to point to your installation of LuxCoreRender, usually it is ''/usr/bin/luxcoreui'' (or if you installed it manually something like ''~/LuxCoreRender/luxcoreui''), and apply.


====macOS==== <!--T:49-->


====macOS==== <!--T:28-->
<!--T:28-->
[https://github.com/LuxCoreRender/LuxCore/releases Check on GitHub for the latest development version], marked as Pre-release, scroll down to the ''Assets'' section (expand it if needed) and download the Windows file. It will be something like ''luxcorerender-{version number}-mac64.dmg'' or ''luxcorerender-latest-mac64.dmg''.
[https://github.com/LuxCoreRender/LuxCore/releases Check on GitHub for the latest development version], marked as Pre-release, scroll down to the ''Assets'' section (expand it if needed) and download the Windows file. It will be something like ''luxcorerender-{version number}-mac64.dmg'' or ''luxcorerender-latest-mac64.dmg''.


====Windows==== <!--T:29-->
====Windows==== <!--T:50-->

<!--T:29-->
[https://github.com/LuxCoreRender/LuxCore/releases Check on GitHub for the latest development version], marked as Pre-release, scroll down to the ''Assets'' section (expand it if needed) and download the Windows file. It will be something like ''luxcorerender-{version number}-win64.zip'' or ''luxcorerender-latest-win64.zip''.
[https://github.com/LuxCoreRender/LuxCore/releases Check on GitHub for the latest development version], marked as Pre-release, scroll down to the ''Assets'' section (expand it if needed) and download the Windows file. It will be something like ''luxcorerender-{version number}-win64.zip'' or ''luxcorerender-latest-win64.zip''.


Line 104: Line 124:


<!--T:31-->
<!--T:31-->
After installing dependancies, extract the downloaded archive in a suitable folder, like ''C:\Tools\LuxCoreRender''.
After installing dependencies, extract the downloaded archive in a suitable folder, like ''C:\Tools\LuxCoreRender''.
Avoid using system folders like ''C:\Program Files'' or ''C:\Program Files (x86)''.
Avoid using system folders like ''C:\Program Files'' or ''C:\Program Files (x86)''.


<!--T:32-->
<!--T:32-->
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].
After installing LuxCoreRender, launch FreeCAD, open the [[Preferences_Editor|Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Raytracing Workbench]], and go to the [[Raytracing_Preferences|Raytracing Preferences]].


<!--T:33-->
<!--T:33-->
Set the Luxrender executable path to point to your installation of LuxCoreRender, that will be something like ''C:/Tools/LuxCoreRender/luxcoreui.exe'', and apply.
Set the Luxrender executable path to point to your installation of LuxCoreRender, that will be something like ''C:/Tools/LuxCoreRender/luxcoreui.exe'', and apply.


==Render Workbench== <!--T:34-->
==Render Workbench== <!--T:51-->

<!--T:34-->
As of now there are no significant differences between the Raytracing Workbench and the Render Workbench in the part regarding the installation of the external software, so refer to the [[LuxCoreRender#Raytracing_Workbench|Raytracing Workbench section]] to install LuxCoreRender and to this section for the Render Workbench configuration.
As of now there are no significant differences between the Raytracing Workbench and the Render Workbench in the part regarding the installation of the external software, so refer to the [[LuxCoreRender#Raytracing_Workbench|Raytracing Workbench section]] to install LuxCoreRender and to this section for the Render Workbench configuration.


<!--T:35-->
<!--T:35-->
First of all install the Render Workbench through the [[Addon Manager]] and restart FreeCAD.
First of all install the Render Workbench through the [[Std_AddonMgr|Addon Manager]] and restart FreeCAD.


====Linux==== <!--T:36-->
====Linux==== <!--T:52-->

After installing the Render Workbench and LuxCoreRender, launch FreeCAD, open the [[Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Render Workbench]], and go to the Render Preferences.
<!--T:36-->
After installing the Render Workbench and LuxCoreRender, launch FreeCAD, open the [[Preferences_Editor|Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Render Workbench]], and go to the Render Preferences.


<!--T:37-->
<!--T:37-->
Set the LuxCore UI path to point to your installation of LuxCoreRender, usually it is ''/usr/bin/luxcoreui'' (or if you installed it manually something like ''~/LuxCoreRender/luxcoreui''), and apply.
Set the LuxCore UI path to point to your installation of LuxCoreRender, usually it is ''/usr/bin/luxcoreui'' (or if you installed it manually something like ''~/LuxCoreRender/luxcoreui''), and apply.


====Windows==== <!--T:38-->
====Windows==== <!--T:53-->

After installing the Render Workbench and LuxCoreRender, launch FreeCAD, open the [[Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Render Workbench]], and go to the Render Preferences.
<!--T:38-->
After installing the Render Workbench and LuxCoreRender, launch FreeCAD, open the [[Preferences_Editor|Preferences Editor]], [[Preferences_Editor#Unloaded_Workbenches|load the Render Workbench]], and go to the Render Preferences.


<!--T:39-->
<!--T:39-->
Set the LuxCore command (cli) path, something like ''C:/Tools/LuxCore/pyluxcoretool.exe'' and LuxCore UI path, something like ''C:/Tools/LuxCore/luxcoreui.exe'', then apply.
Set the LuxCore command (cli) path, something like ''C:/Tools/LuxCore/pyluxcoretool.exe'' and LuxCore UI path, something like ''C:/Tools/LuxCore/luxcoreui.exe'', then apply.

</translate>
</translate>

Latest revision as of 20:34, 4 March 2022

LuxCoreRender is not officially supported by the Raytracing Workbench, it is instead supported by the by the new Render Workbench, which is intended as its replacement. The Render Workbench can be installed through the Addon Manager.

Description

LuxCoreRender is a physically based rendering engine, reboot of the now outdated LuxRender. It is not officially supported by the Raytracing Workbench, although it might work.

Installation

Raytracing Workbench

Officially the Raytracing workbench does not work with LuxCoreRender, only with the outdated LuxRender. Also the Raytracing workbench is being superseded by the new Render Workbench, which is intended as its replacement. The Render Workbench can be installed through the Addon Manager. The information here is provided because by default FreeCAD is still shipped (as of 0.19-24276) with the Raytracing Workbench

Stable Version

LuxCoreRender is under active development, so to know which is the latest stable version check on GitHub.

Linux

Compiled binaries

If your distribution has it in the official repositories, you can install LuxCoreRender and all the relative dependencies through the package manager. Such distributions include: Arch Linux (AUR), Fedora.

Otherwise it is possible to download the official binaries of the latest stable release from GitHub. The file will be something like luxcorerender-{version number}-linux64.tar.bz2. The faster solution (although not the best practice) is to extract the content of the archive in a suitable location, like ~/LuxCoreRender. If needed change the file permissions so that your user can execute the files you just extracted.

Compiling from source

If your distributions does not have LuxCoreRender in the repositories and the official binaries do not work on your computer, or you wish to, it is possible to compile LuxCoreRender from source. The latest stable release includes the source, that will be something like 'luxcorerender-{version number}.tar.bz2

Configuring FreeCAD

After installing LuxCoreRender, launch FreeCAD, open the Preferences Editor, load the Raytracing Workbench, and go to the Raytracing Preferences.

Set the Luxrender executable path to point to your installation of LuxCoreRender, usually it is /usr/bin/luxcoreui (or if you installed it manually something like ~/LuxCoreRender/luxcoreui), and apply.

macOS

Check on GitHub for the latest stable release, scroll down to the Assets section (expand it if needed) and download the macOS file. It will be something like luxcorerender-{version number}-mac64.dmg.

Windows

Check on GitHub for the latest stable release, scroll down to the Assets section (expand it if needed) and download the Windows file. It will be something like luxcorerender-{version number}-win64.zip.

Then check in the note above the assets if there are any notes about dependencies for Windows user. For example to use LuxRender 2.5 you are required to install the Microsoft Visual C++ Redistributable for Visual Studio 2017 and the Intel C++ redistributable.

After installing dependencies, extract the downloaded archive in a suitable folder, like C:\Tools\LuxCoreRender. Avoid using system folders like C:\Program Files or C:\Program Files (x86).

After installing LuxCoreRender, launch FreeCAD, open the Preferences Editor, load the Raytracing Workbench, and go to the Raytracing Preferences.

Set the Luxrender executable path to point to your installation of LuxCoreRender, that will be something like C:/Tools/LuxCoreRender/luxcoreui.exe, and apply.

Development Version

LuxCoreRender is under active development, so to know which is the latest development version you have to manually check on GitHub for the latest marked as Pre-release.

Linux

Compiled binaries

If your distribution has it in the official repositories, you can install LuxCoreRender development version and all the relative dependencies through the package manager. Such distributions include: Arch Linux (AUR).

Otherwise it is possible to download the official binaries of the latest development version, marked as Pre-release, from GitHub. The file will be something like luxcorerender-{version number}-linux64.tar.bz2 or luxcorerender-latest-linux64.tar.bz2. The faster solution (although not the best practice) is to extract the content of the archive in a suitable location, like ~/LuxCoreRender. If needed change the file permissions so that your user can execute the files you just extracted.

Compiling from source

If your distributions does not have LuxCoreRender development in the repositories and the official binaries do not work on your computer, or you wish to, it is possible to compile LuxCoreRender from source. Check GitHub for the latest development version, marked as Pre-release that includes the source, that will be something like 'luxcorerender-{version number}.tar.bz2

Configuring FreeCAD

After installing LuxCoreRender, launch FreeCAD, open the Preferences Editor, load the Raytracing Workbench, and go to the Raytracing Preferences.

Set the Luxrender executable path to point to your installation of LuxCoreRender, usually it is /usr/bin/luxcoreui (or if you installed it manually something like ~/LuxCoreRender/luxcoreui), and apply.

macOS

Check on GitHub for the latest development version, marked as Pre-release, scroll down to the Assets section (expand it if needed) and download the Windows file. It will be something like luxcorerender-{version number}-mac64.dmg or luxcorerender-latest-mac64.dmg.

Windows

Check on GitHub for the latest development version, marked as Pre-release, scroll down to the Assets section (expand it if needed) and download the Windows file. It will be something like luxcorerender-{version number}-win64.zip or luxcorerender-latest-win64.zip.

Then check in the note above the assets if there are any notes about dependencies for Windows user. For example to use LuxRender 2.5rc1 you are required to install the Microsoft Visual C++ Redistributable for Visual Studio 2017 and the Intel C++ redistributable.

After installing dependencies, extract the downloaded archive in a suitable folder, like C:\Tools\LuxCoreRender. Avoid using system folders like C:\Program Files or C:\Program Files (x86).

After installing LuxCoreRender, launch FreeCAD, open the Preferences Editor, load the Raytracing Workbench, and go to the Raytracing Preferences.

Set the Luxrender executable path to point to your installation of LuxCoreRender, that will be something like C:/Tools/LuxCoreRender/luxcoreui.exe, and apply.

Render Workbench

As of now there are no significant differences between the Raytracing Workbench and the Render Workbench in the part regarding the installation of the external software, so refer to the Raytracing Workbench section to install LuxCoreRender and to this section for the Render Workbench configuration.

First of all install the Render Workbench through the Addon Manager and restart FreeCAD.

Linux

After installing the Render Workbench and LuxCoreRender, launch FreeCAD, open the Preferences Editor, load the Render Workbench, and go to the Render Preferences.

Set the LuxCore UI path to point to your installation of LuxCoreRender, usually it is /usr/bin/luxcoreui (or if you installed it manually something like ~/LuxCoreRender/luxcoreui), and apply.

Windows

After installing the Render Workbench and LuxCoreRender, launch FreeCAD, open the Preferences Editor, load the Render Workbench, and go to the Render Preferences.

Set the LuxCore command (cli) path, something like C:/Tools/LuxCore/pyluxcoretool.exe and LuxCore UI path, something like C:/Tools/LuxCore/luxcoreui.exe, then apply.