Difference between revisions of "Compiling Luanti"

Latest revision as of 17:55, 28 October 2024

This page is about how to compile Luanti yourself.

Official compilation instructions

We strongly recommend you read the Luanti README file. It covers most of the important platforms.

Unofficial compilation instructions

The community has written several unofficial guides to compile Luanti on unusual or rare platforms. Proceed only if the README was not enough.

Tread carefully from this point on.

GNU/Linux

One-line script for installing/compiling Luanti Git, for Debian / Ubuntu / Mint

Windows

For compiling Luanti on Windows using MSYS2, see Compiling on Windows using MSYS2.

For compiling Luanti on Windows using MSVC, see the Luanti README.

Cross-compilation

To compile a win32 version of Luanti in Linux with MinGW you can use the build script in utils/buildbot/buildwin32.sh.

To compile a win64 version of Luanti in Linux with MinGW you can use the build script in utils/buildbot/buildwin64.sh.

If you have errors during cross compilation related to std::thread and std::mutex, this is due to mingw-w64 being incorrectly configured for cross compilation.

To fix the errors, use the command:

For 64-bit builds: sudo update-alternatives --config x86_64-w64-mingw32-g++

For 32-bit Ubuntu Builds: sudo update-alternatives --config i686-w64-mingw32-g++

For 32-bit Debian Builds: sudo update-alternatives --config i586-w64-mingw32-g++

When provided with a prompt for which version to select, please choose "posix". Then retry the buildwin32.sh or buildwin64.sh

@@ Line 1: / Line 1: @@
-== Compiling on GNU/Linux ==
+This page is about how to compile Luanti yourself.
-'''''Triple-click to select a whole line. Use <kbd>Ctrl + Shift + V</kbd> to paste in a terminal.'''''
+== Official compilation instructions ==
-Install dependencies. Here's an example for Debian-based and Ubuntu-based distributions:
+We strongly recommend you read the [https://github.com/minetest/minetest#compiling Luanti README file]. It covers most of the important platforms.
-<pre>
-apt-get install build-essential cmake git libirrlicht-dev libbz2-dev libgettextpo-dev
-libfreetype6-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev
-libogg-dev libvorbis-dev libopenal-dev libhiredis-dev libcurl3-dev
-</pre>
-Download engine:
+== Unofficial compilation instructions ==
-<pre>
+The community has written several unofficial guides to compile Luanti on unusual or rare platforms. Proceed only if the README was not enough.
-git clone https://github.com/minetest/minetest.git
-cd minetest/
-</pre>
-Download Minetest Game (otherwise only the "Minimal development test" game is available)
+'''Tread carefully from this point on.'''
-<pre>
-cd games/
-git clone https://github.com/minetest/minetest_game.git
-cd ../
-</pre>
-Build the game (the <code>make</code> command is set to automatically detect the number of CPU threads to use):
+=== GNU/Linux ===
-<pre>
-cmake . -DENABLE_GETTEXT=1 -DENABLE_FREETYPE=1 -DENABLE_LEVELDB=1 -DENABLE_REDIS=1
-make -j$(grep -c processor /proc/cpuinfo)
-</pre>
-Run it:
+[http://forum.minetest.net/viewtopic.php?f=3&t=3837 One-line script for installing/compiling Luanti Git, for Debian / Ubuntu / Mint]
-<pre>
-cd bin/
-./minetest
-</pre>
-* Use <code>cmake . -LH</code> to see all CMake options and their current state.
+=== Windows ===
-* If you want to place user data in the same directory as the Minetest build (good for putting on removable media), you will want to use <code>-DRUN_IN_PLACE=1</code>.
+For compiling Luanti on Windows using MSYS2, see [https://wiki.voxelmanip.se/Compiling_on_Windows_using_MSYS2 Compiling on Windows using MSYS2].
-* You can build a bare server or a bare client by specifying <code>-DBUILD_CLIENT=0</code> or <code>-DBUILD_SERVER=0</code>.
-* You can select between a Release and Debug build by <code>-DCMAKE_BUILD_TYPE=<Debug or Release></code>.
-:* Debug build is slower, but gives much more useful output in a debugger.
-=== Building without Irrlicht / X dependency ===
+For compiling Luanti on Windows using MSVC, see the [https://github.com/minetest/minetest#compiling-on-windows-using-msvc Luanti README].
-You can build the Minetest server without library dependencies to Irrlicht or any graphical stuff. You still need the Irrlicht headers for this, so first, download the irrlicht source to somewhere.
+=== Cross-compilation ===
+To compile a win32 version of Luanti in Linux with [https://en.wikipedia.org/wiki/MinGW MinGW] you can use the build script in <code>[https://github.com/minetest/minetest/blob/master/util/buildbot/buildwin32.sh utils/buildbot/buildwin32.sh]</code>.
-When invoking CMake, use <code>-DBUILD_CLIENT=0 -DIRRLICHT_SOURCE_DIR=/wherever/you/unzipped/the/source</code>.
+To compile a win64 version of Luanti in Linux with [https://en.wikipedia.org/wiki/MinGW MinGW] you can use the build script in <code>[https://github.com/minetest/minetest/blob/master/util/buildbot/buildwin32.sh utils/buildbot/buildwin64.sh]</code>.
-=== See also ===
+If you have errors during cross compilation related to std::thread and std::mutex, this is due to mingw-w64 being incorrectly configured for cross compilation.
-* [http://forum.minetest.net/viewtopic.php?f=3&t=3837 One-line script for installing/compiling Minetest Git, for Debian / Ubuntu / Mint]
-== Compiling on Windows ==
+To fix the errors, use the command:
-=== Prerequisites ===
+For 64-bit builds: <code> sudo update-alternatives --config x86_64-w64-mingw32-g++ </code>
-* [http://www.cmake.org/download/ CMake]
+For 32-bit Ubuntu Builds: <code> sudo update-alternatives --config i686-w64-mingw32-g++ </code>
-* OpenAL [http://connect.creativelabs.com/openal/Downloads/Forms/AllItems.aspx], [http://web.archive.org/web/20130629072358/http://connect.creativelabs.com/openal/Downloads/Forms/AllItems.aspx] or [http://sfan5.duckdns.org/upload/data/oalinst.exe]
-* [http://www.mingw.org MinGW] or [http://msdn.microsoft.com/en-us/vstudio/default Visual Studio]
-* [http://irrlicht.sourceforge.net/downloads.html Irrlicht SDK 1.8]
-* zlib headers (zlib125.zip) and
-:zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip) [http://www.winimage.com/zLibDll/index.html]
-* Optional: [http://gnuwin32.sourceforge.net/downlinks/gettext.php gettext library and tools]:
-:This is used for other UI languages. Feel free to leave it out.
-* libvorbis 1.3.3:
-:[http://www.dll-files.com/dllindex/dll-files.shtml?libvorbis library]
-:[http://xiph.org/downloads/ headers]
-* libvorbisfile
-:[http://www.dll-files.com/dllindex/dll-files.shtml?libvorbisfile library]
-:headers: libvorbis/include
-* libogg
-:[http://www.dlldump.com/download-dll-files_new.php/dllfiles/L/libogg.dll/-/download.html library]
-:[http://xiph.org/downloads/ headers]
-* Alternatively download the [https://www.dropbox.com/s/r4u925x60ol6q1q/Minetest_MSVC_Win32_libraries_compiled.7z MSVC pre-compiled libraries]
-* And, of course, [https://github.com/minetest/minetest ''Minetest''] (Git clone recommended)
-=== Steps ===
+For 32-bit Debian Builds: <code> sudo update-alternatives --config i586-w64-mingw32-g++ </code>
-    - Select a directory called DIR hereafter in which you will operate.
-    - Make sure you have CMake and a compiler (MinGW or MSVC) installed.
-    - Download all other libraries and extract them into your DIR.
-      ("extract here", not "extract to packagename/")
-      {{Template:Note|zlib125dll.zip needs to be extracted into zlib125dll}}
-    - All those packages contain a nice base directory in them, which
-      should end up being the direct subdirectories of DIR.
-    - You will end up with a directory structure like this (+ dir, - file):
-    -----------------
-    + DIR
-        - oalinst.exe
-        - zlib-1.2.5.tar.gz
-        - zlib125dll.zip
-        ...
-        - 110214175330.zip (or whatever, this is the minetest source)
-        + gettext (optional, for multi language)
-            + bin
-            + include
-            + lib
-        + irrlicht-1.8.1
-            + lib
-            + include
-            ...
-        + libogg-1.3.1.zip
-            + lib
-            + include
-            ...
-        + libvorbis-1.3.3.zip
-            + lib
-            + include
-             ...
-        + minetest
-            + src
-            + doc
-            - CMakeLists.txt
-            ...
-        + minetest-build
-        + zlib-1.2.5
-            - zlib.h
-            + win32
-            ...
-        + zlib125dll
-            - readme.txt
-            + dll32
-            ...
-    -----------------
-    - Start up the CMake GUI
-    - Select "Browse Source..." and select DIR/minetest
-    - Now, if using MSVC:
-        - Select "Browse Build..." and select DIR/minetest-build
-    - Else if using MinGW:
-        - Select "Browse Build..." and select DIR/minetest
-    - Select "Configure"
-    - Select your compiler
-    - It will warn about missing stuff, ignore that at this point. (later don't)
-    - Make sure the configuration is as follows
-      (note that the versions may differ for you):
-    BUILD_CLIENT               [X]
+When provided with a prompt for which version to select, please choose "posix". Then retry the buildwin32.sh or buildwin64.sh
-    BUILD_SERVER               [ ]
-    CMAKE_BUILD_TYPE           Release
-    CMAKE_INSTALL_PREFIX       DIR/minetest-install
-    RUN_IN_PLACE               [X]
-    WARN_ALL                   [ ]
-    GETTEXT_BIN_DIR            DIR/gettext/bin
-    GETTEXT_INCLUDE_DIR        DIR/gettext/include
-    GETTEXT_LIBRARIES          DIR/gettext/lib/intl.lib
-    IRRLICHT_SOURCE_DIR        DIR/irrlicht-1.8.1
-    IRRLICHT_LIBRARY           DIR/irrlicht-1.8.1/lib/?/Irrlicht.lib
-    OGG_INCLUDE_DIR            DIR/libogg-1.3.1/include
-    OGG_LIBRARIES              DIR/libogg-1.3.1/?/libogg.lib
-    VORBIS_INCLUDE_DIR         DIR/libvorbis-1.3.3/include
-    VORBIS_LIBRARY             DIR/libvorbis-1.3.3/?/libvorbis.lib
-    VORBISFILE_INCLUDE_DIR     DIR/libvorbis-1.3.3/include
-    VORBISFILE_LIBRARIES       DIR/libvorbisfile.dll
-    OPENAL_INCLUDE_DIR         %programfiles%\OpenAL\include
-    OPENAL_LIBRARY             %programfiles%\OpenAL\lib\OpenAL32.lib
-    ZLIB_DLL                   DIR/zlib125dll/dll32/zlibwapi.dll
-    ZLIB_INCLUDE_DIR           DIR/zlib-1.2.5
-    ZLIB_LIBRARIES             DIR/zlib125dll/dll32/zlibwapi.lib
-    - See also: [http://nimg.pf-control.de/MTstuff/Compile_Minetest_MSVC.txt Differently explained CMake setup]
-    - Hit "Configure", two times 8)
-    - If something is still coloured red, you have a problem.
-    - Hit "Generate"
-    If using MSVC:
-        - Open the generated minetest.sln
-        - Switch the configuration from "Debug" to "Release", unless you want to
-        debug some stuff (it's slower and might not even work at all)
-        - Build the ALL_BUILD project
-        - Build the INSTALL project
-        You may want to use console commands to compile Minetest:
-            - Find MSBuild.exe in %windir%\Microsoft.NET\Framework\v?.?.?\MSBuild.exe
-            - Add the path to your system PATH variable
-            - Compile Minetest by switching to your DIR\minetest-build
-                MSBuild.exe ALL_BUILD.vcxproj /p:Configuration=Release
-        - You should now have a working game with the executable in
-            DIR/minetest-install/bin/minetest.exe
-        - Additionally you may create a zip package by building the PACKAGE
-          project.
-    If using MinGW:
-        - Using the command line, browse to the build directory and run 'make'
-          (or mingw32-make or whatever it happens to be)
-        - You may need to copy some of the downloaded DLLs into bin/, see what
-          running the produced executable tells you it doesn't have.
-        - You should now have a working game with the executable in
-            DIR/minetest/bin/minetest.exe
-== Cross-compilation ==
-To compile a win32 version of Minetest in Linux with [https://en.wikipedia.org/wiki/MinGW MinGW] you can use the build script in <code>[https://github.com/minetest/minetest/blob/master/util/buildbot/buildwin32.sh utils/buildbot/buildwin32.sh]</code>.
-== Full Windows build ==
-'''[[Build Win32 minetest including all required libraries]]'''
 [[Category:Core Engine]]
-[[Category:Compiling Minetest]]
+[[Category:Compiling Luanti]]