rpcs3/README.md

RPCS3
=====

[![Build Status](https://travis-ci.org/RPCS3/rpcs3.svg?branch=master)](https://travis-ci.org/RPCS3/rpcs3)
[![Build status](https://ci.appveyor.com/api/projects/status/411c4clmiohtx7eo/branch/master?svg=true)](https://ci.appveyor.com/project/rpcs3/rpcs3/branch/master)
[![Coverity Status](https://img.shields.io/coverity/scan/3960.svg)](https://scan.coverity.com/projects/3960)
[![Coverage Status](https://coveralls.io/repos/RPCS3/rpcs3/badge.svg)](https://coveralls.io/r/RPCS3/rpcs3)

An open-source PlayStation 3 emulator/debugger written in C++.

You can find some basic information in the [FAQ](https://github.com/RPCS3/rpcs3/wiki/FAQ). For discussion about this emulator and PS3 emulation please visit the [official forums](http://www.emunewz.net/forum/forumdisplay.php?fid=162).


### Development

If you want to contribute please take a look at the [Coding Style](https://github.com/RPCS3/rpcs3/wiki/Coding-Style), [Roadmap](https://github.com/RPCS3/rpcs3/wiki/Roadmap) and [Developer Information](https://github.com/RPCS3/rpcs3/wiki/Developer-Information) pages. You should as well contact any of the developers in the forum in order to know about the current situation of the emulator.


### Dependencies

__Windows__
* [Visual Studio 2015](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)
* [Visual C++ Redistributable Packages for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145)
* [Cmake 3.1.0+](http://www.cmake.org/download/) (required; add to PATH)
* [Python 3.3+](https://www.python.org/downloads/) (required; add to PATH)

__Linux__
* GCC 5.1+ or Clang 3.5.0+ ([not GCC 6.1](https://github.com/RPCS3/rpcs3/issues/1691))
* Debian & Ubuntu: `sudo apt-get install cmake build-essential libopenal-dev libwxgtk3.0-dev libglew-dev zlib1g-dev libedit-dev libvulkan-dev`
* Arch: `sudo pacman -S glew openal wxgtk cmake llvm`

__Mac OSX__
* Xcode 6+ (tested with Xcode 6.4)
* Install with Homebrew: `brew install glew wxwidgets`
* Remove '-framework QuickTime' from '_ldflags' in /usr/local/bin/wx-config


### Building

To initialize the repository don't forget to execute `git submodule update --init` to pull the submodules.
* __Windows__:
1) Open the *.SLN* file.
2) Build the projects in *__BUILD_BEFORE* folder: right-click on every project > *Build*.
3) Press *BUILD* > *Build Solution* or *Rebuild Solution*.
* __Linux & Mac OSX__:
If you want to build with LLVM, then LLVM 3.8 is required.
`cd rpcs3 && cmake CMakeLists.txt && make && cd ../` then run with `cd 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*) </br>
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*) </br>
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.
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 12:40:50 +00:00			`RPCS3`
Initial commit 2012-11-03 15:16:18 +00:00			`=====`

Modify .travis.yml to enable Travis. Fix the master git repo name in Github, also the one in git-version-gen.cmd. Display Shell Export List to help debugging our Travis Build. 2015-04-08 18:02:54 +00:00			`[![Build Status](https://travis-ci.org/RPCS3/rpcs3.svg?branch=master)](https://travis-ci.org/RPCS3/rpcs3)`
Add appveyor badge 2015-08-04 15:52:16 +00:00			`[![Build status](https://ci.appveyor.com/api/projects/status/411c4clmiohtx7eo/branch/master?svg=true)](https://ci.appveyor.com/project/rpcs3/rpcs3/branch/master)`
Some dependency info updated 2015-11-22 15:30:34 +00:00			`[![Coverity Status](https://img.shields.io/coverity/scan/3960.svg)](https://scan.coverity.com/projects/3960)`
Minor changes 2015-10-22 16:30:39 +00:00			`[![Coverage Status](https://coveralls.io/repos/RPCS3/rpcs3/badge.svg)](https://coveralls.io/r/RPCS3/rpcs3)`
Add Coveralls badge Start making unit tests now! 2015-01-26 18:53:00 +00:00
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 12:40:50 +00:00			`An open-source PlayStation 3 emulator/debugger written in C++.`
Update Readme with some links to the wiki and forums 2014-02-09 17:41:20 +00:00
Minor changes 2015-10-22 16:30:39 +00:00			`You can find some basic information in the [FAQ](https://github.com/RPCS3/rpcs3/wiki/FAQ). For discussion about this emulator and PS3 emulation please visit the [official forums](http://www.emunewz.net/forum/forumdisplay.php?fid=162).`
Update Readme with some links to the wiki and forums 2014-02-09 17:41:20 +00:00
Add Linux build instructions for Debian & Ubuntu 2014-04-13 01:19:48 +00:00
			`### Development`

fix typo in readme 2016-03-03 10:30:25 +00:00			`If you want to contribute please take a look at the [Coding Style](https://github.com/RPCS3/rpcs3/wiki/Coding-Style), [Roadmap](https://github.com/RPCS3/rpcs3/wiki/Roadmap) and [Developer Information](https://github.com/RPCS3/rpcs3/wiki/Developer-Information) pages. You should as well contact any of the developers in the forum in order to know about the current situation of the emulator.`
Add Linux build instructions for Debian & Ubuntu 2014-04-13 01:19:48 +00:00

Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 12:40:50 +00:00			`### Dependencies`
Update Readme with some links to the wiki and forums 2014-02-09 17:41:20 +00:00
Add Linux build instructions for Debian & Ubuntu 2014-04-13 01:19:48 +00:00			`__Windows__`
Update README.md 2015-09-12 23:35:10 +00:00			`* [Visual Studio 2015](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)`
Some small change. Update README.md for VS 2015. remove sln buildbot remove unused appveyor config remove package.bat, no longer current, now found in bigpet/rpcs3-buildbot-tools 2015-07-23 11:53:10 +00:00			`* [Visual C++ Redistributable Packages for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145)`
vulkan: Add relevant libs. 2016-02-16 19:23:17 +00:00			`* [Cmake 3.1.0+](http://www.cmake.org/download/) (required; add to PATH)`
build: Add a separate project for ppu llvm recompiler Fix some defect found by static analysis. 2016-02-28 22:59:24 +00:00			`* [Python 3.3+](https://www.python.org/downloads/) (required; add to PATH)`
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 12:40:50 +00:00
Add Linux build instructions for Debian & Ubuntu 2014-04-13 01:19:48 +00:00			`__Linux__`
Clarify working GCC versions (#1851) GCC 6.1 cannot compile RPCS3 due to a regression within GCC itself, so note that here as it's the current version that a lot of people are likely to be using, with a link to the bug that contains further information. 2016-07-25 14:48:25 +00:00			`* GCC 5.1+ or Clang 3.5.0+ ([not GCC 6.1](https://github.com/RPCS3/rpcs3/issues/1691))`
README.md updated 2016-06-19 18:47:59 +00:00			* Debian & Ubuntu: `sudo apt-get install cmake build-essential libopenal-dev libwxgtk3.0-dev libglew-dev zlib1g-dev libedit-dev libvulkan-dev`
Add arch linux dependency instructions 2015-03-27 07:56:13 +00:00			* Arch: `sudo pacman -S glew openal wxgtk cmake llvm`
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 12:40:50 +00:00
add info for Mac OSX 2014-04-29 17:55:03 +00:00			`__Mac OSX__`
Some dependency info updated 2015-11-22 15:30:34 +00:00			`* Xcode 6+ (tested with Xcode 6.4)`
README.md updated 2016-06-19 18:47:59 +00:00			* Install with Homebrew: `brew install glew wxwidgets`
add info for Mac OSX 2014-04-29 17:55:03 +00:00			`* Remove '-framework QuickTime' from '_ldflags' in /usr/local/bin/wx-config`

Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 12:40:50 +00:00
			`### Building`
Update Readme with some links to the wiki and forums 2014-02-09 17:41:20 +00:00
Partial commit: Preview 2016-02-01 21:40:38 +00:00			To initialize the repository don't forget to execute `git submodule update --init` to pull the submodules.
Update README.md 2015-09-12 23:35:10 +00:00			`* __Windows__:`
Partial commit: Preview 2016-02-01 21:40:38 +00:00			`1) Open the .SLN file.`
			`2) Build the projects in __BUILD_BEFORE folder: right-click on every project > Build.`
			`3) Press BUILD > Build Solution or Rebuild Solution.`
add info for Mac OSX 2014-04-29 17:55:03 +00:00			`* __Linux & Mac OSX__:`
README.md updated 2016-06-19 18:47:59 +00:00			`If you want to build with LLVM, then LLVM 3.8 is required.`
Some dependency info updated 2015-11-22 15:30:34 +00:00			`cd rpcs3 && cmake CMakeLists.txt && make && cd ../` then run with `cd bin && ./rpcs3`.
README.md updated 2016-06-19 18:47:59 +00:00			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.
Exception handling fix 2015-12-16 14:20:46 +00:00			When using GDB, configure it to ignore SIGSEGV signal (`handle SIGSEGV nostop noprint`).
add info for Mac OSX 2014-04-29 17:55:03 +00:00
Add optimal build options to CMakeLists (#1841) Provides two options when building RPCS3 USE_SYSTEM_FFMPEG BOOL (default: OFF) USE_SYSTEM_LIBPNG BOOL (default: OFF) These options lets the user select between the system provided and builtin libraries of ffmpeg and libpng to overcome possible system issues. Also adds support for older libpng releases if the user doesn't have libpng 1.5 or higher. 2016-07-01 04:07:16 +00:00			`##### CMake Build Options (Linux & Mac OSX)`

			- ```-DUSE_SYSTEM_LIBPNG=ON/OFF``` (default = OFF) </br>
			`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) </br>
			`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.`