RPCS3/rpcs3
1
0
Fork 0
mirror of https://github.com/RPCS3/rpcs3.git synced 2024-11-22 02:32:36 +01:00
Code Issues Releases Wiki Activity
d361eedbec
rpcs3/README.md
scribam 39fa1d7031 ci/vk: Bump Vulkan version (1.1.73.0/1.1.97.0 => 1.1.106.0) 
VULKAN_SDK_MIRROR removed as the server is down
2019-06-09 23:43:57 +01:00

5.8 KiB
Raw Blame History

RPCS3

Build Status Build status

The world's first free and open-source PlayStation 3 emulator/debugger, written in C++ for Windows and Linux.

You can find some basic information on our website. Game info is being populated on the Wiki. For discussion about this emulator, PS3 emulation, and game compatibility reports, please visit our forums and our Discord server.

Support Lead Developers Nekotekina and kd-11 on Patreon

Contributing

If you want to help the project but do not code, the best way to help out is to test games and make bug reports. See:

If you want to contribute as a developer, please take a look at the following pages:

You should also contact any of the developers in the forums or in the Discord server to learn more about the current state of the emulator.

Dependencies

Windows

Either add the QTDIR environment variable, e.g. <QtInstallFolder>\5.11.2\msvc2017_64\ , or use the Visual Studio Qt Plugin

Linux

  • Qt 5.10+ (Avoid 5.11.1, due to a bug)
  • GCC 7.3+ or Clang 5.0+
  • CMake 3.8.2+
  • Debian & Ubuntu: sudo apt-get install cmake build-essential libasound2-dev libpulse-dev libopenal-dev libglew-dev zlib1g-dev libedit-dev libvulkan-dev libudev-dev git qt5-default libevdev-dev qtdeclarative5-dev qtbase5-private-dev
  • Arch: sudo pacman -S glew openal cmake vulkan-validation-layers qt5-base qt5-declarative
  • Fedora: sudo dnf install alsa-lib-devel cmake glew glew-devel libatomic libevdev-devel libudev-devel openal-devel qt5-devel vulkan-devel
  • OpenSUSE: sudo zypper install git cmake libasound2 libpulse-devel openal-soft-devel glew-devel zlib-devel libedit-devel vulkan-devel libudev-devel libqt5-qtbase-devel libevdev-devel

If you have an NVIDIA GPU, you may need to install the libglvnd package.

Vulkan-SDK

For Ubuntu systems, it is strongly recommended to use the PPA from LunarG which will provide a compatible Vulkan-SDK to compile RPCS3. If your Vulkan-SDK is older, it can lead to compilation errors.

Ubuntu 18.04 (Bionic Beaver)
wget -qO - http://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add -
sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.1.106-bionic.list http://packages.lunarg.com/vulkan/1.1.106/lunarg-vulkan-1.1.106-bionic.list
sudo apt update
sudo apt install vulkan-sdk
Ubuntu 16.04 (Xenial Xerus)
wget -qO - http://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add -
sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.1.106-xenial.list http://packages.lunarg.com/vulkan/1.1.106/lunarg-vulkan-1.1.106-xenial.list
sudo apt update
sudo apt install vulkan-sdk

Building

Only Windows and Linux are officially supported for building. However, various other platforms are capable of building RPCS3. Other instructions may be found here.

Clone and initialize the repository:

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

Windows

Configuring the Qt plugin (if used)

  1. Go to the Qt5 menu and edit Qt5 options.
  2. Add the path to your Qt installation with compiler e.g. <QtInstallFolder>\5.11.2\msvc2017_64.
  3. While selecting the rpcs3qt project, go to Qt5->Project Setting and select the version you added.

Building the projects

Open rpcs3.sln. The recommended build configuration is Release - LLVM for all purposes.

You may want to download precompiled LLVM libs and extract to root rpcs3 folder (which contains rpcs3.sln), as well as download and extract additional libs to lib\%CONFIGURATION%-x64\ to speed up compilation time (unoptimised/debug libs are currently not available precompiled).

If you're not using precompiled libs, build the projects in __BUILD_BEFORE folder: right-click on every project > Build.

Build > Build Solution

Linux

While still in the project root:

  1. cd .. && mkdir rpcs3_build && cd rpcs3_build
  2. cmake ../rpcs3/ && make
  3. Run RPCS3 with ./bin/rpcs3

When using GDB, configure it to ignore SIGSEGV signal (handle SIGSEGV nostop noprint). If desired, use the various build options in CMakeLists.

License

Most files are licensed under the terms of GNU GPLv2 License; see LICENSE file for details. Some files may be licensed differently; check appropriate file headers for details.