Building

Building Phoenix

Note: Make sure you have installed all dependencies before building Phoenix.

Get the source

Windows: Use the MSYS shell

1. git clone https://github.com/team-phoenix/Phoenix.git
2. cd Phoenix
3. git submodule init
4. git submodule update

Build Phoenix from Qt Creator

1. Start Qt Creator (Windows: /mingw64/bin/qtcreator from the MSYS shell, see note at bottom), open the .pro file
2. You will be asked to create a build directory for Phoenix's build files and executable to reside. The default is fine!
3. Build -> Build All
4. Copy a set of 64-bit libretro cores to the following location:
   • Windows (.dll files): C:/Program Files/Libretro/Cores
   • OS X (.dylib files): /usr/local/lib/libretro
   • Linux (.so files): /usr/lib/libretro
5. You can now run it.

Build Phoenix from the terminal

Windows: Use the MinGW-w64 shell

All platforms: You must have the Qt shared libraries on your path in order to actually run from the terminal. Qt Creator will set up these paths automatically so you don't have to. Why not try building from that instead?

1. (from Phoenix) cd ..
2. mkdir Phoenix-build
3. cd Phoenix-build
4. qmake ../Phoenix
5. make -j8
6. cd debug
7. Make sure you've followed step 5 from the above section (copying cores), and you can launch Phoenix! (./phoenix)

NOTE: Qt Creator on Windows

If you want to launch Qt Creator from a shortcut, be aware that the PATH variable Qt Creator will spawn with won't have the MSYS2 bin directory (C:\msys2\usr\bin), which will prevent you from building the frontend. To fix this, go to Tools -> Options -> Build & Run -> Kits and, for the (default) kit, Change... the Environment to include this:

PATH=C:\msys64\usr\bin;${PATH}

Next step: Code Style