Difference between revisions of "Compiling ScummVM/MinGW-w64"

Revision as of 10:12, 4 February 2024

NOTE

Compiling with MinGw-w64 should currently be used only for debug builds, as the executable is linked dynamically with the MinGW libraries. Release builds should be done using MXE if possible, since this allows building an (almost) statically linked executable for easy distribution. Feel free to contact me (rootfather) either via eMail or IRC if you have questions regarding MSYS2/MinGW-w64.

Prepare your build environment

Setup MinGW-w64 and MSYS2

You can find MSYS2 on the official webpage and detailed installation instructions on the MSYS2 github wiki.

The MinGW packages are named mingw-<env>-<package>, where <env> is either x86_64 or i686, depending on your architecture (64-bit and 32-bit, respectively).

To create an i686 or x86_64 build environment, we need to first update the already installed packages and the MSYS2 environment itself. To do that, type the following in the MSYS2 terminal:

pacman -Syuu

Follow the instructions (one upgrade step may require that the MSYS2 terminal window is closed directly from the window's e(X)it button on the top right. Keep issuing the above command in the MSYS2 terminal until there's no more updating tasks to be done.

In order to install all required tools and libraries, open the MinGW shell matching the architecture you want to build for (32 or 64 bits) and use the following command:

pacman -S --needed --noconfirm base-devel git ${MINGW_PACKAGE_PREFIX}-{a52dec,binutils,ccache,cairo,curl-winssl,faad2,freetype,flac,fluidsynth,fribidi,libjpeg-turbo,libogg,libvorbis,libvpx,libmad,libmpeg2-git,libtheora,libpng,lld,nasm,readline,SDL2,SDL2_net,toolchain,winsparkle,zlib,ntldd-git,libmikmod}

These commands will fetch and install the packages needed for compiling, including (but not limited to) GCC 12.x, GDB, and libwinpthread-git.

Additionally, if you would like to include Discord Rich Presence support, the pre-compiled libraries are here. Simply copy the files into your base MinGW directory.

Let's get compiling!

Finally, we are ready to compile the project! To do that, just open a MinGW-w64 shell (not the MSYS2 shell), navigate to the source folder where you have cloned scummvm.git, and type the following commands:

 ./configure
 make -j$(nproc)

Note: Depending on what you are working on, have a look at ./configure --help. Sometimes, you want to enable some features or engines that are disabled by default, while working on a specific engine won't require a full build at all.

If everything went well, you should have a big executable in the compilation folder, named scummvm.exe. The size of the executable comes from the debug symbols embedded in the file, so you can run the following command to shrink it:

 strip scummvm.exe

Please note that using this step is not necessary if you build a distributable package.

That's it, you successfully compiled ScummVM from the source code.

Ship required libraries for running ScummVM on a "non-MSYS2" machine

In case you want to distribute your builds to machines without a running MSYS2 installation or if you excluded MSYS2/Mingw-w64 from your PATH, you need to bundle the required .dll files with the executable - otherwise, running ScummVM will fail due to missing dependencies.

If you intend to build a ScummVM package that includes all the necessary files, you can build such a redistributable package by using

 make win32dist-mingw WIN32PATH=<target>

where <target> specifies the directory that will contain the redistributable packages.

Common Issues

If configure fails to find required libraries such as SDL, make sure that you have all the required libraries available for the target system and that you are using the correct MinGW shell (32-bit vs 64-bit)
If the executable compiles correctly, but you get a "somelibrary.dll missing" error when executing it, you just need to add the following path to your PATH variable: <installdir>/msys<env>/mingw64/bin/

If the configure script gives an error about using msys mode, please make sure you are running the mingw-w64 win32 shell or the mingw-w64 win64 shell, and not the msys2 shell from the MSYS2 package, when building ScummVM.

Notes

Despite the name, MinGW-w64 works on both 32-bit and 64-bit systems, but the latest versions cannot be installed on Windows XP anymore. However, builds produced will still work on Windows XP.

MinGW-w64 and MSYS2 is a fork of MinGW. If you wish to compile with the (older) MinGW toolset, e.g. to support versions older than Windows XP, check out MinGW and MSYS

MinGW-w64 makes heavy use of the pacman package manager, which may not be available under other MinGW setups

@@ Line 4: / Line 4: @@
 |- style="margin-left:1em; background:#ffffff;"
 |- style="background:#ffffff"
-| This guide covers '''only''' the compilation under MinGW-w64 and MSYS2 (which is very different from MinGW and MSYS), and makes heavy use of the pacman package manager, which may not be available under other MinGW setups.
+| Compiling with MinGw-w64 should currently be used only for debug builds, as the executable is linked dynamically with the MinGW libraries. Release builds should be done using [[Compiling ScummVM/MXE|MXE]] if possible, since this allows building an (almost) statically linked executable for easy distribution. Feel free to contact me (rootfather) either via eMail or IRC if you have questions regarding MSYS2/MinGW-w64.
-'''We do not (officially) support building in this way''' and we don't recommend using this method if you want to distribute your ScummVM builds.
-However, we offer preliminary support for the MSYS2/MinGW-w64 toolchain. Feel free to contact me (rootfather) either via eMail or IRC if you have questions regarding MSYS2/MinGW-w64.
-Our officially supported MinGW build instructions are at [[Compiling_ScummVM/MinGW]].
 |}
-== Things needed ==
+== Prepare your build environment ==
 === Setup MinGW-w64 and MSYS2 ===
+You can find [https://www.msys2.org/ MSYS2 on the official webpage] and detailed installation instructions on the [https://github.com/msys2/msys2/wiki/MSYS2-installation MSYS2 github wiki].
-You can find MSYS2 and installation instructions on the [[https://msys2.github.io/ MSYS2 webpage]].
+The MinGW packages are named <code>mingw-<env>-<package></code>, where <code><env></code> is either x86_64 or i686, depending on your architecture (64-bit and 32-bit, respectively).
-==== Download and install the mingw-w64 compilation toolchain====
-The MinGW packages are named mingw-<env>-<package>, where <env> is either x86_64 or i686, depending on your architecture (64-bit and 32-bit, respectively).
 To create an i686 or x86_64 build environment, we need to first update the already installed packages and the MSYS2 environment itself.
 To do that, type the following in the MSYS2 terminal:
-<source lang="bash">
+<syntaxhighlight lang="bash">
-pacman --noconfirm -Sy
+pacman -Syuu
-pacman --needed --noconfirm -S bash pacman pacman-mirrors msys2-runtime
+</syntaxhighlight>
-</source>
-For i686 (32-bit), type the following in the MSYS2 terminal to automatically install all the needed packages:
+Follow the instructions (one upgrade step may require that the MSYS2 terminal window is closed directly from the window's e(X)it button on the top right. Keep issuing the above command in the MSYS2 terminal until there's no more updating tasks to be done.
-<source lang="bash">
-pacman -S --needed --noconfirm base-devel git mingw-w64-i686-{curl,faad2,freetype,flac,fluidsynth,libjpeg-turbo,libogg,libvorbis,libmad,libmpeg2-svn,libtheora,libpng,nasm,readline,SDL2,SDL2_net,toolchain,winsparkle,zlib}
-</source>
-For x86_64 (64-bit), type the following in the MSYS2 terminal to automatically install all the needed packages:
+In order to install all required tools and libraries, open the MinGW shell matching the architecture you want to build for (32 or 64 bits) and use the following command:
-<source lang="bash">
+<syntaxhighlight lang="bash">
-pacman -S --needed --noconfirm base-devel git mingw-w64-x86_64-{curl,faad2,freetype,flac,fluidsynth,libjpeg-turbo,libogg,libvorbis,libmad,libmpeg2-svn,libtheora,libpng,nasm,readline,SDL2,SDL2_net,toolchain,winsparkle,zlib}
+pacman -S --needed --noconfirm base-devel git ${MINGW_PACKAGE_PREFIX}-{a52dec,binutils,ccache,cairo,curl-winssl,faad2,freetype,flac,fluidsynth,fribidi,libjpeg-turbo,libogg,libvorbis,libvpx,libmad,libmpeg2-git,libtheora,libpng,lld,nasm,readline,SDL2,SDL2_net,toolchain,winsparkle,zlib,ntldd-git,libmikmod}
-</source>
+</syntaxhighlight>
-These commands will fetch and install the packages needed for compiling, including (but not limited to) GCC 6.x, GDB, and libwinpthread-git.
+These commands will fetch and install the packages needed for compiling, including (but not limited to) GCC 12.x, GDB, and libwinpthread-git.
-=== Install the needed libraries ===
+Additionally, if you would like to include Discord Rich Presence support, the pre-compiled libraries are [https://github.com/discord/discord-rpc/releases here]. Simply copy the files into your base MinGW directory.
-''You only have to install the libraries manually if you prefer not to use the automated way in the section above. For most users, installing all packages automatically will just work fine.''
+== Let's get compiling! ==
+Finally, we are ready to compile the project!
+To do that, just open a '''MinGW-w64''' shell (''not'' the MSYS2 shell), [http://gvsigce.sourceforge.net/wiki/index.php/Getting_started_with_MSYS#Navigating_the_file_system navigate] to the source folder where you have cloned scummvm.git, and type the following commands:
+  ./configure
+  make -j$(nproc)
+'''Note:''' Depending on what you are working on, have a look at <code>./configure --help</code>. Sometimes, you want to enable some features or engines that are disabled by default, while working on a specific engine won't require a full build at all.
-In order to compile properly, ScummVM needs you to have certain libraries installed. The command in the above section installs all of the needed packages automatically. All the libraries in the list can be installed with similar commands:
+If everything went well, you should have a big executable in the compilation folder, named scummvm.exe. The size of the executable comes from the debug symbols embedded in the file, so you can run the following command to shrink it:
-<source lang="bash">
+  strip scummvm.exe
-pacman -S mingw-w64-<env>-<library>
-</source>
-where <env> is the environment as previously stated, and <library> is the name of the library, as stated in the list (e.g. pacman -S mingw-w64-x86_64-SDL):
-* '''SDL2'''. Mandatory. ''We recently switched to SDL2. SDL 1 is still available as fallback option.''
+Please note that using this step is not necessary if you build a distributable package.
-* '''nasm'''. Optional, for faster compile of scalers.
-* '''flac'''. Optional, for FLAC support.
-* '''libjpeg-turbo'''. Optional, for JPEG support. Required for Groovie 2, Starship Titanic and Wintermute.
-* '''libogg''' and '''libvorbis'''. Optional, for OGG support.
-* '''libmad'''. Optional, for MP3 support.
-* '''libmpeg2-svn'''. Optional, for MPEG2 cutscene support.
-* '''zlib'''. Optional, for compressed saved games.
-* '''libtheora'''. Optional, for Broken Sword 2.5.
-* '''faad2'''. Optional, for AAC support.
-* '''libpng'''. Optional, for PNG support.
-* '''freetype'''. Optional, for TTF support.
-* '''fluidsynth'''. Optional, for soundfont MIDI support.
-* '''curl''' and '''SDL2_net'''. Optional, for cloud integration support.
-* '''winsparkle'''. Optional, for application updates via the WinSparkle framework.
-=== Let's get compiling! ===
+That's it, you successfully compiled ScummVM from the source code.
-Finally, we are ready to compile the project!
+== Ship required libraries for running ScummVM on a "non-MSYS2" machine ==
-To do that, just open a '''MinGW-w64''' shell (''not'' the MSYS2 shell), [http://gvsigce.sourceforge.net/wiki/index.php/Getting_started_with_MSYS#Navigating_the_file_system navigate] to the source folder where you have cloned scummvm.git, and type the following commands:
-<source lang="bash">
-	$> ./configure # Executes a bash script that helps you configure.
-	$> make # Executes the make program, which triggers the compilation.
-</source>
-If everything went well, you should have a big executable in the compilation folder, named scummvm.exe. The size of the executable comes from the debug symbols embedded in the file, so you can run the following command to shrink it:
+In case you want to distribute your builds to machines without a running MSYS2 installation or if you excluded MSYS2/Mingw-w64 from your PATH, you need to bundle the required .dll files with the executable - otherwise, running ScummVM will fail due to missing dependencies.
-<source lang="bash">
-	$> strip scummvm.exe
-</source>
-== Ready to go! ==
+If you intend to build a ScummVM package that includes all the necessary files, you can build such a redistributable package by using
-OK this should be all of it (hopefully), so you should be good to go.
+  make win32dist-mingw WIN32PATH=<target>
-== Common Issues ==
+where <code><target></code> specifies the directory that will contain the redistributable packages.
+== Common Issues ==
+* If configure fails to find required libraries such as SDL, make sure that you have all the required libraries available for the target system and that you are using the correct MinGW shell (32-bit vs 64-bit)
 * If the executable compiles correctly, but you get a "somelibrary.dll missing" error when executing it, you just need to add the following path to your PATH variable: <installdir>/msys<env>/mingw64/bin/
 * If the configure script gives an error about using msys mode, please make sure you are running the '''mingw-w64 win32 shell''' or the '''mingw-w64 win64 shell''', and not the '''msys2 shell''' from the MSYS2 package, when building ScummVM.
-== DLLs required for running ScummVM on a "non-MSYS2" machine ==
+== Notes ==
+* Despite the name, MinGW-w64 works on both 32-bit and 64-bit systems, but the latest versions cannot be installed on Windows XP anymore. '''However, builds produced will still work on Windows XP.'''
-If you want to run the ScummVM binary you just compiled on an (other) Windows machine that doesn't have mingw-w64/MSYS2 installed, you need to copy a few .dll files from the folder '''/your-msys2-folder/mingw64/bin''' (for x64 builds) '''or ../mingw32/bin''' (for x86) to the same folder as your scummvm.exe.
-The following list assumes that you are building ScummVM with default settings and all engines enabled, so chances that this list will suit your needs are pretty high.
-* libbz2-1.dll
-* libfaad-2.dll
-* libFLAC-8.dll
-* libfluidsynth-1.dll
-* libfreetype-6.dll
-* libgcc_s_seh-1.dll
-* libglib-2.0-0.dll
-* libgraphite2.dll
-* libharfbuzz-0.dll
-* libiconv-2.dll
-* libintl-8.dll
-* libjpeg-8.dll
-* libmad-0.dll
-* libmpeg2-0.dll
-* libogg-0.dll
-* libpcre-1.dll
-* libpng16-16.dll
-* libportaudio-2.dll
-* libsndfile-1.dll
-* libspeex-1.dll
-* libstdc++-6.dll
-* libtheoradec-1.dll
-* libvorbis-0.dll
-* libvorbisenc-2.dll
-* libvorbisfile-3.dll
-* libwinpthread-1.dll
-* SDL.dll/SDL2.dll ''(depends on the SDL version you used for compilation. Default is SDL2.dll)''
-* zlib1.dll
-Please note that compiling ScummVM with other options (e.g. "--enable-text-console") may require various other .dll files that are currently not in this list. This list will be constantly updated in the future.
+* MinGW-w64 and MSYS2 is a fork of MinGW. If you wish to compile with the (older) MinGW toolset, e.g. to support versions older than Windows XP, check out [[Compiling_ScummVM/MinGW|MinGW and MSYS]]
-Usually, ScummVM will name the .dll file that is missing, but in some cases, all you get is a quite unspecific error code "0xc000007b". When you get this error code, please double-check if you copied all necessary .dll files.
+* MinGW-w64 makes heavy use of the pacman package manager, which may not be available under other MinGW setups