Difference between revisions of "Compiling ScummVM/MinGW-w64"
m (→Common Issues: typo) |
(Fix syntax highlighting) |
||
| Line 19: | Line 19: | ||
==== Download and install the mingw-w64 compilation toolchain==== | ==== Download and install the mingw-w64 compilation toolchain==== | ||
In the MSYS2 terminal, type: | In the MSYS2 terminal, type: | ||
< | <source lang="bash"> | ||
$> pacman -S mingw-w64-<env>-toolchain | $> pacman -S mingw-w64-<env>-toolchain | ||
</ | </source> | ||
where <env> is either x86_64 or i686, depending on your architecture (64-bit and 32-bit, respectively). | where <env> is either x86_64 or i686, depending on your architecture (64-bit and 32-bit, respectively). | ||
| Line 31: | Line 31: | ||
MSYS2 does not support make out of the box, but it has its own implementation. Install it by typing: | MSYS2 does not support make out of the box, but it has its own implementation. Install it by typing: | ||
< | <source lang="bash"> | ||
$> pacman -S make | $> pacman -S make | ||
</ | </source> | ||
=== Install the needed libraries === | === Install the needed libraries === | ||
In order to compile properly, ScummVM needs you to have certain libraries installed. 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. All the libraries in the list can be installed with similar commands: | ||
< | <source lang="bash"> | ||
$> pacman -S mingw-w64-<env>-<library> | $> 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): | 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): | ||
| Line 70: | Line 70: | ||
Finally, we are ready to compile the project! | Finally, we are ready to compile the project! | ||
To do that, just open a MSYS2 console, [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 MSYS2 console, [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. | $> ./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> | ||
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"> | ||
$> strip scummvm.exe | $> strip scummvm.exe | ||
</ | </source> | ||
== Ready to go! == | == Ready to go! == | ||
Revision as of 16:12, 30 May 2016
| NOTE |
| 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.
We do not support building in this way, but if you want to use it, instructions are below. Our officially supported MinGW build instructions are at Compiling_ScummVM/MinGW. |
Things needed
Setup MinGW-w64 and MSYS2
You can find MSYS2 and installation instructions on the [MSYS2 webpage].
Download and install the mingw-w64 compilation toolchain
In the MSYS2 terminal, type:
$> pacman -S mingw-w64-<env>-toolchain
where <env> is either x86_64 or i686, depending on your architecture (64-bit and 32-bit, respectively).
This command will fetch and install the packages needed for compiling, including (but not limited to) GCC 5.x, GDB, and libwinpthread-git.
Install make
ScummVM uses Makefiles to build the project. Makefiles are build configuration files that the compiler uses to compile, link and solve dependencies. "make" is the software that runs the Makefiles.
MSYS2 does not support make out of the box, but it has its own implementation. Install it by typing:
$> pacman -S make
Install the needed libraries
In order to compile properly, ScummVM needs you to have certain libraries installed. All the libraries in the list can be installed with similar commands:
$> pacman -S mingw-w64-<env>-<library>
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):
- SDL Mandatory.
- nasm Optional, for faster compile of scalers.
- flac. Optional, for FLAC support.
- libogg and libvorbis Optional, for OGG support.
- libmad Optional, for MP3 support.
- libmpeg2 Optional, for MPEG2 cutscene support.
- zlib. Optional, for compressed saved games.
- libtheora. Optional, for Broken Sword 2.5.
- libfaad2. Optional, for AAC support.
- libpng. Optional, for PNG support.
- freetype. Optional, for TTF support.
- fluidsynth. Optional, for soundfont MIDI support.
Let's get compiling!
Finally, we are ready to compile the project! To do that, just open a MSYS2 console, navigate to the source folder where you have cloned scummvm.git, and type the following commands:
$> ./configure # Executes a bash script that helps you configure.
$> make # Executes the make program, which triggers the compilation.
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
Ready to go!
OK this should be all of it (hopefully), so you should be good to go.
Common Issues
- 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.