2019-10-20 12:05:44 +00:00
# DuckStation - PlayStation (PSX) Emulator
## Features
2019-12-04 11:57:47 +00:00
- CPU Recompiler/JIT (x86-64 and AArch64)
2019-11-22 08:30:57 +00:00
- Hardware (D3D11 and OpenGL) and software rendering
- Upscaling and true colour (24-bit) in hardware renderers
- "Fast boot" for skipping BIOS splash/intro
- Save state support
2019-11-24 14:21:29 +00:00
- Windows and Linux support - macOS may work, but not actively maintained
- Currently only .bin/.cue disc image formats are supported. Additional formats are planned
- Direct booting of homebrew executables
2019-12-15 14:05:48 +00:00
- Digital and analog controllers for input (rumble is forwarded to host)
2019-11-24 14:21:29 +00:00
## System Requirements
- A CPU faster than a potato.
- For the hardware renderers, a GPU capable of OpenGL 3.0/OpenGL ES 3.0/Direct3D 11 Feature Level 10.0 and above. So, basically anything made in the last 10 years or so.
- SDL-compatible game controller (e.g. XB360/XBOne)
2019-11-22 08:30:57 +00:00
## Building
### Windows
Requirements:
- Visual Studio 2019
2020-01-11 06:59:18 +00:00
1. Clone the respository with submodules (`git clone --recursive` or `git clone` and `git submodule update --init` ).
2. Open the Visual Studio solution `duckstation.sln` in the root, or "Open Folder" for cmake build.
3. Build, binaries are located in `bin/x64` .
4. Copy the DLL files from `dep/msvc/bin64` to the binary directory.
5. Run `duckstation-x64-Release.exe` or whichever config you used.
2019-11-22 08:30:57 +00:00
### Linux
Requirements:
- CMake
- SDL2
2020-01-11 06:59:18 +00:00
1. Clone the repository. Submodules aren't necessary, there is only one and it is only used for Windows.
2. Create a build directory, either in-tree or elsewhere.
3. Run cmake to configure the build system. Assuming a build subdirectory of `build-release` , `cd build-release && cmake -DCMAKE_BUILD_TYPE=Release -GNinja ..` .
4. Compile the source code. For the example above, run `ninja` .
5. Run the binary, located in the build directory under `src/duckstation/duckstation` .
2019-11-22 08:30:57 +00:00
2019-12-04 11:57:47 +00:00
### Android
2019-12-18 13:04:26 +00:00
**NOTE:** The Android frontend is still incomplete, not all functionality works and some paths are hard-coded.
2019-12-04 11:57:47 +00:00
Requirements:
- Android Studio with the NDK and CMake installed
2020-01-11 06:59:18 +00:00
1. Clone the repository. Submodules aren't necessary, there is only one and it is only used for Windows.
2. Open the project in the `android` directory.
3. Select Build -> Build Bundle(s) / APKs(s) -> Build APK(s).
4. Install APK on device, or use Run menu for attached device.
2019-12-04 11:57:47 +00:00
2019-11-22 08:30:57 +00:00
## Running
1. Configure the BIOS path in the settings.
2. Open a disc image file, enjoy.
## Default keyboard bindings
Keyboard bindings are currently not customizable. For reference:
- **D-Pad:** W/A/S/D or Up/Left/Down/Right
- **Triangle/Square/Circle/Cross:** I/J/L/K or Numpad8/Numpad4/Numpad6/Numpad2
- **L1/R1:** Q/E
- **L2/L2:** 1/3
- **Start:** Enter
- **Select:** Backspace
Gamepads are automatically detected and supported. Tested with an Xbox One controller.
To access the menus with the controller, press the right stick down and use the D-Pad to navigate, A to select.
## Useful hotkeys
- **F1-F8:** Quick load/save (hold shift to save)
- **F11:** Toggle fullscreen
- **Tab:** Temporarily disable speed limiter
- **Pause/Break:** Pause/resume emulation
- **Space:** Frame step
2019-11-24 14:21:29 +00:00
- **End:** Toggle software renderer
2019-11-22 08:30:57 +00:00
- **Page Up/Down:** Increase/decrease resolution scale in hardware renderers
2019-10-20 12:05:44 +00:00
## Tests
2019-11-24 14:21:29 +00:00
- Passes amidog's CPU and GTE tests in both interpreter and recompiler modes, partial passing of CPX tests
2019-10-20 12:05:44 +00:00
## Screenshots
2019-11-22 12:04:31 +00:00
2019-10-20 12:05:44 +00:00
2019-11-22 12:04:31 +00:00
2019-10-20 12:05:44 +00:00
## Disclaimers
Icon by icons8: https://icons8.com/icon/74847/platforms.undefined.short-title
2019-12-04 11:57:47 +00:00
"PlayStation" and "PSX" are registered trademarks of Sony Interactive Entertainment Europe Limited. This project is not affiliated in any way with Sony Interactive Entertainment.
