gaming/rpcs3
gaming/rpcs3
1
0
Fork 0
mirror of https://github.com/RPCS3/rpcs3 synced 2024-11-02 11:45:30 +00:00
Code Issues Projects Releases Packages Wiki Activity
rpcs3/README.md
Ani 11f5f29c87 Update Readme (#2829)
2017-06-04 16:44:48 +01:00

4.6 KiB
Raw Blame History

RPCS3

Build Status Build status Coverity Status

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

You can find some basic information in our website. For discussion about this emulator and PS3 emulation please visit our forums and our Discord server.

Support Lead Developer Nekotekina on Patreon

Development

If you want to contribute please take a look at the Coding Style, Roadmap and Developer Information pages. You should as well contact any of the developers in the forums or in Discord in order to know more about the current situation of the emulator.

Dependencies

Windows

Linux

  • Qt 5.8+
  • GCC 5.1+ or Clang 3.5.0+ (not GCC 6.1)
  • Debian & Ubuntu: sudo apt-get install cmake build-essential libasound2-dev libopenal-dev libwxgtk3.0-dev libglew-dev zlib1g-dev libedit-dev libvulkan-dev libudev-dev git
  • Arch: sudo pacman -S glew openal cmake llvm

Mac OSX

Mac OSX is not supported at this moment because it doesn't meet system requirements (OpenGL 4.3)

  • Xcode 6+ (tested with Xcode 6.4)
  • Install with Homebrew: brew install glew

Building on Windows:

To initialize the repository don't forget to execute git submodule update --init to pull the submodules.

Configuring Qt

If you're using Visual Studio 2017 without Qt plugin support (or simply dont want to use it):

  1. Add QTDIR environment variable and set it to <QtInstallFolder>\5.8\msvc2015_64\
    OR
    open the SLN, wait for projects to load, in explorer open rpcs3qt/rpcs3qt.vcxproj.user and set <QTDIR>QtInstallFolder/5.8/msvc2015_64</QTDIR>

If you wish to use the Visual Studio plugin for Qt:

  1. Go to the Qt5 menu and edit Qt5 options. Add the path to your Qt installation with compiler e.g. C:\Qt\5.8\msvc2015_64.
  2. While selecting the rpcs3qt project, go to Qt5->Project Setting and select the version you added.

Building the projects

  1. Build the projects in __BUILD_BEFORE folder: right-click on every project > Build.
  2. Press BUILD > Build Solution or Rebuild Solution.

Building on Linux & Mac OSX:

  1. git clone https://github.com/RPCS3/rpcs3.git
  2. cd rpcs3/
  3. git submodule update --init
  4. cmake CMakeLists.txt && make GitVersion && make
  5. Run RPCS3 with ./bin/rpcs3

If you are on OSX and want to build with llvm don't forget to add -DLLVM_DIR=... (or wherever llvm brew was installed) to cmake invocation.

When using GDB, configure it to ignore SIGSEGV signal (handle SIGSEGV nostop noprint).

CMake Build Options (Linux & Mac OSX)

  • -DUSE_SYSTEM_LIBPNG=ON/OFF (default = OFF)
    Build against the shared libpng instead of using the builtin one. libpng 1.6+ highly recommended. Try this option if you get version conflict errors or only see black game icons.

  • -DUSE_SYSTEM_FFMPEG=ON/OFF (default = OFF)
    Build against the shared ffmpeg libraries instead of using the builtin patched version. Try this if the builtin version breaks the OpenGL renderer for you.

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.