Editing Building RetroArch

This page contains instructions of building [[RetroArch]] from source. Most average users should use prebuilt binaries instead.
 
=Building on Windows=
The recommended toolchain for building RetroArch on Windows is MinGW-w64 running inside the MSYS2 environment. Installers for MSYS2 can be found at [https://msys2.github.io/ msys2.github.io]. Other toolchains like TDM-GCC or Visual Studio can work, but this guide will only cover MSYS2.

==Preparing the environment==

Once you have installed MSYS2, you will need to update it and install the toolchain packages.

===Updating MSYS2===

First, start the MSYS2 Shell entry that should be present in your Start Menu.

Updating your install is a multiple step operation: first you update the core, then you have to rehash the environment and finally you'll be able to properly update the rest of the system. Once you are in the MSYS2 Shell terminal, run the following commands to upgrade the core MSYS2 packages:

 pacman --noconfirm -Sy
 pacman --needed --noconfirm -S bash pacman pacman-mirrors msys2-runtime

Once the window closes, open the MSYS2 Shell again and type <code>pacman --noconfirm -Su</code> then repeat the previous operation to finish the process.
Note: If you get fork errors, the second step may have failed. You should go to your msys2 install directory and run <code>autorebase.bat</code> manually. If that didn't solve the problem consider reinstalling msys2.

===Installing the build time dependencies===

The following commands will install everything you need to build RetroArch in your MSYS2 environment.

*For 32 bit builds run:

 pacman -S --noconfirm --needed git make mingw-w64-i686-toolchain mingw-w64-i686-pkgconf mingw-w64-i686-SDL2 mingw-w64-i686-libxml2 mingw-w64-i686-freetype mingw-w64-i686 python3 mingw-w64-i686-ffmpeg

*For 64 bit builds:

 pacman -S --noconfirm --needed git make mingw-w64-x86_64-toolchain mingw-w64-x86_64-pkgconf mingw-w64-x86_64-SDL2 mingw-w64-x86_64-libxml2 mingw-w64-x86_64-freetype mingw-w64-x86_64-python3 mingw-w64-x86_64-ffmpeg

For the nvidia-cg-toolkit packages, you will need to download the pkg manually from Sourceforge to your home directory for [http://sourceforge.net/projects/msys2/files/REPOS/MINGW_GCC_4_9/i686/mingw-w64-i686-nvidia-cg-toolkit-3.1-2-any.pkg.tar.xz/download 32-bit] or [http://sourceforge.net/projects/msys2/files/REPOS/MINGW_GCC_4_9/x86_64/mingw-w64-x86_64-nvidia-cg-toolkit-3.1-2-any.pkg.tar.xz/download 64-bit], then use pacman to install them.

*32-bit:

 pacman -U --noconfirm mingw-w64-i686-nvidia-cg-toolkit-3.1-2-any.pkg.tar.xz

*64-bit:

 pacman -U --noconfirm mingw-w64-x86_64-nvidia-cg-toolkit-3.1-2-any.pkg.tar.xz

After installing the packages, close the MSYS2 shell and open either MinGW-w64 Win64 Shell for 64 bit builds or MinGW-w64 Win32 Shell if you want to build for 32 bit systems. Both should be available in your Start Menu.

==Cloning RetroArch and libretro repositories==

Once you are running the MSY2 MinGW-w64 Shell, then you will need to clone the RetroArch and libretro Git repositories.

 git clone https://github.com/libretro/libretro-super.git
 cd libretro-super
 ./libretro-fetch.sh

This will fetch every repository in the libretro organization on Github into <code>%MSYS2%/home/%USERNAME%/</code> . Since there are a lot of repositories to download, this will take a while to complete. You can use <code>libretro-fetch.sh</code> again to update all repositories, and you can fetch repositories individually by specifying their name e.g. <code>./libretro-fetch.sh mednafen_psx</code>

If you change a file in one of the cloned repositories and git won't let you update, do:

 git reset --hard
 git pull

It should update after that. If not, delete the whole repository and run <code>libretro-fetch.sh</code> again.

To change directories/folders do:

 cd folder
 or
 cd folder/subfolder

etc.

To go up one directory:

 cd ..

Other basic UNIX shell commands like "ls" can be useful as well.

==Building RetroArch==

To build RetroArch from the MSY2 MinGW-w64 Shell, execute the following:

 cd libretro-super/retroarch && git pull && git submodule update --init && ./configure && make clean && make -j4

You should see a list of files being compiled, ending with <code>LD retroarch</code>. You can then copy the newly compiled <code>retroarch.exe</code> from <code>libretro-super\retroarch</code> to wherever you keep your RetroArch installation.

If you want to do a debug build, then execute the following:

 make clean
 make DEBUG=1 GL_DEBUG=1 -j4
 mv retroarch.exe retroarch_debug.exe

This build will have all of the debug symbols intact and will be built with compiler optimizations turned off, so it can be run through a debugger like gdb.

If you are experiencing a missing DLL error, you can fetch all MSYS2 installed DLLs by executing this line:

 for i in $(seq 3); do for bin in $(ldd *exe *dll | grep -i mingw | cut -d\  -f 3); do cp -vu "$bin" . ; done; done

Video filters and Audio DSP filters are compiled by going into gfx/filters and audio/filters, respectively, and running make on the Makefile. For example

 cd retroarch
 cd gfx/filters
 make clean
 make

After they build, you can copy the filters to your RetroArch installation.

==Building libretro cores==

After running the fetch script, you should have a folder for each libretro core in your libretro-super folder.

You can use <code>libretro-build.sh</code> to build all cores at once:

 cd libretro-super
 ./libretro-build.sh

This will attempt to build almost every core available. This can take quite a while to complete, so you may wish to build cores individually:

 cd libretro-super
 ./libretro-build.sh mednafen_psx

The exact names for fetching or building individual cores can be found in the [https://github.com/libretro/libretro-super/blob/master/rules.d/core-rules.sh /rules.d/core-rules.sh] script.

Cores that build successfully are put in <code>/dist/win</code> or <code>/dist/win_x64</code> in your libretro-super folder. Be sure to run <code>libretro-fetch.sh</code> to update your local Git clones before building.

==Building cores manually==

If you wish, you can build cores manually if you want more control over the build process, though it's not recommended for inexperienced users. For most cores, all you need to do is do:

 git pull
 make -f Makefile.libretro clean
 make -f Makefile.libretro -j4

If there isn't a Makefile or Makefile.libretro in the top level, try to find a "libretro" folder within the repository and there should be a Makefile in there. After the core is built, it will be in the same folder as the Makefile used to compile it. 

The following need only <code>make</code>:
* 4do-libretro
* blastem-libretro
* any 'beetle' source
* cannonball
* daphne
* Dinothawr
* FreeIntv
* freej2me (inside <code>/src/libretro</code>)
* Gearboy (inside <code>/platforms/ibretro</code>)
* libretro-atari800
* libretro-cap32
* libretro-chailove
* libretro-crocods
* libretro-lutro
* libretro-o2em
* libretro-uae
* melonDS
* Mesen (inside <code>/Libretro</code>)
* mrboom-libretro
* mupen64plus-libretro
* nestopia (inside <code>/libretro</code>)
* nxengine-libretro
* parallel-n64
* ppsspp (inside <code>/libretro</code>)
* prosystem-libretro
* reicast-emulator
* REminiscence
* SameBoy  (inside <code>/libretro</code>)
* scummvm (inside <code>/backends/platform/libretro/build</code>)
* snes9x (inside <code>/libretro</code>)
* stella-libretro
* tgbdual-libretro
* theodore
* virtualjaguar-libretro
* yabause (inside <code>/libretro</code>)

The following need <code>make -f Makefile.libretro</code>:
* 81-liberetro
* blueMSX-libretro
* Craft
* desmume (inside <code>/desmume</code>)
* dosbox-libretro
* easyrpg-libretro (inside <code>/builds/libretro</code>)
* fbalpha (NOTE: makefile.libretro is **all-lowercase**.)
* fuse-libretro
* gambatte-libretro
* Genesis-Plus-GX
* gw-libretro
* Hatari
* libretro-JamVM
* libretro-meowPC98 (inside <code>/libretro</code>)
* libretro-vecx
* mgba
* NP2kai (inside <code>/sdl2</code>)
* picodrive
* px68k-libretro
* PokeMini
* snes9x-next
* vba-next

The following cores also require the running of <code>git submodule update --init</code>:

* dolphin
* libretro-ppsspp
* picodrive

Some cores need special commands for building:

===bsnes===

 make profile='%PROFILE%' clean
 make profile='%PROFILE%' -j4

Replace %PROFILE% with accuracy, balanced, or performance.

===Dolphin===

Dolphin requires Cmake now. Its information on the Libretro core is inside <code>/Source/Core/DolphinLibretro</code>.

===emux===

 cd libretro
 make -f Makefile.%TARGET% MACHINE=%MACH%

Replace %TARGET% with the device to which you plan on building the core (e.g. linux-portable_x86_64, mingw_x86...)
Replace %MACH% with any one of the following devices: chip8, gc, nes, sms.

===MAME===
If doing a 64-bit build.

 cd libretro-mame
 make -f Makefile.libretro PTR64=1 clean
 make -f Makefile.libretro PTR64=1 -j4

This core will take a while to build, depending on how fast your CPU is, how many jobs you specify, and how many cores your CPU has. You can save some time updating the core by adding PARTIAL=1 when doing a clean. You can specify a subtarget by adding e.g. <code>SUBTARGET=arcade</code> or <code>SUBTARGET=tiny</code> in the current version of MAME.

===Redream===
Redream requires Cmake.

===Rustation-libretro===
Rustation is written in Rust, not C or C++; neither make nor Cmake would work.

=Building on Linux=
Building on Linux is similar to building on Windows.

After entering the RetroArch folder, do:

 ./configure

...and install any necessary dependencies before running ./configure again. Then, do:

 make


NOTE: Compilation may fail if you do not have the following installed:

* g++
* libgl1-mesa-dev
* libsdl2-dev
* mesa-common-dev
* pkg-config

Also, you may need one of the following if RetroArch is to run audio:

* alsa (libsdl2-dev)
* libpulse (libpulse-dev)
* lossaudo
* lopenal (libopenal-dev)
* jack
* libroar (libroar-dev) WARNING: This might break your compilation.
* rsound

==Raspberry Pi==
There is a tutorial on how to bypass X11 and use KMS, thus reducing overhead.

https://www.raspberrypi.org/forums/viewtopic.php?f=78&t=56070

The above might work on regular desktop Linux, too.

Even so, if you plan on turning your Raspberry Pi into a "RetroArch machine", the easiest way is installing the [http://blog.petrockblock.com/retropie/retropie-downloads/ RetroPie image]. (You can also run [http://blog.petrockblock.com/2012/07/22/retropie-setup-an-initialization-script-for-retroarch-on-the-raspberry-pi/ its script].)

[[Category:FAQs]]
[[Category:RetroArch]]