LumixEngine

Non-programmers

You can get Lumix Engine from itch.io or download standalone zip file from actions.

Programmers - Windows

Prerequisites

• Visual Studio 2022 or compatible - MinGW is not supported

Download bootstrap batch file and run it. The bootstrap file requires git in %PATH. It will fetch the repository, create Visual Studio solution and open it. After that you can build the solution and run the editor. If something fails or you do not want to use the batch file, execute these 4 steps manually

1. Download source code.
2. Run scripts\genie.exe vs2022, it genereates VS solution.
3. Open VS solution scripts\tmp\vs2022\LumixEngine.sln.

Video tutorial

Making game in C++

1. Download Lumix Engine source code.
2. Run scripts/plugins.bat.
3. Choose Empty plugin template.
4. Create a solution (e.g. run scripts/create_vs22_sln.bat).
5. Put your game code in plugins/myplugin/src.
6. Build and run the project.

Programmers - Linux

Linux is supported only up to 64b66124cb5e6d5bc8e7f11f129c0d5c63f2268a revision. Linux in newer versions is work in progress.

See this shell script. It will fetch the repository, create makefile, build it and run the editor.

• Note: the shell script needs git, make and g++ accessible
• Note: to build using clang, call ./genie --gcc=linux-clang gmake
• Note: to build using clang & ninja, call ./genie --gcc=linux-clang ninja

Video tutorial

Programmers - Windows + Ninja + Clang

As an alternative to building with MSVC, Clang can be used. Since it’s not the primary way to build the engine, it’s a bit more involved.

Prerequisities

• Clang
• Ninja

Both can be installed with Visual Studio installer or in any other way. Unlike when building with MSVC, there’s no bootstrap script for clang, neither are there prebuilt 3rd party libraries.

1. Download source code.
2. Run scripts/download_physx.bat to download Physx.
3. Run scripts/download_luau.bat to Download Luau.
4. Run scripts/download_freetype.bat to Download FreeType2.
5. Run scripts\genie.exe --gcc=windows-clang ninja, it genereates ninja files in tmp/ninja.
6. Run ninja in scripts\tmp\ninja\debug64 or scripts\tmp\ninja\relwithdebinfo64.

This site is open source. Improve this page.