Compiling ScummVM/MinGW

Compiling ScummVM with Minimalist GNU for Windows (MINGW)

MinGW is "a collection of freely available and freely distributable Windows specific header files and import libraries combined with GNU toolsets that allow one to produce native Windows programs that do not rely on any 3rd-party C runtime DLLs".

More information can be found at the MinGW homepage

Things needed

MinGW and MSYS

To download MinGW, visit its download page

Downloading MinGW for the first time can be a daunting task, as there are a lot of packages to download. The ones you need are in the "Current" section (apart from MinGW-5.0.0.exe, which is in the "Proposed" section).

Download the following:

The following are downloaded through the automated installer, but you can install them here to have everything ready:

binutils
gcc-core
gcc-g++
mingw32-make
mingw-runtime 3.8 (downloaded automatically) OR mingw-runtime 3.9 (the current version)
w32api 3.3 (downloaded automatically) OR w32api 3.5 (the current version)

Note that the above downloads are the current ones, and can change in the future. To get the latest versions (if one of the links above is broken), visit the MinGW download page and download the latest versions there. The latest packages for MinGW (but not MSYS) can be downloaded through the automated installer MinGW-5.0.0.exe.

Both MinGW and MSYS need to be installed and working to compile ScummVM. First, install MinGW through its automated installer

[TODO]

Libraries needed

SDL 1.2.

You need the file SDL-devel-1.2.9-mingw32.tar.gz (1.2.9 is the latest version at this time)

NASM

libogg and libvorbis for OGG support

Note that the libraries included in the "vorbis" package won't work. You need libogg and libvorbis, not vorbis

libmad for MP3 support

libmpeg2 for MPEG-2 support

Get the latest mpeg2dec release from this page, libmpeg2 is included there

zlib. You need the latest zlib source code.

Building the libraries

Now, we need to compile the required libraries and tools.

NASM

First of all, we need nasm. So unzip the nasm archive in a directory, copy "nasmw.exe" to "nasm.exe" (because some projects call one and others call the other) and include the folder it is stored in into your system path. To do this, go to Control Panel->System, Advanced tab->environment variables and edit the "PATH" variable in the system variables list, adding the folder where you placed the aforementioned files. Directories in the system path are split with a semicolon (;), e.g. "C:\MinGW\msys\1.0\bin;C:\MinGW\bin;C:\nasm". Alternatively, you can just copy both files in MinGW's bin directory, e.g. C:\MinGW\bin as this should be already in your system path

Changes to the PATH will be reflected on newly opened command prompts only, so if you got any open already, close them to avoid confusion

SDL

SDL is already compiled and needs no further changes, so we can skip the compilation step for it

Copy all the files in SDL's include folder in MinGW's include folder and all the files in SDL's lib folder in MinGW's lib folder. Also, copy SDL.dll and i386-mingw32msvc-sdl-config in MinGW's bin folder. Rename i386-mingw32msvc-sdl-config to sdl-config

Now, we need to setup SDL. Go to SDL's folder and type 'make install prefix=/mingw' (note the forward slash, since you are using MSYS).

zlib

[TODO]

libogg

libogg should be compiled before libvorbis and libFLAC To compile it, open MSYS, go to the libogg folder and issue these commands:

./configure --disable-shared
make

When everything is compiled, copy the include\ogg folder inside MinGW's include folder. So, you should end up with an ogg folder in MinGW's include folder. Also, copy the src\.libs folder as-is inside MinGW's lib folder, and also copy the files from the src\.libs folder inside MinGW's lib folder (because ogg libraries are searched both in the lib and in the lib\.libs folder)

libvorbis

To compile libvorbis , open MSYS, go to the libvorbis folder and issue these commands:

./configure --disable-shared
make

When everything is compiled, copy the include\vorbis folder inside MinGW's include folder. So, you should end up with a vorbis folder in MinGW's include folder. Also, copy lib\.libs folder from libvorbis folder as-is inside MinGW's lib folder, and also copy the files from the lib\.libs folder from libvorbis folder inside MinGW's lib folder (because vorbis libraries are searched both in the lib and in the lib\.libs folder)

mpeg2dec

[TODO]

After you compile this one, go to its include directory, create a folder "mpeg2dec" in there and copy all files from the include folder in this subfolder. So you should end up with 2 directories, "include" and "include\mpeg2dec" with the same files. This is needed, as ScummVM includes files from the "mpeg2dec" directory

libmad

[TODO]

FLAC

[TODO]