Find a file
Henrique Jung 76b7103fed [CMake] Build LLVM from the submodule if there's no suitable version
When RPCS3 is compiled with LLVM (default option), CMake only tries to
find LLVM on the default system installation. So the OS must have a
sytstem-wide installation of LLVM of at least version 4.0, which is not
available on many GNU/Linux distributions (e.g. Ubuntu 16.04, Debian
Stretch). If CMake can not find a suitable version, it silently falls
back to compile RPCS3 without LLVM.

This patch makes CMake defaults to compile the LLVM submodule if and
only if a suitable LLVM version is not found installed on the system.
Due to a build time check on LLVM, in-tree builds will not work when
building the submodule (LLVM does not allow in-source builds). For this
reason, the instruction for building on CMake were updated.
2017-10-14 14:54:10 +03:00
.github Add a GitHub issue template, hopefully help with invalid issue spam. 2017-10-05 11:30:39 +01:00
3rdparty Move optional.hpp as a submodule 2017-10-12 18:00:24 +03:00
asmjit@1370fe6a26
asmjitsrc vs: drop user files from shipped vs files 2017-06-22 23:36:15 +03:00
bin Qt: include debug tool colors in stylesheet (#3527) 2017-10-04 23:10:24 +01:00
llvm@4423e35117
llvm_build
ps3emu_api
rpcs3 [CMake] Build LLVM from the submodule if there's no suitable version 2017-10-14 14:54:10 +03:00
rpcs3-tests vs: drop user files from shipped vs files 2017-06-22 23:36:15 +03:00
Utilities Move optional.hpp as a submodule 2017-10-12 18:00:24 +03:00
Vulkan
.clang-format
.editorconfig
.gitignore Fix GitIgnore 2017-08-27 01:27:38 +03:00
.gitmodules Move optional.hpp as a submodule 2017-10-12 18:00:24 +03:00
.mention-bot
.travis.yml travis: Dont try to upload appiamges if UPLOAD_URL is missing 2017-10-13 15:23:48 +03:00
appveyor.yml Move optional.hpp as a submodule 2017-10-12 18:00:24 +03:00
CMakeLists.txt Revert "Add option to build using llvm shared libs and document other cmake options" 2017-10-09 22:46:36 +01:00
CONTRIBUTING.md Update Contributing Guidelines 2017-08-27 01:27:38 +03:00
git-clang-format
LICENSE
pre-commit.readme
qt-installer-noninteractive.qs Linux builds now link LLVM statically, fixed Qt libpng issue, moved to single AppImage 2017-07-25 02:41:05 +01:00
README.md [CMake] Build LLVM from the submodule if there's no suitable version 2017-10-14 14:54:10 +03:00
rpcs3.sln
rpcs3_debug.props
rpcs3_default.props Fix compile VS for Optional submodule 2017-10-13 05:14:12 +03:00
rpcs3_llvm.props
rpcs3_memleak.props
rpcs3_release.props
usertype.dat
zlib.props

RPCS3

Build Status Build 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 Developers Nekotekina and kd-11 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.7+
  • 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 libglew-dev zlib1g-dev libedit-dev libvulkan-dev libudev-dev git qt5-default
  • Arch: sudo pacman -S glew openal cmake llvm qt5-base
  • Fedora: sudo dnf install cmake qt5-devel vulkan-devel glew glew-devel If you have a NVIDIA GPU, you may need to install the libglvnd package.

MacOS

MacOS 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 llvm qt cmake

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.7\msvc2015_64\

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.7\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 OS:

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

If you are on MacOS and want to build with brew llvm and qt don't forget to add the following environment variables

  • LLVM_DIR=/usr/local/opt/llvm/ (or wherever llvm was installed).
  • Qt5_DIR=/usr/local/opt/qt/lib/cmake/Qt5 (or wherever qt was installed).

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

CMake Build Options (Linux & Mac OS)

  • -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.

  • -DWITHOUT_LLVM=ON/OFF (default = OFF)
    This forces RPCS3 to build without LLVM, not recommended.

  • -DWITH_GDB=ON/OFF (default = OFF)
    This Builds RPCS3 with support for debugging PS3 games using gdb.

  • -DUSE_VULKAN=ON/OFF (default = ON)
    This builds RPCS3 with Vulkan support.

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.