57cdb180c6 | ||
---|---|---|
.github | ||
CMakeModules | ||
data/resources | ||
dep | ||
extras/padtest | ||
scripts | ||
src | ||
.clang-format | ||
.gitattributes | ||
.gitignore | ||
CMakeLists.txt | ||
CMakeSettings.json | ||
CONTRIBUTORS.md | ||
LICENSE | ||
NEWS.md | ||
README.md | ||
README.pt-br.md | ||
duckstation.sln |
README.md
DuckStation - PlayStation 1, aka. PSX Emulator
Latest News | Features | Downloading and Running | Building | Disclaimers
Latest Builds for Windows and Linux (AppImage): https://github.com/stenzek/duckstation/releases/tag/latest
Latest Builds for Windows, Linux (AppImage/Flatpak), and macOS: https://github.com/stenzek/duckstation/releases/tag/preview
Game Compatibility List: https://docs.google.com/spreadsheets/d/1H66MxViRjjE5f8hOl5RQmF5woS1murio2dsLn14kEqo/edit
Wiki: https://www.duckstation.org/wiki/
DuckStation is an simulator/emulator of the Sony PlayStation(TM) console, focusing on playability, speed, and long-term maintainability. The goal is to be as accurate as possible while maintaining performance suitable for low-end devices. "Hack" options are discouraged, the default configuration should support all playable games with only some of the enhancements having compatibility issues.
A "BIOS" ROM image is required to to start the emulator and to play games. You can use an image from any hardware version or region, although mismatching game regions and BIOS regions may have compatibility issues. A ROM image is not provided with the emulator for legal reasons, you should dump this from your own console using Caetla or other means.
Features
DuckStation features a fully-featured frontend built using Qt, as well as a fullscreen/TV UI based on Dear ImGui.
Other features include:
- CPU Recompiler/JIT (x86-64, armv7/AArch32 and AArch64).
- Hardware (D3D11, D3D12, OpenGL, Vulkan, Metal) and software rendering.
- Upscaling, texture filtering, and true colour (24-bit) in hardware renderers.
- PGXP for geometry precision, texture correction, and depth buffer emulation.
- Adaptive downsampling filter.
- Post processing shader chains (GLSL and experimental Reshade FX).
- "Fast boot" for skipping BIOS splash/intro.
- Save state support.
- Windows, Linux, macOS support.
- Supports bin/cue images, raw bin/img files, MAME CHD, single-track ECM, MDS/MDF, and unencrypted PBP formats.
- Direct booting of homebrew executables.
- Direct loading of Portable Sound Format (psf) files.
- Digital and analog controllers for input (rumble is forwarded to host).
- Namco GunCon lightgun support (simulated with mouse).
- NeGcon support.
- Qt and "Big Picture" UI.
- Automatic updates for Windows builds.
- Automatic content scanning - game titles/hashes are provided by redump.org.
- Optional automatic switching of memory cards for each game.
- Supports loading cheats from existing lists.
- Memory card editor and save importer.
- Emulated CPU overclocking.
- Integrated and remote debugging.
- Multitap controllers (up to 8 devices).
- RetroAchievements.
- Automatic loading/applying of PPF patches.
System Requirements
- A CPU faster than a potato. But it needs to be x86_64, AArch32/armv7, or AArch64/ARMv8, otherwise you won't get a recompiler and it'll be slow.
- For the hardware renderers, a GPU capable of OpenGL 3.1/OpenGL ES 3.1/Direct3D 11 Feature Level 10.0 (or Vulkan 1.0) and above. So, basically anything made in the last 10 years or so.
- SDL, XInput or DInput compatible game controller (e.g. XB360/XBOne/XBSeries). DualShock 3 users on Windows will need to install the official DualShock 3 drivers included as part of PlayStation Now.
Downloading and running
Binaries of DuckStation for Windows x64/ARM64, Linux x86_64 (in AppImage/Flatpak formats), and macOS Universal Binaries are available via GitHub Releases and are automatically built with every commit/push. Binaries or packages distributed through other sources may be out of date and are not supported by the developer, please speak to them for support, not us.
Windows
As of 2023/08/16, Preview releases of DuckStation require Windows 10. I have hit several issues in new features I am working on that are present in Qt 6.1, but not in 6.5.
For now, this only applies to the Preview build, the "Latest Rolling Release" will still work on Windows 7/8/8.1 for now, with the disclaimer below. Once the new in-progress features are ready for widespread use, this build will move to legacy status.
Windows 10 is the only version of Windows supported by the developer. Windows 7/8 may work, but is not supported. I am aware some users are still using Windows 7, but it is no longer supported by Microsoft and too much effort to get running on modern hardware. Game bugs are unlikely to be affected by the operating system, however performance issues should be verified on Windows 10 before reporting.
To download:
- Go to https://github.com/stenzek/duckstation/releases/tag/latest, and download the Windows x64 build. This is a zip archive containing the prebuilt binary.
- Alternatively, direct download link: https://github.com/stenzek/duckstation/releases/download/latest/duckstation-windows-x64-release.zip
- Extract the archive to a subdirectory. The archive has no root subdirectory, so extracting to the current directory will drop a bunch of files in your download directory if you do not extract to a subdirectory.
Once downloaded and extracted, you can launch the emulator with duckstation-qt-x64-ReleaseLTCG.exe
.
To set up:
- Either configure the path to a BIOS image in the settings, or copy one or more PlayStation BIOS images to the bios/ subdirectory. On Windows, by default this will be located in
C:\Users\YOUR_USERNAME\Documents\DuckStation\bios
. If you don't want to use the Documents directory to save the BIOS/memory cards/etc, you can use portable mode. See User directory. - If using the Qt frontend, add the directories containing your disc images by clicking
Settings->Add Game Directory
. - Select a game from the list, or open a disc image file and enjoy.
If you are using the preview release, the setup wizard will guide you through these steps.
If you get an error about vcruntime140_1.dll
being missing, you will need to update your Visual C++ runtime. You can do that from this page: https://support.microsoft.com/en-au/help/2977003/the-latest-supported-visual-c-downloads. Specifically, you want the x64 runtime, which can be downloaded from https://aka.ms/vs/17/release/vc_redist.x64.exe.
Windows 7 users, TLS 1.2 is not supported by default and you will not be able to use the automatic updater or RetroAchievements. This knowledge base article contains instructions for enabling TLS 1.1/1.2: https://support.microsoft.com/en-us/topic/update-to-enable-tls-1-1-and-tls-1-2-as-default-secure-protocols-in-winhttp-in-windows-c4bd73d2-31d7-761e-0178-11268bb10392
The Qt frontend includes an automatic update checker. Builds downloaded after 2020/08/07 will automatically check for updates each time the emulator starts, this can be disabled in Settings. Alternatively, you can force an update check by clicking Help->Check for Updates
.
Linux
The only supported version of DuckStation for Linux are the AppImage and Flatpak in the releases page. Other AppImages or Flatpaks, including Flathub/"Discover" store are not supported, and if history is any indication, likely broken because packagers tend to modify things they don't understand.
AppImage
The AppImages require a distribution equivalent to Ubuntu 22.04 or newer to run.
- Go to https://github.com/stenzek/duckstation/releases/tag/preview, and download
duckstation-x64.AppImage
. - Run
chmod a+x
on the downloaded AppImage -- following this step, the AppImage can be run like a typical executable.
Flatpak
- Go to https://github.com/stenzek/duckstation/releases/tag/preview, and download
duckstation-x64.flatpak
. - Run
flatpak install ./duckstation-x64.flatpak
. - Use
flatpak run org.duckstation.duckstation
to start, or selectDuckStation
in the launcher of your desktop environment.
macOS
Universal MacOS builds are provided for both x64 and ARM64 (Apple Silicon).
Using the Preview channel and Metal renderer is recommended, MoltenVK is reported to have issues with some games.
MacOS Big Sir (11.0) is required, as this is also the minimum requirement for Qt.
To download:
- Go to https://github.com/stenzek/duckstation/releases/tag/preview, and download
duckstation-mac-release.zip
. - Extract the zip by double-clicking it.
- Open DuckStation.app, optionally moving it to your desired location first.
- Depending on GateKeeper configuration, you may need to right click -> Open the first time you run it, as code signing certificates are out of the question for a project which brings in zero revenue.
Android
You will need a device with armv7 (32-bit ARM), AArch64 (64-bit ARM), or x86_64 (64-bit x86). 64-bit is preferred, the requirements are higher for 32-bit, you'll probably want at least a 1.5GHz CPU.
Google Play is the preferred distribution mechanism and will result in smaller download sizes: https://play.google.com/store/apps/details?id=com.github.stenzek.duckstation
No support is provided for the Android app, it is free and your expectations should be in line with that. Please do not email me about issues about it, they will be ignored.
If you must use an APK, download links are listed in https://www.duckstation.org/android/
To use:
- Install and run the app for the first time.
- Add game directories by tapping the add button and selecting a directory. You can add additional directories afterwards by selecting "Edit Game Directories" from the menu.
- Tap a game to start. When you start a game for the first time it will prompt you to import a BIOS image.
If you have an external controller, you will need to map the buttons and sticks in settings.
LibCrypt protection and SBI files
A number of PAL region games use LibCrypt protection, requiring additional CD subchannel information to run properly. libcrypt not functioning usually manifests as hanging or crashing, but can sometimes affect gameplay too, depending on how the game implemented it.
For these games, make sure that the CD image and its corresponding SBI (.sbi) file have the same name and are placed in the same directory. DuckStation will automatically load the SBI file when it is found next to the CD image.
For example, if your disc image was named Spyro3.cue
, you would place the SBI file in the same directory, and name it Spyro3.sbi
.
Building
Windows
Requirements:
- Visual Studio 2022
- Clone the respository:
git clone https://github.com/stenzek/duckstation.git
. - Download the dependencies pack from https://github.com/stenzek/duckstation-ext-qt-minimal/releases/download/latest/deps-x64.7z, and extract it to
dep\msvc
. - Open the Visual Studio solution
duckstation.sln
in the root, or "Open Folder" for cmake build. - Build solution.
- Binaries are located in
bin/x64
. - Run
duckstation-qt-x64-Release.exe
or whichever config you used.
Linux
Requirements (Debian/Ubuntu package names):
- CMake (
cmake
) - SDL2 (at least version 2.28.2) (
libsdl2-dev
libxrandr-dev
) - pkgconfig (
pkg-config
) - Qt 6 (at least version 6.5.1) (
qt6-base-dev
qt6-base-private-dev
qt6-base-dev-tools
qt6-tools-dev
libqt6svg6
) - git (
git
) (Note: needed to clone the repository and at build time) - When Wayland is enabled (default): (
libwayland-dev
libwayland-egl-backend-dev
extra-cmake-modules
qt6-wayland
) - Optional for RetroAchievements (on by default): libcurl (
libcurl4-gnutls-dev
) - Optional for faster building: Ninja (
ninja-build
)
- Clone the repository:
git clone https://github.com/stenzek/duckstation.git -b dev
. - Create a build directory, either in-tree or elsewhere.
- Run CMake to configure the build system. Assuming a build subdirectory of
build-release
, runcmake -Bbuild-release -DCMAKE_BUILD_TYPE=Release
. If you have installed Ninja, add-GNinja
at the end of the CMake command line for faster builds. - Compile the source code. For the example above, run
cmake --build build-release --parallel
. - Run the binary, located in the build directory under
bin/duckstation-qt
.
macOS
NOTE: macOS is highly experimental and not tested by the developer. Use at your own risk; things may be horribly broken. Vulkan support may be unstable, so sticking to OpenGL or software renderer is recommended.
Requirements:
- CMake
- SDL2 (at least version 2.28.2)
- Qt 6 (at least version 6.5.1)
Optional (recommended for faster builds):
- Ninja
- Clone the repository:
git clone https://github.com/stenzek/duckstation.git
. - Run CMake to configure the build system:
cmake -Bbuild-release -DCMAKE_BUILD_TYPE=Release
. You may need to specify-DQt6_DIR
depending on your system. If you have installed Ninja, add-GNinja
at the end of the CMake command line for faster builds. - Compile the source code:
cmake --build build-release --parallel
. - Run the binary, located in the build directory under
bin/DuckStation.app
.
User Directories
The "User Directory" is where you should place your BIOS images, where settings are saved to, and memory cards/save states are saved by default. An optional SDL game controller database file can be also placed here.
This is located in the following places depending on the platform you're using:
- Windows: My Documents\DuckStation
- Linux:
$XDG_DATA_HOME/duckstation
, or~/.local/share/duckstation
. - macOS:
~/Library/Application Support/DuckStation
.
So, if you were using Linux, you would place your BIOS images in ~/.local/share/duckstation/bios
. This directory will be created upon running DuckStation
for the first time.
If you wish to use a "portable" build, where the user directory is the same as where the executable is located, create an empty file named portable.txt
in the same directory as the DuckStation executable.
Bindings for Qt frontend
Your keyboard or game controller can be used to simulate a variety of PlayStation controllers. Controller input is supported through DInput, XInput, and SDL backends and can be changed through Settings -> General Settings
.
To bind your input device, go to Settings -> Controller Settings
. Each of the buttons/axes for the simulated controller will be listed, alongside the corresponding key/button on your device that it is currently bound to. To rebind, click the box next to the button/axis name, and press the key or button on your input device that you wish to bind to. When binding rumble, simply press any button on the controller you wish to send rumble to.
SDL Game Controller Database
DuckStation releases ship with a database of game controller mappings for the SDL controller backend, courtesy of https://github.com/gabomdq/SDL_GameControllerDB. The included gamecontrollerdb.txt
file can be found in the database
subdirectory of the DuckStation program directory.
If you are experiencing issues binding your controller with the SDL controller backend, you may need to add a custom mapping to the database file. Make a copy of gamecontrollerdb.txt
and place it in your user directory (or directly in the program directory, if running in portable mode) and then follow the instructions in the SDL_GameControllerDB repository for creating a new mapping. Add this mapping to the new copy of gamecontrollerdb.txt
and your controller should then be recognized properly.
Default bindings
Controller 1:
- D-Pad: W/A/S/D
- Triangle/Square/Circle/Cross: Numpad8/Numpad4/Numpad6/Numpad2
- L1/R1: Q/E
- L2/R2: 1/3
- Start: Enter
- Select: Backspace
Hotkeys:
- Escape: Power off console
- F11: Toggle fullscreen
- Tab: Temporarily disable speed limiter
- Space: Pause/resume emulation
Disclaimers
Icon by icons8: https://icons8.com/icon/74847/platforms.undefined.short-title
"PlayStation" and "PSX" are registered trademarks of Sony Interactive Entertainment Europe Limited. This project is not affiliated in any way with Sony Interactive Entertainment.