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

Jump to navigation Jump to search
m
(10 intermediate revisions by 4 users not shown)
Line 12: Line 12:
Our officially supported MinGW build instructions are at [[Compiling_ScummVM/MinGW]].
Our officially supported MinGW build instructions are at [[Compiling_ScummVM/MinGW]].
|}
|}
{| border="0" cellpadding="1" cellspacing="2" style="margin-left:5em; background:#FF9999; width:80%"
|- align="center"
| '''NOTE'''
|- style="margin-left:1em; background:#ffffff;"
|- style="background:#ffffff"
| Please note that current versions of MSYS2/Mingw64 cannot be installed on Windows XP anymore. '''However, builds produced with the MSYS2/Mingw64 toolchain will still work on Windows XP.'''
|}




Line 18: Line 28:
=== Setup MinGW-w64 and MSYS2 ===
=== Setup MinGW-w64 and MSYS2 ===


You can find MSYS2 and installation instructions on the [[https://msys2.github.io/ MSYS2 webpage]].
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]].


==== Download and install the mingw-w64 compilation toolchain====
==== Download and install the necessary packages ====
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).
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 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:
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:
For i686 (32-bit), type the following in the MSYS2 terminal to automatically install all packages/libraries needed to compile ScummVM:
<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-w64-i686-{a52dec,ccache,curl,faad2,freetype,flac,fluidsynth,libjpeg-turbo,libogg,libvorbis,libmad,libmpeg2-git,libtheora,libpng,nasm,readline,SDL2,SDL2_net,toolchain,winsparkle,zlib}
</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.
For x86_64 (64-bit), type the following in the MSYS2 terminal to automatically install all packages/libraries needed to compile ScummVM:
<syntaxhighlight lang="bash">
pacman -S --needed --noconfirm base-devel git mingw-w64-x86_64-{a52dec,ccache,curl,faad2,freetype,flac,fluidsynth,libjpeg-turbo,libogg,libvorbis,libmad,libmpeg2-git,libtheora,libpng,nasm,readline,SDL2,SDL2_net,toolchain,winsparkle,zlib}
</syntaxhighlight>
 
These commands will fetch and install the packages needed for compiling, including (but not limited to) GCC 9.x, GDB, and libwinpthread-git.


=== Install the needed libraries ===
=== Install the needed libraries ===
Line 48: Line 59:


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:
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:
<source lang="bash">
<syntaxhighlight lang="bash">
pacman -S mingw-w64-<env>-<library>
pacman -S mingw-w64-<env>-<library>
</source>
</syntaxhighlight>
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):
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.''
* '''SDL2'''. Mandatory. ''We recently switched to SDL2. SDL 1 is still available as fallback option.''
* '''nasm'''. Optional, for faster compile of scalers.
* '''curl''' and '''SDL2_net'''. Optional, for cloud integration support.
* '''faad2'''. Optional, for AAC support.
* '''flac'''. Optional, for FLAC support.
* '''flac'''. Optional, for FLAC support.
* '''fluidsynth'''. Optional, for soundfont MIDI support.
* '''freetype'''. Optional, for TTF support.
* '''libjpeg-turbo'''. Optional, for JPEG support. Required for Groovie 2, Starship Titanic and Wintermute.
* '''libjpeg-turbo'''. Optional, for JPEG support. Required for Groovie 2, Starship Titanic and Wintermute.
* '''libmad'''. Optional, for MP3 support.
* '''libmpeg2-git'''. Optional, for MPEG2 cutscene support.
* '''libogg''' and '''libvorbis'''. Optional, for OGG support.
* '''libogg''' and '''libvorbis'''. Optional, for OGG support.
* '''libmad'''. Optional, for MP3 support.
* '''libpng'''. Optional, for PNG support.
* '''libmpeg2-svn'''. Optional, for MPEG2 cutscene support.
* '''zlib'''. Optional, for compressed saved games.
* '''libtheora'''. Optional, for Broken Sword 2.5.
* '''libtheora'''. Optional, for Broken Sword 2.5.
* '''faad2'''. Optional, for AAC support.
* '''nasm'''. Optional, for faster compile of scalers.
* '''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.
* '''winsparkle'''. Optional, for application updates via the WinSparkle framework.
* '''zlib'''. Optional, for compressed saved games.


=== Let's get compiling! ===
=== Let's get compiling! ===
Line 73: Line 84:
Finally, we are ready to compile the project!
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:
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">
<syntaxhighlight lang="bash">
$> ./configure # Executes a bash script that helps you configure.
$> ./configure # Executes a bash script that helps you configure.
$> make # Executes the make program, which triggers the compilation.
$> make # Executes the make program, which triggers the compilation.
</source>
</syntaxhighlight>


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:
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">
<syntaxhighlight lang="bash">
$> strip scummvm.exe
$> strip scummvm.exe
</source>
</syntaxhighlight>


== Ready to go! ==
== Ready to go! ==
Line 99: Line 110:
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.  
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.  


* liba52-0.dll
* libbz2-1.dll
* libbz2-1.dll
* libfaad-2.dll
* libfaad-2.dll
1,310

edits

Navigation menu