Help:Building RPCS3: Difference between revisions

Revision as of 21:30, 28 January 2022

Official, up-to-date instructions for Windows and Linux can be found in the readme. However, many build platforms are supported partially by the development team i.e. pull requests are accepted from various members of the community who have taken to ensuring that other platforms can also build RPCS3 correctly. However, they are not actively maintained by the development team, and as a result many Unices such as macOS and FreeBSD break often. You can find the build process detailed for several less-common platforms below.

Dependencies

RPCS3 uses many 3rd party libraries and projects. Most notably, in order to build the project, you will need the following:

CMake 3.14.1+
Python 3.3+
Qt 5.14.2
Vulkan SDK 1.1.126+ (See "Install the SDK" here)

In addition, GCC 9+ or Clang 9+ are the minimum needed compilers.

Clone

Clone and initialize the repository:

git clone https://github.com/RPCS3/rpcs3.git
cd rpcs3
git submodule update --init

macOS

Support for macOS is highly experimental. On Apple silicon Macs, Rosetta and the x64 version of Homebrew must be used.

brew install llvm@13 molten-vk vulkan-headers sdl2 nasm qt@5 ninja cmake glew git

You will also need to remember to set environment vars:

export CXX=clang++
export CC=clang
export Qt5_DIR="/usr/local/Cellar/qt@5/5.15.2_1/lib/cmake/Qt5"
export PATH="/usr/local/opt/llvm/bin:/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/X11/bin:/Library/Apple/usr/bin"
export LDFLAGS="-L/usr/local/opt/llvm/lib -Wl,-rpath,/usr/local/opt/llvm/lib"
export CPPFLAGS="-I/usr/local/opt/llvm/include -msse -msse2 -mcx16 -no-pie"
export CXXFLAGS="-I/usr/local/opt/llvm/include -msse -msse2 -mcx16 -no-pie"
export VULKAN_SDK="/usr/local/opt/molten-vk"
export VK_ICD_FILENAMES="$VULKAN_SDK/share/vulkan/icd.d/MoltenVK_icd.json"

A symbolic link to moltenVK may be necessary for CMake to detect Vulkan:

ln -s "$VULKAN_SDK/lib/libMoltenVK.dylib" "$VULKAN_SDK/lib/libvulkan.dylib"

Build

mkdir rpcs3_build && cd rpcs3_build
cmake -DUSE_DISCORD_RPC=OFF -DUSE_VULKAN=ON -DUSE_ALSA=OFF -DUSE_PULSE=OFF -DUSE_AUDIOUNIT=ON -G Ninja -DLLVM_CCACHE_BUILD=OFF -DLLVM_TARGETS_TO_BUILD="X86" -DLLVM_BUILD_RUNTIME=OFF -DLLVM_BUILD_TOOLS=OFF -DLLVM_INCLUDE_DOCS=OFF -DLLVM_INCLUDE_EXAMPLES=OFF -DLLVM_INCLUDE_TESTS=OFF -DLLVM_INCLUDE_TOOLS=OFF -DLLVM_INCLUDE_UTILS=OFF -DLLVM_USE_PERF=OFF -DLLVM_ENABLE_Z3_SOLVER=OFF -DCMAKE_CXX_STANDARD=20 -DUSE_NATIVE_INSTRUCTIONS=OFF ../rpcs3/
ninja

Run

open ./bin/rpcs3.app

Msys2

There is some support for non-MSVC based compilation on Windows. The Msys2 platform using the Mingw build tools did work at one point, though it should be noted that the following instructions are outdated.

Dependencies

pacman -S base-devel mingw-w64-x86_64-toolchain mingw-w64-x86_64-cmake mingw-w64-x86_64-yasm mingw-w64-x86_64-python2 mingw-w64-x86_64-ntldd-git mingw-w64-x86_64-qt5 mingw-w64-x86_64-openal mingw-w64-x86_64-glew git

Clone

git clone https://github.com/RPCS3/rpcs3.git
cd rpcs3
git submodule update --init

Configure

cd .. && mkdir rpcs3_build && cd rpcs3_build
cmake -G "MSYS Makefiles" -DCMAKE_MAKE_PROGRAM=mingw32-make ../rpcs3/
mingw32-make.exe GitVersion && mingw32-make.exe discord-rpc

Build

mingw32-make -jX #X is core count

Install

cd ./bin
for l in $(ntldd.exe -R rpcs3.exe|grep mingw64|sed -e 's/^[ \t]*//'|cut -d' ' -f3);do cp $l .;done

mkdir -p ./qt/plugins/{bearer,imageformats,platforms,styles}
cp /mingw64/share/qt5/plugins/bearer/qgenericbearer.dll ./qt/plugins/bearer/
cp /mingw64/share/qt5/plugins/imageformats/{qgif.dll,qicns.dll,qico.dll,qjpeg.dll,qtga.dll,qtiff.dll,qwbmp.dll,qwebp.dll} ./qt/plugins/imageformats/
cp /mingw64/share/qt5/plugins/platforms/qwindows.dll ./qt/plugins/platforms/
cp /mingw64/share/qt5/plugins/styles/qwindowsvistastyle.dll ./qt/plugins/styles/

Run

./rpcs3

CMake Build Options

All CMake options are enabled or disabled using the parameters ON or OFF respectively.

Option	Default	Description
`-DUSE_NATIVE_INSTRUCTIONS=`	ON	Build with `-march=native`, which is useful for local builds, but not good for packages.
`-DWITH_LLVM=`	ON	Build with LLVM.
`-DBUILD_LLVM_SUBMODULE=`	ON	Build with pre-built LLVM libraries from RPCS3 git submodule.
`-DUSE_ALSA=`	ON	Build with ALSA audio backend.
`-DUSE_PULSE=`	ON	Build with PulseAudio audio backend.
`-DUSE_LIBEVDEV=`	ON	Build with libevdev-based joystick support.
`-DUSE_DISCORD_RPC=`	ON	Build with Discord Rich Presence integration.
`-DUSE_SYSTEM_ZLIB=`	ON	Build with system ZLIB instead of the built-in one.
`-DUSE_VULKAN=`	ON	Build with Vulkan support.
`-DBUILD_SHARED_LIBS=`	OFF	?
`-DSKIP_GLSLANG_INSTALL=`	?	?
`-DENABLE_AMD_EXTENSIONS=`	ON	Build with support for AMD-specific extensions.
`-DENABLE_GLSLANG_BINARIES=`	ON	?
`-DENABLE_NV_EXTENSIONS=`	ON	Build with support for NVIDIA-specific extensions.
`-DENABLE_HLSL=`	ON	?
`-DENABLE_OPT=`	ON	?
`-DUNITY_BUILD_EMU=`	OFF	?
`-DUSE_SYSTEM_LIBPNG=`	OFF	Build against the shared libpng instead of using the built-in one. libpng 1.6+ highly recommended. Try this option if you get version conflict errors or only see black game icons.
`-DUSE_SYSTEM_FFMPEG=`	OFF	Build against the shared FFmpeg libraries instead of using the built-in patched version. Try this if the built-in version breaks the OpenGL renderer for you.