LuxCoreRender Wiki - Recent changes [en]

Deploying LuxCoreRender

CodeHD — Tue, 05 May 2026 20:31:11 GMT

Documentation and Announcements

← Older revision		Revision as of 22:31, 5 May 2026
(One intermediate revision by the same user not shown)
Line 159:		Line 159:

	== Documentation and Announcements ==		== Documentation and Announcements ==
	~~'''THIS SECTION IS WORK IN PROGRESS (CodeHD, 23.04.2026)'''~~

	Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.		Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.
	Furthermore, the final step after release and deployment is to announce the release to the ~~communicate~~.		Furthermore, the final step after release and deployment is to announce the release to the community.

	The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:		The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:
	* This wiki		* This wiki, particularly
	** ~~particularly~~ the ~~pages linked on the front page~~		** Release notes
			** FAQ entries
			** Updates to the build process
			** Description of new features, API and SDL documentation
	* The project website		* The project website
	** particularly the downloads section		** particularly the downloads section
Line 174:		Line 176:
	* Announcement on the forums		* Announcement on the forums
	* Announcement in the discord channel		* Announcement in the discord channel
	* Announcement on Blenderartist		* Announcement on Blenderartist, ...

	During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.		During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.

	==== Alpha ====		==== Alpha ====
			* Update the release notes
			* Update the API/SDL description
			* Check the authors file and credits list
			* Brief GitHub release notes with warning labels about stability
			* Announcement on the most active user channels
			* Decide on final tasks/known bugs that shall be fixed during alpha/beta phase

	==== Beta ====		==== Beta ====
			* Keep updating release notes and API/SDL documentation
			* Update the Readme files in the code base
			* Start preparing a summary release notes for the GitHub release
			* Announcement of beta phase on more community channels
			* Complete all tasks for features/known bugfixes

	==== Release Candidate ====		==== Release Candidate ====
			* All documentation shall be updated fully
			* Update FAQs with feedback from alpha/beta phase
			* Double check authors and credits
			* GitHub release notes still should contain a warning label
			* Start preparing stable release announcement messages for all channels

	==== Stable (X.Y.0) ====		==== Stable (X.Y.0) ====
	~~At this point~~, ~~all~~		* Double-check all documentation
			* Prepare the final release notes summary
			* Create the release
			* Update the download section on the website
			* Create the announcement post on the forums
			* Finally, announce on Discord and optionally other sites

	==== Bugfix (X.Y.Z) ====		==== Bugfix (X.Y.Z) ====
Line 192:		Line 215:
	* Prepare a summary release notes targeted at users		* Prepare a summary release notes targeted at users
	** This needs to only include the incremental changes from the previous version		** This needs to only include the incremental changes from the previous version
	* Make a short announcement on the same channels as the ~~Stable~~ release		* Make a short announcement on the same channels as the for the stable release

Building LuxCoreRender - FAQ

Howetuft — Tue, 28 Apr 2026 03:22:34 GMT

← Older revision		Revision as of 05:22, 28 April 2026
Line 63:		Line 63:

	== Can I generate debug information for dependencies (LuxCoreDeps)? ==		== Can I generate debug information for dependencies (LuxCoreDeps)? ==
	Yes, it's possible, but only for local build~~, at the moment~~.		Yes, it's possible, but only for local build.

	In this context, the build type is controlled by <code>DEPS_BUILD_TYPE</code> environment variable, so set it to your target build type before building:		In this context, the build type is controlled by <code>DEPS_BUILD_TYPE</code> environment variable, so set it to your target build type before building:
Line 69:		Line 69:
	<pre>export DEPS_BUILD_TYPE=Debug</pre>		<pre>export DEPS_BUILD_TYPE=Debug</pre>

			Then you will build the deps with [[Building_LuxCoreRender#Local_Plain_Build\|local plain build]].

	After having built dependencies in local, you may want to inject them in LuxCore build. This can be done with the following:		After having built dependencies in local, you may want to inject them in LuxCore build. This can be done with the following:
Line 75:		Line 76:

	(this replaces <code>make deps</code>)		(this replaces <code>make deps</code>)

			At this stage, you will be able to build LuxCore artifacts, embedding the debug information of dependencies, for instance:
			<pre>
			export LUX_BUILD_TYPE=Debug
			make wheel-test # If the previous steps have been completed, the testing wheel will contain deps' debug info
			</pre>

			Remark: in this scenario, do not build the dependencies with CI local build, as the deps source files should be inaccessible at the end of the build, what should make the deps debug info useless.

	== How can I build a sanitized version of LuxCore? ==		== How can I build a sanitized version of LuxCore? ==

Building LuxCoreRender

Howetuft — Tue, 28 Apr 2026 03:10:49 GMT

Caveats

← Older revision		Revision as of 05:10, 28 April 2026
(2 intermediate revisions by the same user not shown)
Line 306:		Line 306:
	==== Caveats ====		==== Caveats ====
	Dependency local plain build is possible but:		Dependency local plain build is possible but:
	* Local plain build IS NOT THE RECOMMENDED BUILD ~~for final deps~~. This build is solely intended for intermediary development and debugging. No support will be provided when used out-of-scope.		* Local plain build IS NOT THE RECOMMENDED BUILD FOR FINAL DEPS. This build is solely intended for intermediary development and debugging. No support will be provided when used out-of-scope.
	* Local plain build has only be tested on Linux, with gcc >=14. For other platforms, adaptations should be necessary (contributions welcome).		* Local plain build has only been tested on Linux, with gcc >=14. For other platforms, adaptations should be necessary (contributions welcome).
	* Local plain build is much impacted by local particulars (local compiler version, dependencies already in cache or in system dirs etc.) and therefore does not guarantee further success for other ~~(recommended)~~ builds.		* Local plain build is much impacted by local particulars (local compiler version, dependencies already in cache or in system dirs etc.) and therefore does not guarantee further success for other builds.

	==== Prerequisites ====		==== Prerequisites ====
Line 333:		Line 333:
	export CXX_VERSION=20		export CXX_VERSION=20
	export CMAKE_POLICY_VERSION_MINIMUM=3.25		export CMAKE_POLICY_VERSION_MINIMUM=3.25
	export DEPS_BUILD_TYPE=~~Release~~ # Or ~~Debug~~/RelWithDebInfo/MinSizeRel, as needed		export DEPS_BUILD_TYPE=Debug # Or Release/RelWithDebInfo/MinSizeRel, as needed
	export cache_dir		export cache_dir

Building LuxCoreRender - FAQ

Howetuft — Sun, 26 Apr 2026 14:44:07 GMT

How can I build a sanitized version of LuxCore?

@@ Line 11: / Line 11: @@
 * Step#2: Inject local dependencies in LuxCore build
-<pre>python -m build-system.luxmake deps --local <path/to/deps> --release test</pre>
+<pre>python -m build-system.luxmake.deps --local <path/to/deps> --release test</pre>
@@ Line 32: / Line 32: @@
 == Can I use <code>git bisect</code>? ==
-Yes, if you need to find a faulty commit, you can use <code>git bisect</code>.
+Yes, if you need to find a faulty commit in <code>LuxCore</code>, you can use <code>git bisect</code>.
 In that case, please note the correct verb to build LuxCoreRender at each step is
@@ Line 63: / Line 63: @@
 == Can I generate debug information for dependencies (LuxCoreDeps)? ==
-Yes, it's possible, but only for local dependency build, at the moment.
+Yes, it's possible, but only for local build, at the moment.
 In this context, the build type is controlled by <code>DEPS_BUILD_TYPE</code> environment variable, so set it to your target build type before building:
 <pre>export DEPS_BUILD_TYPE=Debug</pre>

Building LuxCoreRender

Howetuft — Fri, 24 Apr 2026 04:19:31 GMT

Run

← Older revision		Revision as of 06:19, 24 April 2026
(6 intermediate revisions by the same user not shown)
Line 305:		Line 305:
	=== Local Plain Build ===		=== Local Plain Build ===
	==== Caveats ====		==== Caveats ====
			Dependency local plain build is possible but:
	* Local plain build IS NOT THE RECOMMENDED BUILD for final deps. This build is solely intended for intermediary development and debugging. No support will be provided when used out-of-scope.		* Local plain build IS NOT THE RECOMMENDED BUILD for final deps. This build is solely intended for intermediary development and debugging. No support will be provided when used out-of-scope.
	* Local plain build has only be tested on Linux, with gcc >=14. For other platforms, adaptations should be necessary (contributions welcome).		* Local plain build has only be tested on Linux, with gcc >=14. For other platforms, adaptations should be necessary (contributions welcome).
Line 310:		Line 311:

	==== Prerequisites ====		==== Prerequisites ====
	In addition with general [[#Prerequisites_2 \| Prerequisites]], you'll need ~~oneAPI~~ ISPC compiler.		In addition with general [[#Prerequisites_2 \| Prerequisites]], you'll need the OneAPI ISPC compiler.

	==== Conan cache interaction ====		==== Conan cache interaction ====
Line 332:		Line 333:
	export CXX_VERSION=20		export CXX_VERSION=20
	export CMAKE_POLICY_VERSION_MINIMUM=3.25		export CMAKE_POLICY_VERSION_MINIMUM=3.25
			export DEPS_BUILD_TYPE=Release # Or Debug/RelWithDebInfo/MinSizeRel, as needed
	export cache_dir		export cache_dir

Building LuxCoreRender - FAQ

Howetuft — Fri, 24 Apr 2026 04:10:57 GMT

Can I generate debug information for dependencies (LuxCoreDeps)?

← Older revision		Revision as of 06:10, 24 April 2026
(One intermediate revision by the same user not shown)
Line 61:		Line 61:
	git bisect reset		git bisect reset
	</pre>		</pre>

			== Can I generate debug information for dependencies (LuxCoreDeps)? ==
			Yes, it's possible, but only for local dependency build, at the moment.

			In this context, the build type is controlled by <code>DEPS_BUILD_TYPE</code> environment variable, so set it to your target build type before building:

			<pre>export DEPS_BUILD_TYPE=Debug</pre>

LuxCoreRender Wiki

Howetuft — Fri, 24 Apr 2026 04:02:53 GMT

LuxCore and BlendLuxCore Documentation

← Older revision		Revision as of 06:02, 24 April 2026
Line 28:		Line 28:
	* [[ C++ Coding Guidelines ]]		* [[ C++ Coding Guidelines ]]

	==== Deploying ====		==== Releasing & Deploying ====
	* [[ Deploying LuxCoreRender \| Releasing and Deploying LuxCoreRender ]]		* [[ Deploying LuxCoreRender \| Releasing and Deploying LuxCoreRender ]]
	* [[ LuxCoreRender_Release_Notes \| LuxCoreRender Release Notes ]]		* [[ LuxCoreRender_Release_Notes \| LuxCoreRender Release Notes ]]

Deploying LuxCoreRender

CodeHD — Thu, 23 Apr 2026 18:21:13 GMT

Announcements

@@ Line 158: / Line 158: @@
 * For latest releases, publish the files on the website
-== Announcements ==
+== Documentation and Announcements ==
-<To be completed by @codehd>
+'''THIS SECTION IS WORK IN PROGRESS (CodeHD, 23.04.2026)'''

LuxCoreRender Wiki

Howetuft — Wed, 22 Apr 2026 19:04:24 GMT

Documentation

← Older revision		Revision as of 21:04, 22 April 2026
(7 intermediate revisions by the same user not shown)
Line 20:		Line 20:
	== Developers & Admins ==		== Developers & Admins ==

	=== Documentation ===		=== LuxCore and BlendLuxCore Documentation ===

			==== Building & Debugging ====
	* [[ Building_LuxCoreRender \| Building LuxCoreRender ]]		* [[ Building_LuxCoreRender \| Building LuxCoreRender ]]
	* [[ Building LuxCoreRender - FAQ \| FAQ - Building & Debugging ~~LuxCoreRender~~ ]]		* [[ Developing and debugging BlendLuxCore ]]
			* [[ Building LuxCoreRender - FAQ \| FAQ - Building & Debugging ]]
			* [[ C++ Coding Guidelines ]]

			==== Deploying ====
	* [[ Deploying LuxCoreRender \| Releasing and Deploying LuxCoreRender ]]		* [[ Deploying LuxCoreRender \| Releasing and Deploying LuxCoreRender ]]
	* [[ ~~C++ Coding Guidelines~~ ]]		* [[ LuxCoreRender_Release_Notes \| LuxCoreRender Release Notes ]]

			==== Maintaining ====
	* [[ Regular Maintenance Tasks ]]		* [[ Regular Maintenance Tasks ]]
	* [[ Developing and debugging BlendLuxCore ]]
	* [[ Compiling_LuxCore \| Building LuxCoreRender (legacy) ]]		==== Interfacing ====
	* [[ LuxCoreRender_Release_Notes \| LuxCoreRender Release Notes ]]
	* [[ LuxCore_API \| LuxCore API ]]		* [[ LuxCore_API \| LuxCore API ]]
	* [[ LuxCore_API_Reference_Manual \| LuxCore API Reference Manual]]		* [[ LuxCore_API_Reference_Manual \| LuxCore API Reference Manual]]
	* [[ LuxCore_SDL_Reference_Manual \| LuxCore SDL Reference Manual ]]		* [[ LuxCore_SDL_Reference_Manual \| LuxCore SDL Reference Manual ]]

			==== Legacy ====
			* [[ Compiling_LuxCore \| Building LuxCoreRender (legacy) ]]

	=== MaxToLux Documentation ===		=== MaxToLux Documentation ===

Deploying LuxCoreRender

Howetuft — Mon, 20 Apr 2026 05:13:15 GMT

Samples Release and Deployment

← Older revision		Revision as of 07:13, 20 April 2026
(9 intermediate revisions by the same user not shown)
Line 66:		Line 66:

	At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each): the space required for one release is about 1.5GB. As a consequence, the space sufficiency must be checked each time a version has to be deployed.		At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each): the space required for one release is about 1.5GB. As a consequence, the space sufficiency must be checked each time a version has to be deployed.

			Nota: this check is <i>critical</i> and should be done with care. If the upload to PyPI is interrupted halfway, for instance by lack of space, the version number will still become no more available.

	= Procedure =		= Procedure =
Line 75:		Line 77:
	* Check LuxCore buildability: run the 3 actions listed above.		* Check LuxCore buildability: run the 3 actions listed above.
	* Ensure the change log is available		* Ensure the change log is available
	* Define and check Release Version Numbers (one for LuxCore and one for BlendLuxCore): they should have been neither allocated before, ~~nor~~ used on PyPI.		* Define and check Release Version Numbers (one for LuxCore and one for BlendLuxCore): they should have been neither allocated before, and the LuxCore should not have been used on PyPI.
	* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.		* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Line 82:		Line 84:
	== Wheels Release and Deployment ==		== Wheels Release and Deployment ==

	* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the targeted version number for ~~wheels~~.		* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the targeted version number for LuxCore.

	* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:		* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:
	Branch: <code>master</code>		Branch: <i><code>master</code></i>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Update existing release (if any): <i>~~Unchecked~~</i>		Update existing release (if any): <i>unchecked</i>
	Rebuild all: <i>~~Checked~~</i>		Rebuild all: <i>checked</i>

	This will build the wheels and create a release in draft mode.		This will build the wheels and create a release in draft mode.
Line 101:		Line 103:
	Branch: <i><code>master</code></i>		Branch: <i><code>master</code></i>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Run on PyPI test: <i>~~Checked~~</i>		Run on PyPI test: <i>checked</i>
	This will upload the wheels to PyPI test (deployment - test).		This will upload the wheels to PyPI test (deployment - test).
	~~(this~~ is a test step, before uploadig to real PyPI)		This is a test step, to check everything is fine before uploadig to real PyPI.


Line 109:		Line 111:
	Branch: <code>master</code>		Branch: <code>master</code>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Run on PyPI test: <i>~~Unchecked~~</i>		Run on PyPI test: <i>unchecked</i>
	This will upload the wheels to PyPI (deployment).		This will upload the wheels to PyPI (deployment).

Line 119:		Line 121:
	Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...		Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

	Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts ~~and thus to clear~~ 'rebuild all' in the following action.		Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.


Line 125:		Line 127:
	Branch: <i>main</i>		Branch: <i>main</i>
	Version: <i>the version number you selected before</i>		Version: <i>the version number you selected before</i>
	Update existing release (if any): <i>~~Unchecked~~</i>		Update existing release (if any): <i>unchecked</i>
	Rebuild all: <i>~~Unchecked~~</i>		Rebuild all: <i>unchecked</i>

	At this stage, a <i>draft release</i> should have been created.		At this stage, a <i>draft release</i> should have been created.
Line 136:		Line 138:
	== BlendLuxCore Release and Deployment ==		== BlendLuxCore Release and Deployment ==

	Important warning: BLC should <b>not</b> be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.		Important warning: BLC should <b>not</b> be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:


	* In <code>luxloader/__init__.py</code>, set <code>PYLUXCORE_VERSION</code> to the version of related <code>pyluxcore</code>. The version to use must be strictly the same the one that appears on PyPI. Please check syntax carefully, as PyPI may slightly modify version number when uploading.		* In <code>luxloader/__init__.py</code>, set <code>PYLUXCORE_VERSION</code> to the version of related <code>pyluxcore</code>. The version to use must be strictly the same as the one that appears on PyPI. Please check syntax carefully, as PyPI may slightly modify version number when uploading.

	* In <code>blender_manifest.toml</code>, set <code>version</code> parameter to the targeted version of BLC. Caveat: this version can differ from pyluxcore version defined above.		* In <code>blender_manifest.toml</code>, set <code>version</code> parameter to the targeted version of BLC. Caveat: this version can differ from pyluxcore version defined above.