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://scan.coverity.com/projects/3960/badge.svg)](https://scan.coverity.com/projects/3960)
[![Coverage Status](https://coveralls.io/repos/DHrpcs3/rpcs3/badge.svg)](https://coveralls.io/r/DHrpcs3/rpcs3)

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

You can find some basic information in the [FAQ](https://github.com/DHrpcs3/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 took at the [Coding Style](https://github.com/DHrpcs3/rpcs3/wiki/Coding-Style), [Roadmap](https://github.com/DHrpcs3/rpcs3/wiki/Roadmap) and [Developer Information](https://github.com/DHrpcs3/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 C++ Redistributable Packages for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145)

__Linux__
* Debian & Ubuntu: `sudo apt-get install libopenal-dev libwxgtk3.0-dev build-essential libglew-dev`
* Arch: `sudo pacman -S glew openal wxgtk cmake llvm`

__Mac OSX__
* Install with Homebrew: `brew install glew wxwidgets` (add `llvm36` to that list if you want to build with ppu jit)
* 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 wxWidgets source.
* __Windows__: Install *Visual Studio 2015*, *Cmake 3.1.0+*, *Python* and select *Add in the PATH variable* for both. Then open the *.SLN* file, and press *Build* > *Rebuild Solution*.
* __Linux & Mac OSX__:
`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=/usr/local/opt/llvm36/lib/llvm-3.6/share/llvm/cmake` (or wherever llvm brew was installed) to cmake invocation.

### Support
* [Donate by PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MPJ3S9XQXCE3G)
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00			`RPCS3`
Initial commit 2012-11-03 16:16:18 +01: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 20:02:54 +02:00			`[![Build Status](https://travis-ci.org/RPCS3/rpcs3.svg?branch=master)](https://travis-ci.org/RPCS3/rpcs3)`
Add appveyor badge 2015-08-04 17:52:16 +02:00			`[![Build status](https://ci.appveyor.com/api/projects/status/411c4clmiohtx7eo/branch/master?svg=true)](https://ci.appveyor.com/project/rpcs3/rpcs3/branch/master)`
Small change for Badges in README.md. 2015-04-09 14:43:46 +02:00			`[![Coverity Status](https://scan.coverity.com/projects/3960/badge.svg)](https://scan.coverity.com/projects/3960)`
Add Coveralls badge Start making unit tests now! 2015-01-26 19:53:00 +01:00			`[![Coverage Status](https://coveralls.io/repos/DHrpcs3/rpcs3/badge.svg)](https://coveralls.io/r/DHrpcs3/rpcs3)`

Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00			`An open-source PlayStation 3 emulator/debugger written in C++.`
Update Readme with some links to the wiki and forums 2014-02-09 18:41:20 +01:00
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00			`You can find some basic information in the [FAQ](https://github.com/DHrpcs3/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 18:41:20 +01:00
Add Linux build instructions for Debian & Ubuntu 2014-04-13 03:19:48 +02:00
			`### Development`

			`If you want to contribute please take a took at the [Coding Style](https://github.com/DHrpcs3/rpcs3/wiki/Coding-Style), [Roadmap](https://github.com/DHrpcs3/rpcs3/wiki/Roadmap) and [Developer Information](https://github.com/DHrpcs3/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.`


Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00			`### Dependencies`
Update Readme with some links to the wiki and forums 2014-02-09 18:41:20 +01:00
Add Linux build instructions for Debian & Ubuntu 2014-04-13 03:19:48 +02:00			`__Windows__`
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 13:53:10 +02:00			`* [Visual C++ Redistributable Packages for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145)`
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00
Add Linux build instructions for Debian & Ubuntu 2014-04-13 03:19:48 +02:00			`__Linux__`
Update README.md Add dependency for Linux build: libglew-dev 2014-12-07 08:30:15 +01:00			* Debian & Ubuntu: `sudo apt-get install libopenal-dev libwxgtk3.0-dev build-essential libglew-dev`
Add arch linux dependency instructions 2015-03-27 08:56:13 +01:00			* Arch: `sudo pacman -S glew openal wxgtk cmake llvm`
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00
add info for Mac OSX 2014-04-29 19:55:03 +02:00			`__Mac OSX__`
Try to build with llvm and update readme 2015-08-19 16:24:57 +02:00			* Install with Homebrew: `brew install glew wxwidgets` (add `llvm36` to that list if you want to build with ppu jit)
add info for Mac OSX 2014-04-29 19:55:03 +02: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 14:40:50 +02:00
			`### Building`
Update Readme with some links to the wiki and forums 2014-02-09 18:41:20 +01:00
add submodule instructions and bump submodule version 2014-02-12 19:23:33 +01:00			To initialize the repository don't forget to execute `git submodule update --init` to pull the wxWidgets source.
cellSpurs additions and internal struct refactoring Also updated the README. 2015-07-26 11:15:15 +02:00			`* __Windows__: Install Visual Studio 2015, Cmake 3.1.0+, Python and select Add in the PATH variable for both. Then open the .SLN file, and press Build > Rebuild Solution.`
add info for Mac OSX 2014-04-29 19:55:03 +02:00			`* __Linux & Mac OSX__:`
Fix run instruction hitting CWD bug PCS3 assumes current working directory is bin folder. So running it like ./bin/pcs3 stops it from finding dev_hdd0 and related. 2014-04-13 05:15:09 +02:00			`cd rpcs3 && cmake CMakeLists.txt && make && cd ../` Then run with `cd bin && ./rpcs3`
Try to build with llvm and update readme 2015-08-19 16:24:57 +02:00			If you are on OSX and want to build with llvm don't forget to add `-DLLVM_DIR=/usr/local/opt/llvm36/lib/llvm-3.6/share/llvm/cmake` (or wherever llvm brew was installed) to cmake invocation.
add info for Mac OSX 2014-04-29 19:55:03 +02:00
Update README.md 2014-12-05 15:32:55 +01:00			`### Support`
			`* [Donate by PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MPJ3S9XQXCE3G)`