rpcs3/README.md

115 lines
6.3 KiB
Markdown
Raw Normal View History

RPCS3
2012-11-03 15:16:18 +00:00
=====
[![Build Status](https://travis-ci.org/RPCS3/rpcs3.svg?branch=master)](https://travis-ci.org/RPCS3/rpcs3)
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)
2017-06-04 15:44:48 +00:00
The world's first open-source PlayStation 3 emulator/debugger written in C++ for Windows and Linux.
2017-06-04 15:44:48 +00:00
You can find some basic information in our [**website**](https://rpcs3.net/).
For discussion about this emulator and PS3 emulation please visit our [**forums**](https://forums.rpcs3.net) and our [**Discord server**](https://discord.me/RPCS3).
[**Support Lead Developers Nekotekina and kd-11 on Patreon**](https://www.patreon.com/Nekotekina)
2017-06-04 15:44:48 +00:00
## Development
2017-06-04 15:44:48 +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 forums or in Discord in order to know more about the current situation of the emulator.
2017-06-04 15:44:48 +00:00
## Dependencies
2017-06-04 15:44:48 +00:00
### Windows
2017-09-14 23:44:34 +00:00
* [Visual Studio 2015](https://www.visualstudio.com/vs/older-downloads/)
* [Visual C++ Redistributable Packages for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145)
2017-06-04 15:44:48 +00:00
* [Cmake 3.1.0+](https://www.cmake.org/download/) (required; add to PATH)
* [Python 3.3+](https://www.python.org/downloads/) (required; add to PATH)
* [Qt 5.10+](https://www.qt.io/download-open-source/) (required; add QTDIR environment variable if you do not want to use the Visual Studio Qt Plugin: e.g. `<QtInstallFolder>\5.10.1\msvc2015_64\`)
2017-06-04 15:44:48 +00:00
* [Visual Studio Qt Plugin](https://marketplace.visualstudio.com/items?itemName=TheQtCompany.QtVisualStudioTools2015) (optional; see above)
* [Vulkan SDK](https://sdk.lunarg.com/sdk/download/1.1.73.0/windows/VulkanSDK-1.1.73.0-Installer.exe) (required)
2017-06-04 15:44:48 +00:00
### Linux
* [Qt 5.10+](https://www.qt.io/download-open-source/)
* GCC 5.1+ or Clang 3.5.0+ ([not GCC 6.1](https://github.com/RPCS3/rpcs3/issues/1691))
2017-11-22 10:50:26 +00:00
* 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`
* Arch: `sudo pacman -S glew openal cmake vulkan-validation-layers qt5-base`
* Fedora: `sudo dnf install alsa-lib-devel cmake glew glew-devel libatomic libevdev-devel libudev-devel openal-devel qt5-devel vulkan-devel`
2017-12-10 23:48:26 +00:00
* 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.**
### MacOS
MacOS is not supported at this moment because it doesn't meet system requirements (OpenGL 4.3)
2015-11-22 15:30:34 +00:00
* Xcode 6+ (tested with Xcode 6.4)
2017-08-08 16:20:41 +00:00
* Install with Homebrew: `brew install glew llvm qt cmake`
2014-04-29 17:55:03 +00:00
2017-06-04 15:44:48 +00:00
## 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 e.g `<QtInstallFolder>\5.10.1\msvc2015_64\` </br>
2017-06-04 15:44:48 +00:00
*If you're using Visual Studio 2017, when you first open the project, do not upgrade the targets or the packages. Leave both at "No upgrade". Note that you will need the v140 toolset, which may not be in 2017 by default.* </br>
Open `rpcs3.sln`
RPCS3 QT (#2645) * Fix windows build. I made sure to do everything with a win32 prefix to not effect linux build. * Make the window resizable instead of fixed in the corner. * Ignore moc files and things in the debug/release folder. I might also ignore rpcs3qt.vcxproj and its filters as they're autogenerated by importing the qt project file. But, this helps clean out clutter for now. * Add cmake. This doesn't interact with the rest of rpcs3 nor the main cmake file. That's the next thing I'm doing. I'll probably need to modify them so it'll take me time to figure out. But, this will build rpcs3qt on linux and build as is with using qt. * The build works. I'd like to thank my friends, Google and Stackoverflow. Setted up by importing rpcs3Qt project using Qt's visual studio plugin. * Cleanup. Remove all the stuff in the rpcs3qt folder as its incorporated elsewhere. Remove the rpcs3qt project file as its now built into the solution and cmake doesn't care about pro files. * Update readme to reflect getting Qt. * Remove wxwidgets as submodule and add zlib instead. Wxwidgets was our old way of having zlib. I also added build dependencies to rpcs3qt so you should no longer get link errors on the first clean rebuild. * Add rpcs3_version, few GUI tweaks * Set defaultSize to 70% of screen size * Add the view menu (#3) * Added the view menu with the corresponding elements. Now, the debugger/log are hidden by default. The view menu has a checkbox which you click to show/hide the dock widgets. * Make log visible by default * Improve UI by making it into a checkbox that's easier to use. * fix qt build for vs2017 (seems to work fine in 2015 with plugin but needs testing by other users) * updated readme for qt * update appveyor for qt - cleaned formatting for the post build command * fix build (#6) * fix build legit this time i promise * [Ready] Gamepadsettings (#4) * WIP Gamepadsettings pushbutton Eventhandling missing * GamepadSettings should work except for cfg Init Some KeyInputs are missing * Update padsettingsdialog.h * Update padsettingsdialog.cpp (#5) * Update padsettingsdialog.cpp removed silly tabs * Update padsettingsdialog.cpp * GetKeyCode simplified * rename pad settings to keyboard settings o.O * rename keyboard setting to input settings * Remvoed the QT_UI defines. * Readded new line at end of file. Replaced define in padsettings with constant. * GUI fixes (Settings) * Stub the logger UI. Nothing special besides a simple stub. * Unstub the log. I haven't tested TTY but it should work. Only thing to do, but this is in general, is add persistent settings. * Minor refactoring to simplify code. * Fix image loading. I'm 90% sure it works because it loads the path as expected and that's the same format I used in my gamelist implementation for the images. * Made game lists much more functional than it was. * mainwindow * gamelist * Please forgive me for I have lambdaed. Added the ability to toggle showing columns via a context menu. * Fix GameList further * sort by name on init fixed * Created the baseline refactoring. I'm going to start working on the callbacks now. May need to implement other classes in the process. Fun stuff, I know. * adds InstallPkg (tested) and InstallPup (should work but makes unknown shenanigans) implementation adds RefreshGameList obliterates 10sec Refresh * messages * Rpcs3 gs frame (#16) * Messing with project settings try to get trails of cold steel to boot.bluh Definitely one change is needed in linker settings for RPCS3 to not crash immediately. Can't even see how horribly botched my implementation of GSFrame is because we aren't booting lol. Something is gone awry with elf. * remove random ! not that it matters much right now * minor additions * "Working" with debug mode though you have to ignore an assert reached from Qt. Qt is upset that the rsx thread is calling stuff on the UI thread despite not owning it. However, I can't do a thing to change that atm. (The fix would be to do what the TODO says in System.cpp-- making gsframe and stuff get initialized via system call) Crashes due to needing pad callback to be done. * With this build in debug mode, Trails of Cold steel will get FPS. (caveat. You have to ignore when Qt throws a debug assert lol) * Fix release mode. Fix the Qt debug assert by using ancient occault rituals. I want to be able to remove the blocking connects but it won't work right now without it. It isn't perfect but it's good enough for now IMO. * Add enters to the end of files. * Removing target and setting source of events to be the application instead of the main window. The main window isn't the game window, and I don't really know what widget will be targetted for the game event. Works, though, it's admittedly probably not optimal by ANY means. * Fix comment. * Fix libpng wit zlib. * Move Qt GUI into RPCS3Qt. (#17) Restore wx GUI. * fix install-progressdialogs randomly not showing * install-progressdialog cosmetics * add stylesheet file loading * apply request * Add stylesheet to git ignore. * XInput.. * Joystick... * Rpcs3 qt small fixes (#20) * Small fixes. Have emulator stop when x button is pressed on game window. Have emulator/application stop when the main window is closed. * If I forget another new line ending for a file............................................. * Add CgDisasm (#21) * fix install-progressdialogs randomly not showing * install-progressdialog cosmetics * add stylesheet file loading * apply request * add CgDisasm add code to disable contextmenu options fix gamelist issue * missing proj changes * Add ability to open stylesheets from menu. * Mega searcher (#23) * add MemoryStringSearcher set minimum Sizes for mainwindow and CgDisasm * minor fixes * Since the system.cpp callbacks for emulator state were unused, I removed them. Then, I replaced them with callbacks for the Gui. * added stylesheet options setfocus on settings fixed newline added * added signals and slots for EmuRun and EmuStop * update ui update ui now works added callback onReady added EnableMenues added ps3 commands * added restart logic to menu * newline * event header removed * Added graphic settings class. (#26) * Added graphic settings class. First thing is to have the dock widgets and window size/location be stateful. Minor bug with debugger frame changing size on hide/show on default setup on second load. But, otherwise, fine. Also, the GUI doesn't update to accomodate the statefulness of the widgets. But, that'll come in time as I update this class. * Add view debugger, logger, gamelist to settings and synchronize them. * Separate initializing actions from connects * Add invisible fullscreen cursor and double click event. * Add the UI log settings. * Add MemoryViewer (#30) * Add Memoryviewer Image Button crashes/not fully implemented focus on some button annoying minor changes for question dialogs * GuiSettings Refactoring (#31) * Add settings for columns shown and which one is saved * I accidentally refactored the settings class. Added ability to reset to default GUI. Added statefulness to column widths. * add gui tab * Fix logging at startup. * Preset settings.I think I ironed out MOST of the glitches. Will work on the rest of it soon. Should be a lot simpler as I won't have to use the so-called meta settings. Also, renamed all settings methods to CapitalCase. * Removed dock widget controls. * Added style sheets. Removed the option from the menu. * Rewrite to use folder design. Much simpler! Yay! Simpler. Better, right? * It's remarkable how tricky this is. * Added convenience button to open up the settings folder in explorer * Add newlines at end of file * simplified logic. Fixed a bug.. hopefully not more bugs * Fix the undocumented feature * Make the dialog big enough to have entire text on title shown. If talkashie changes the font to size 1203482 I don't care lol * Make warning messagebox instead of changing the title of the dialog. * marking... * Hcorion suggested changes. * [WIP] autopause (#32) * autopause added needs fixing headers do not show text * fix compile stuff * Add MsgDialog + edge widgets (#33) * Add MsgDialog needs magic * add "Debugger" Buttons to menubar * Adapt ds4 changes. I'm not sure if they work as I don't have a compatible controller. But, at the same time, it's kind of silly all I had to do was remove stdguiafx to get compilation. * [Ready] Add KernelExplorer (#36) * KernelExplorer added * Fix build. Connect mainwindow to show explorer. * qstr formatting added hid header, fixed button size * Taskbar Progress for install PUP/PKG (#37) * Add Taskbar Progress for both PKG and PUP installer * fix missing ifdefs for windows * add mainwindow icon + thumbnail toolbar * add game specific icons to the GSFrame * fix icon crash * fix appIcon's aspect ratio in SetAppIconFromPath * Fix black borders in RGB32 icons * rename thumbar related buttons * EmuSettings (#35) * Core tab done minus doing the library list. * Graphics tab. * Audio tab * Input tab * Added the other tabs * LLE part one-- load existing libraries sorted. (I'd finish it but I'm going to look at a PR by mega) * add search and add other libraries that aren't checked. * Finish adding lle selecting things. * marking my territory (#38) fixed settingsdialog glitch and width added groupbox to gui buttons removed parents from layouts * add debuggerframe + RSXDebugger (#34) * Add Debuggerframe * add RSXDebugger * add RSXDebugger fo real * RSXDebugger improved minor adjustments * add utf8 conversions like neko told me to hopefully i did not utf8-ise too many things xD * fix some variables * maybe fix image buffers in RSXDebugger * fixed image view (pretty sure) * fixed image buffer (hopefully) * QT Opengl frame (#41) * fix RSX Debugger headers (#40) * fix some debugger layout issues fix RSX Debugger headers + some comments * add kd-11's SPU options fix D3D12 showing on non-compatible systems tidy up coretab * improve D3D12 behaviour in graphicstab: adapter selection and D3D12 render won't show on non-compatible systems add monospace font to cgDisasm * enable update only on visibility * Rpcs3 qt llvm build (#42) * LLVM pushed so mega can test * probably is what is needed with Release LLVM * should probably have RPCS3-Qt be using release-llvm * include zlib the same way. * don't talk to me about how I made this happen. * I applied the magical treatment to debug mode too. Though, it's entirely probably that doing it once in LLVM-release mode made this entirely redundant * hack * progress bar for LLVM spawns but doesn't close yet. * fix msgDialog (#43) fix oskDialog * Minor bug fixzz * fix osk and msgdialog for real (#44) * fix msgDialog fix oskDialog * fix OskDialog part 2 fix MsgDialog part 2 * This bug is evil, and it should be ashamed of itself. * Refactor YAML. Commented out gui options that aren't added to config yet (add em back later when we merge that in) * Fix pad stuff. * add SaveDataUtility (#45) * add SaveDataUtility * fix slots * fix slots again fix lists not showing stuff fix dialogs not showing add colClicked refactor stuff and polish some layouts * add SaveDataDialog.h and SaveDataDialog.cpp * tidy up mainwindow * add callback * fix RegisterEditor (#47) * fix RegisterEditor * fix other dialogs' immortality (gasp...vampires) * remove debug leftovers * fix InstructionEditor (#46) * fix InstructionEditor * fix typo * Fix MouseClickEvents in RSXDebugger (#50) * Fix MouseClickEvents in RSXDebugger Fix focus on MemoryViewer and RSXDebugger Adjust PadButtonWidth * fix another comment * fix debuggerframe events (#49) * Fix pad settings bro (#48) * Fix pad settings bro * fix comment * Icons and Menu-Additions (#39) * Add Icons and iconlogic to cornerWidget and actions * add cornerWidget toggle fix dockwidget action state on start remove DoSettings * fix game removal bug remove tableitem focus rectangle therefore add TableItemDelegate.h * remove grid and focus rectangle from autopausedialog * add fullscreen checkbox to misctab minor padsettings layout improvements * Add show category submenu to view menu Add gamelist filter accordingly fix minor bug where play icon was displayed despite pause label add boolean b_fullscreen to mainwindow for later use in GSFrame * fix headers in autopausesettings fix remove bug in autopausesettings add delete keypressevent in autopausesettings fix missing tr() and minor refactoring in gamelist * add default Icons for play/pause/stop/restart * Fix fullscreen start. Some stuff was wrong with settings, just trust me. * remove fullscreen leftovers and fix merge * SPU stuff. (There was also a weird thing with config.h in GLGSFrame.h with an include that I removed to fix build) * please neko's lambda fetishes (#53) * please neko's lambda fetish in mainwindow * please neko's lambda fetish in gamelistframe * please neko's lambda fetish in logframe * fix neko's lambda fetish in debuggerframe * pleasefixdofetishsomething in Autopausesettingsdialog * fix sth sth lambda in cg disasm * lambda stuff in instructioneditor * lambda kernelexplorer * lambda-ise memoryviewer * lambda rsxdebugger * lambda savedatautil this could be done even more, but the functions are not implemented * Rpcs3 qt fixes -- shadow taskbar bug (#52) * SShadow's bug of taskbar progress staying fixed on cancelling pkg install. * other taskbar * i'm still a baka * Fix a warning * qtQt refactoring (#54) * fix neko's snake fetish * File names should match headers. Are these the names I want? Not necessarily. But, this is much less confusing. * i thought I committed everything with stage all......................... * remove unused utilities * The most important commit of them all. * Disable legacy opengl buffers when not using opengl. * fix code review comment * Quick crash patch. Neko removed autopause. SO, I remove it too from emusettings/misc tab * Merge lovely things from master (#55) * Configuration simplified * untrivial parts of the merge * no need for these options anymore * Minor change to fix column widths at startup (not sure why it doesn't work already, but adding the true makes it work so......... whatever) * here ya go * FIx hitting okay in settings causing graphics to messup (#57) * fixes + msgdialog taskbarprogress (#56) * fix ok button in taskbar add taskicon progressbar for msgdialog add tablewidgetitem to rsxdebugger fix comments in save_data_utility.cpp * fix d3d adapter default * fix taskicon progressbar not being destroyed properly * add last_path to filedialogs * fix msgdialog crash on ok (#58) * fix thread stopping in debbugerFrame (#59) * Move Emu.init to be first. This will fix the qt stuff seeming to ignore the virtual filesystem in the config. (VFS to be made soon maybe) (#60) * Fix full screen opening on double RIGHT click. * fix other instances of double click ... * Fix locaiton of gui config. (#61) * fix d3d bug (#62) * fix d3d bug * small utf8 addition * Fix cmake for qt (#64) * Initial CMake fix * Fix compilation with GCC * Get rid of awful hack * Update cotire with qt support * Maybe fix travis * Emergency Hack Relief Program Activated * Fix travis build (#65) * make about dialog great again (#67) and add previous additions * Fix library sort / smart gamelist context menu (#63) * fix library sort * add Title to custom game config dialog * disable options on gamelist context menu * use namespace for category Strings * introduce sstr * fix some tr nonsense * Rpcs3qt Appveyor (#68) Fix appyveyor build!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! * possible fix for gamelist icons (#69) add warning for appicon * Fix clang build (#66) Hcorion, the build savior. * Rpcs3 qt resources (#70) * Resource files attempt 1 * Autorcc should probably be on? * forgot the most important file lol * Forgot an instance of the icon in the code... * Patch fix for clang build. * vulkan/d3d12 combobox merge (#71) * add vulkan adapterbox and merge with d3d12 box * fix adapter text on other renderer * gather render strings * attempt fix on gamelist row height * adjust adapter behaviour to new guideline * Compiler of Peace. * High critical hit rate. * Mugi eating strawberries is savage. * Apply KD-11 Hotfix (#73) * Most of Ani Adjusts (#72) * Most of the adjustments are made here. * fix gamelist rowheight * fix msg dialog layout and disable_cancel * cleanup * fix disable cancle again * fix debuggerframe buttons and doubleclick * Add a fun little bonus feature :) (#74) * category filters simplyfied (#75) * Cleaning up cmake a bit. * fixezzzzzz (#76) * upgrade Info Boxes * upgrade file explorer * refactor GetSettings and SetSettings * second refactoring * cleanup * travis is a grammar nazi * second travis shenanigans * third travis weirdo thingy * travis 4 mega fun * travis 5 default to def * finish refactoring for settings fix gamelist headers * hotfix msgdialog and infobox (#77) * msgdialog fix 1 * fix zombie infobox * Rpcs3 Qt Welcome Page (#78) * Add a welcome dialog. * Add enter to end of file * i'm an idiot * last mistake i hope * sponsored via --> funded by * RPCS3 does not condone piracy. * Mega Adjusts * Ani Adjustments and a few refactorings * Yay * Add Gamelist Icon Sizes (#79) * Reverting Mega's suggestion. If people can use alt-f4 to get around this dialog, they can probably use an emulator too. * Fix firmware file choice dialog in QT GUI (#80) * ani adjusts 2 + minor icon size simplifications (#81) FPS Additions * Update Travis to Qt 5.9 (#82)
2017-06-04 14:48:33 +00:00
*If you wish to use the Visual Studio plugin for Qt:* </br>
1) Go to the Qt5 menu and edit Qt5 options. Add the path to your Qt installation with compiler e.g. `C:\Qt\5.10.1\msvc2015_64`. </br>
2017-06-04 15:44:48 +00:00
2) While selecting the rpcs3qt project, go to Qt5->Project Setting and select the version you added.
### Building the projects
The recommended build configuration is Release - LLVM, for all purposes. </br> </br>
You may want to download precompiled [LLVM lib](https://drive.google.com/uc?export=download&id=0B8A6NaxhQAGRY2k3Q2Yya05lcm8) and extract to root rpcs3 folder (which contains `rpcs3.sln`), as well as download and extract [additional libs](https://drive.google.com/uc?export=download&id=0B8A6NaxhQAGRaHYxV3VOS2d0a0U) 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*. </br></br>
`Build > Build Solution`</br>
2017-01-22 14:57:09 +00:00
2017-06-04 15:44:48 +00:00
## Building on Linux & Mac OS:
2017-06-04 15:44:48 +00:00
2017-01-22 14:57:09 +00:00
1) `git clone https://github.com/RPCS3/rpcs3.git` </br>
2) `cd rpcs3/` </br>
3) `git submodule update --init` </br>
4) `cd ../ && mkdir rpcs3_build && cd rpcs3_build`
4) `cmake ../rpcs3/ && make GitVersion && make` </br>
2017-01-22 14:57:09 +00:00
5) Run RPCS3 with `./bin/rpcs3` </br>
If you are on MacOS and want to build with brew llvm and qt don't forget to add the following environment variables
2017-08-08 16:20:41 +00:00
* `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).
2017-01-22 14:57:09 +00:00
2015-12-16 14:20:46 +00:00
When using GDB, configure it to ignore SIGSEGV signal (`handle SIGSEGV nostop noprint`).
2014-04-29 17:55:03 +00:00
2017-06-04 15:44:48 +00:00
## 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.
2016-12-02 10:40:41 +00:00
- ```-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.
2017-06-04 15:44:48 +00:00
- ```-DUSE_NATIVE_INSTRUCTIONS=ON/OFF``` (default = *ON*)
This builds rpcs3 with -march=native, which is useful for local builds, but not good for packages.
2017-06-04 15:44:48 +00:00
## License
2016-12-02 10:40:41 +00:00
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.