Free fork of NotProton: Windows Steam games in Mac Steam, on CodeWeavers' Wine and Apple's Game Porting Toolkit
Swift apple-silicond3dmetaldxmtdxvkgame-porting-toolkitgptkmac-gamingmacosmetalfxrosetta-2steamsteam-playwinewinecx
docs: plainer claims, full list of Steam changes, shorter copy
raymondchins1fede05d29ab
diff --git a/README.md b/README.mdindex 25680ba..1ecd03f 100644--- a/README.md+++ b/README.md@@ -20,20 +20,20 @@<br><p align="center">- <img src="docs/readme/bento-v4.png" alt="What Bridgeplay does: plays natively inside Steam, up to 3x the frames, DLSS answered by MetalFX, DirectX 12 on Metal, any controller, full Retina, one-click install" width="100%">+ <img src="docs/readme/bento-v5.png" alt="What Bridgeplay does: plays inside Mac Steam, experimental frame generation, DLSS answered by MetalFX, DirectX 12 on Metal, any controller, full Retina one switch away, guided install" width="100%"></p>## What it does| | ||---|---|-| **Plays natively inside Steam** | Windows games sit in your Mac Steam library and start with Play, like Mac games. |-| **DirectX 12 on Metal** | Apple's Game Porting Toolkit 4 (D3DMetal) runs DirectX 11 and 12 on your Mac's GPU. |-| **DLSS, answered by MetalFX** | Games see a DLSS-capable card, so the option shows up. Apple's MetalFX does the upscaling, and DLSS Frame Generation runs on MetalFX interpolation. |-| **Up to 3× the frames** | Built-in frame generation (2×, 3×, adaptive) for any game, native Mac games included, switched on per game from Steam's properties. |-| **Any controller** | DualSense, Xbox, GameSir and other pads work without a mapping screen. |-| **Full Retina** | Games draw at your display's real resolution. |-| **One-click install** | Open the installer and a Setup Assistant handles Rosetta, Steam and permissions. |+| **Plays inside Mac Steam** | Windows games sit in your Mac Steam library and start with Play. They run in Wine under Rosetta 2. |+| **DirectX 12 on Metal** | Apple's D3DMetal runs DirectX 11 and 12 on your Mac's GPU. |+| **DLSS, answered by MetalFX** | Games on D3DMetal see an NVIDIA card by default, so DLSS shows up. Apple's toolkit runs it on MetalFX. |+| **Frame generation (experimental)** | Up to 3× displayed frames, with a little added latency. Off by default; turn it on per game. |+| **Any controller** | DualSense, Xbox, GameSir and more, with no mapping screen. |+| **Full Retina, one switch away** | Off by default because it's slower. Turn on High Resolution to draw at your display's real resolution. |+| **Guided install** | A Setup Assistant walks you through Rosetta, Steam and permissions. |<p align="center"><img src="docs/readme/tour-v4.png" alt="Mac gaming, unleashed: a Windows game in the Mac Steam library, ready to Play" width="100%">@@ -43,22 +43,20 @@## Already playing<p align="center">- <img src="docs/readme/games-v4.png" alt="Games already running with Bridgeplay: Resident Evil Requiem, Marvel's Spider-Man 2, 007 First Light, Deadlock and more" width="100%">+ <img src="docs/readme/games-v5.png" alt="Games running with Bridgeplay: Resident Evil Requiem, Marvel's Spider-Man 2, 007 First Light and more" width="100%"></p>-Verified on a MacBook Pro with M5 Max and Game Porting Toolkit 4.0 beta 3, each averaging above 90 fps as measured by the developer. Settings are the ones each game launched with, read from its launch log.+Developer's tests on an M5 Max MacBook Pro with Game Porting Toolkit 4.0 beta 3: 90+ fps, with MetalFX upscaling and frame generation where listed. Settings come from each game's launch log.| Game | Launch settings ||---|---|-| Resident Evil Requiem | D3DMetal · DLSS → MetalFX · DLSS Frame Gen · Retina · V-Sync forced |+| Resident Evil Requiem | D3DMetal · DLSS → MetalFX · DLSS Frame Gen (experimental) · Retina · V-Sync forced || Marvel's Spider-Man 2 | D3DMetal · Retina · MSync |-| 007 First Light | D3DMetal · DLSS → MetalFX · DLSS Frame Gen · Retina |-| Deadlock | D3DMetal · DLSS → MetalFX · Retina · audio fix |-| TEKKEN 8 | D3DMetal · Retina · ranked online |+| 007 First Light | D3DMetal · DLSS → MetalFX · DLSS Frame Gen (experimental) · Retina |-Also running on the same setup: Street Fighter 6, Mortal Kombat 1, The Last of Us Part I, Death Stranding Director's Cut, Horizon Zero Dawn, Split Fiction, It Takes Two, A Way Out, Batman: Arkham Knight, Sifu, Ghostrunner, Control Resonant, Ravenswatch, Megabonk, PowerWash Simulator 2, The Witcher 3.+Also running on the same setup: Mortal Kombat 1, The Last of Us Part I, Death Stranding Director's Cut, Horizon Zero Dawn, Split Fiction, It Takes Two, A Way Out, Batman: Arkham Knight, Sifu, Ghostrunner, Ravenswatch, Megabonk, PowerWash Simulator 2, The Witcher 3.-<sub>Games with kernel-level anti-cheat do not run.</sub>+<sub>Most games with kernel-level anti-cheat won't run.</sub>### Compatibility list@@ -70,7 +68,7 @@ To add yours: after you play, Bridgeplay asks once per game *How did it run?* On1. **Download the installer** from [bridgeplay.dev](https://bridgeplay.dev): `Bridgeplay-Setup.zip`, under 1 MB. It fetches Bridgeplay, Apple's graphics, the engine and Steam (from Valve, if missing) as it installs, and checks every download against Bridgeplay's signature.2. **Open Bridgeplay Installer.** macOS blocks it the first time: `READ ME FIRST.html` in the download shows the three clicks, Done, then **Open Anyway** in **System Settings > Privacy & Security**, then confirm with your password or Touch ID. It needs an admin account.-3. **Follow the Setup Assistant**: Rosetta, graphics, Steam sign-in and a couple of standard macOS prompts. Setup modifies your Steam app; see [What Bridgeplay changes in Steam](#what-bridgeplay-changes-in-steam).+3. **Follow the Setup Assistant**: Rosetta, graphics, Steam sign-in, App Management and a couple of other standard macOS prompts. Setup modifies your Steam app; see [What Bridgeplay changes in Steam](#what-bridgeplay-changes-in-steam).4. **Press Play** on any Windows game in Steam. The first time you use a controller, allow Steam's Input Monitoring request.Each game's Bridgeplay settings (graphics backend, Metal HUD, DLSS, frame generation, controllers) are in Steam: right-click the game, **Properties… › Bridgeplay**.@@ -102,27 +100,40 @@ Bridgeplay runs inside the native macOS Steam client and registers itself as a S- **Engine:** CodeWeavers' open-source WineCX 11.17 with MSync, running under Rosetta 2. Bridgeplay does not include CrossOver: its free engine is built from the LGPL source CodeWeavers publishes ([dappermint/winecx](https://github.com/dappermint/winecx)). If you own CrossOver, Bridgeplay can run games on your copy instead.- **Graphics:** Apple's Game Porting Toolkit 4.0 beta 3 (D3DMetal). It is not stored in this repository; the installer ships its redistributables under Apple's non-commercial license (see Install). DXMT and DXVK are available for games that prefer them.-- **Extras:** NVAPI/NGX routing for DLSS on MetalFX, in-process frame generation on `CAMetalLayer`, per-game Game Mode, Retina back buffers and a controller layer for HID pads.+- **Extras:** NVAPI/NGX routing for DLSS on Apple's MetalFX, in-process frame generation on `CAMetalLayer`, per-game Game Mode, Retina back buffers and a controller layer for HID pads.<p align="center"><img src="docs/readme/architecture-v5.png" alt="How a Windows game reaches the Mac's GPU: Steam, Bridgeplay, the WineCX and Wine engines, D3DMetal, DXMT, DXVK and MoltenVK, then Metal, with the open-source project behind each piece" width="100%"></p>-Building from source: see [docs/DEVELOPING.md](docs/DEVELOPING.md), [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) and [docs/BUILD-LOCAL.md](docs/BUILD-LOCAL.md). The one-click installer lives in [`installer/`](installer/) and is packaged by `scripts/package-installer.sh`.+Building from source: see [docs/DEVELOPING.md](docs/DEVELOPING.md), [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) and [docs/BUILD-LOCAL.md](docs/BUILD-LOCAL.md). The installer lives in [`installer/`](installer/) and is packaged by `scripts/package-installer.sh`.## What Bridgeplay changes in Steam-Bridgeplay modifies your Steam app. To turn on Steam Play for Windows games, it copies a library (`notproton.dylib`) into `/Applications/Steam.app`, sets Steam's `Info.plist` so Steam loads that library at startup, and re-signs Steam on your Mac with a local signature, which replaces Valve's. The library hooks Steam's compatibility tool, shortcut and launch option code, and changes Steam's interface in memory to show Steam Play. Games run in Wine with Proton's lsteamclient, which passes Steam API calls to your Mac Steam.+Bridgeplay modifies your Steam app. It copies a library (`notproton.dylib`) into `/Applications/Steam.app`, makes Steam load it at startup through `Info.plist`, and re-signs Steam on your Mac, replacing Valve's signature. The library hooks Steam's compatibility tool, shortcut and launch option code, and edits Steam's interface in memory to show Steam Play.-Valve does not support or endorse Bridgeplay, and modifying the Steam client may go against the [Steam Subscriber Agreement](https://store.steampowered.com/subscriber_agreement/). Use it at your own risk. **Repair Steam** and **Remove Everything** on the Status page put Steam's original `Info.plist` back, and reinstalling Steam from Valve restores Valve's signature.+Also changed:++- Steam's default compatibility tool is set in `config.vdf`, and Bridgeplay's tools go in `compatibilitytools.d`.+- Steam's Accessibility and input permissions are reset (`tccutil`), so macOS asks again.+- Steam is signed with a local "NotProton Local Signing" keychain identity, or ad hoc, and loses Valve's hardened runtime.+- The quarantine flag is removed from Steam.app and Bridgeplay's folder, and Wine loaders are re-signed ad hoc where needed.+- Optional **Block Steam client updates** (`steam.cfg`) also blocks Steam's security fixes.+- The library loads for every macOS user of a shared `/Applications/Steam.app`.+- In games, Steam calls reach your Mac Steam through Proton's lsteamclient, via an in-memory redirect (`ntdll-patch/`).+- Games on D3DMetal see an NVIDIA GeForce RTX 4090 by default, so DLSS shows up. `NVAPI=0` turns that off.+- For Apple's MetalFX DLSS only, patched `crypt32` and `wintrust` pass NVIDIA's signature check on Apple's `nvngx.dll` (`ngx-signer-patch/`).+- Some gamefixes turn off a game's Wine check to unlock DLSS, for example in Resident Evil Requiem and The Witcher 3.++Valve doesn't support or endorse Bridgeplay, and modifying Steam may go against the [Steam Subscriber Agreement](https://store.steampowered.com/subscriber_agreement/). Use it at your own risk. **Repair Steam** or **Remove Everything** on the Status page restores Steam's `Info.plist`; if Valve's signature isn't back, reinstall Steam from Valve.## Online games and anti-cheat-Online games with anti-cheat (Easy Anti-Cheat, BattlEye and others) often won't start under Wine. For games that do start, Bridgeplay can't promise that anti-cheat, VAC included, won't flag it, so play online and competitive games at your own risk. The [compatibility list](compat/README.md) shows what other players found.+Online games with anti-cheat (Easy Anti-Cheat, BattlEye and others) often won't start, and Bridgeplay can't promise that anti-cheat, VAC included, won't flag it. Play online at your own risk. The [compatibility list](compat/README.md) shows what other players found.## Credits-Bridgeplay is a fork of [NotProton](https://github.com/NotProtonNot/NotProton) (GPL-3.0), built on CodeWeavers' [WineCX](https://www.codeweavers.com/crossover) and Apple's [Game Porting Toolkit](https://developer.apple.com/games/game-porting-toolkit/). The DualSense Bluetooth bridge and Steam rumble forwarding come from [sn0wst0rm's NotProton fork](https://github.com/sn0wst0rm/NotProton). It also uses [Dobby](https://github.com/jmpews/Dobby) (Apache-2.0), [Sparkle](https://sparkle-project.org) (MIT), [DXMT](https://github.com/3Shain/dxmt) and [DXVK-macOS](https://github.com/Gcenx/DXVK-macOS).+Bridgeplay is a fork of [NotProton](https://github.com/NotProtonNot/NotProton) (GPL-3.0), by way of Leon Seemann's NotProton-WineHQ (see [NOTICE](NOTICE)). It is built on CodeWeavers' [WineCX](https://www.codeweavers.com/crossover), as rebased by [dappermint](https://github.com/dappermint/winecx) and packaged with [winecx-gptk](https://github.com/dappermint/winecx-gptk), and on Apple's [Game Porting Toolkit](https://developer.apple.com/games/game-porting-toolkit/). `lsteamclient` and `steam.exe` come from Valve's [Proton](https://github.com/ValveSoftware/Proton). The DualSense Bluetooth bridge and Steam rumble forwarding come from [sn0wst0rm's NotProton fork](https://github.com/sn0wst0rm/NotProton). It also uses [Dobby](https://github.com/jmpews/Dobby) (Apache-2.0), [Sparkle](https://sparkle-project.org) (MIT), [DXMT](https://github.com/3Shain/dxmt) and [DXVK-macOS](https://github.com/Gcenx/DXVK-macOS).## Support Winediff --git a/SECURITY.md b/SECURITY.mdindex acb23ac..26a021c 100644--- a/SECURITY.md+++ b/SECURITY.md@@ -25,8 +25,20 @@ user is a hardening request, not a vulnerability, but it is still welcome as an## Known trade-offs-- Bridgeplay releases are signed with a self-signed certificate (no Apple Developer ID)- and not notarized, and the installer removes the download's- quarantine flag. Download it only from https://bridgeplay.dev or the GitHub releases.-- Steam is re-signed so it can load Bridgeplay, which removes Valve's hardened runtime.+- Releases are signed with a self-signed certificate (no Apple Developer ID) and not notarized, and the+ installer removes the download's quarantine flag. Download only from https://bridgeplay.dev or GitHub.+- Steam is re-signed to load Bridgeplay, with a local "NotProton Local Signing" keychain identity or ad hoc,+ and loses Valve's hardened runtime.+- `notproton.dylib` loads for every macOS user of a shared `/Applications/Steam.app`.+- Setup removes quarantine from Steam.app and Bridgeplay's folder, resets Steam's Accessibility,+ PostEvent and ListenEvent approvals (`tccutil`), re-signs Wine loaders ad hoc where needed, and sets+ Steam's default compatibility tool (`config.vdf`).+- Optional "Block Steam client updates" (`BootStrapperInhibitUpdateOnLaunch` in `steam.cfg`) also blocks+ Steam's security fixes.+- Game calls to Steam's `steamclient` are redirected in memory to Proton's lsteamclient (`ntdll-patch/`).+- D3DMetal games see an NVIDIA GeForce RTX 4090 by default (`NVAPI=1`) so DLSS shows up; `NVAPI=0` turns it off.+- For Apple's MetalFX DLSS only, patched `crypt32` and `wintrust` pass NVIDIA's signature check on Apple's+ `nvngx.dll` (`ngx-signer-patch/`).+- Some gamefixes turn off a game's Wine check to unlock DLSS (`/WineDetectionEnabled:False`,+ `HIDE_WINE_EXPORTS`).- Updates are verified with an EdDSA signature (`SUPublicEDKey`) before they are installed.diff --git a/docs/GAMEFIXES.md b/docs/GAMEFIXES.mdindex 8c0c495..78ebbed 100644--- a/docs/GAMEFIXES.md+++ b/docs/GAMEFIXES.md@@ -34,8 +34,8 @@ logged, when:| `FRAMEGEN_UI` | `0`, `1` | Same as `BRIDGEPLAY_FRAMEGEN_UI`, Protect UI: keeps static HUD and menus sharp. On when unset || `FRAMEGEN_FALLBACK` | `0`, `1` | Same as `BRIDGEPLAY_FRAMEGEN_FALLBACK`, Fast-motion fallback: skips generated frames that would smear. On when unset || `FRAMEGEN_ENGINE` | `own`, `metalfx` | Same as `BRIDGEPLAY_FRAMEGEN_ENGINE`: the built-in optical flow (`own`, the default) or MetalFX frame interpolation |-| `NVAPI` | `0`, `1` | `1` turns on Apple's `nvapi64` and `nvngx` (DLSS on MetalFX) on an engine with a linked Game Porting Toolkit, for `d3dmetal` only, and makes D3DMetal report an NVIDIA GeForce RTX 4090 (`D3DM_VENDOR_ID=0x10de`, `D3DM_DEVICE_ID=0x2684`, `D3DM_DEVICE_DESCRIPTION`; a `D3DM_*` from a conf or the launch options wins), since games offer DLSS only on an NVIDIA adapter. Off by default, since an nvapi that answers sends some games down NVIDIA-only paths |-| `DLSS_FG` | `0`, `1` | With `NVAPI=1` on `d3dmetal`, `1` sets `CX_ACTIVE_GRAPHICS_BACKEND=d3dmetal` so WineCX reports hardware GPU scheduling, which DLSS frame generation requires. Off by default: [frankea/Whisky#231](https://github.com/frankea/Whisky/pull/231) saw MetalFX frame interpolation on an M5 with D3DMetal 4.0b2 hang WindowServer |+| `NVAPI` | `0`, `1` | `1` turns on Apple's `nvapi64` and `nvngx` (DLSS on MetalFX) on an engine with a linked Game Porting Toolkit, for `d3dmetal` only, and makes D3DMetal report an NVIDIA GeForce RTX 4090 (`D3DM_VENDOR_ID=0x10de`, `D3DM_DEVICE_ID=0x2684`, `D3DM_DEVICE_DESCRIPTION`; a `D3DM_*` from a conf or the launch options wins) and a driver version of 32.0.15.9541 (`NOTPROTON_DRIVER_VERSION`), since games offer DLSS only on an NVIDIA adapter. Without the key, the run script treats it as `0`. Bridgeplay's shipped global `default.conf` sets `NVAPI=1`, so it is on for every game unless a game's conf or launch options say `NVAPI=0`. An nvapi that answers sends some games down NVIDIA-only paths, which is the reason to turn it off |+| `DLSS_FG` | `0`, `1` | With `NVAPI=1` on `d3dmetal`, `1` sets `CX_ACTIVE_GRAPHICS_BACKEND=d3dmetal` so WineCX reports hardware GPU scheduling, which DLSS frame generation requires. Experimental and off by default (the global `default.conf` leaves it out): [frankea/Whisky#231](https://github.com/frankea/Whisky/pull/231) saw MetalFX frame interpolation on an M5 with D3DMetal 4.0b2 hang WindowServer || `STDOUT_NULL` | `0`, `1` | `1` starts the game without a stdout handle, as Steam on Windows does. Source 2 treats any stdout as a console build (`Plat_IsConsoleApplication`) and then skips NGX, so Deadlock offers no DLSS || `VSYNC` | `0`, `1` | `1` makes the game's Metal layer wait for the display even when the game turns vsync off, like forcing vsync in the NVIDIA control panel. For games that lock vsync off with frame generation on (Resident Evil Requiem) and tear above the refresh rate || `HIDE_WINE_EXPORTS` | `0`, `1` | `1` makes `GetProcAddress` fail for ntdll's `wine_*` exports on the WineCX 11.17 engine (`hide-wine-exports-patch/`), like Wine Staging's `HideWineExports`. For games that turn features off under Wine: The Witcher 3 5.0 skips NVIDIA Streamline, so no DLSS |diff --git a/docs/UPSTREAM.md b/docs/UPSTREAM.mdindex 74dfc45..a153ec4 100644--- a/docs/UPSTREAM.md+++ b/docs/UPSTREAM.md@@ -50,7 +50,7 @@ I further recommend going into Steam Settings - Compatibility and selecting theIf a game has a native macOS version as well as a Windows one, Steam will download the macOS version. To override this behavior, right click on the game, select Properties, select Compatibility. Enable 'Force the use of a specific Steam Play compatibility tool'. Select whichever version of CrossOver you want to do use. That will make Steam download the Windows version. Unchecking the 'Force the use...' box or selecting 'No Compatibility Tool' in the drop down list will revert to the macOS version of the game, with the specifics there varying based on your Steam version.-**Valve Anti-Cheat is not supported.** Proton itself does not support VAC in Valve titles; Valve ships native Linux ports instead. VAC titles will launch in Insecure Mode and will not allow matchmaking.+**Valve Anti-Cheat is not supported.** Proton itself does not support VAC in Valve titles; Valve ships native Linux ports instead. Bridgeplay does not promise that VAC titles work.## Free Wine engine (no CrossOver needed)diff --git a/docs/readme/bento-v4.png b/docs/readme/bento-v4.pngdeleted file mode 100644index 6775d1f..0000000Binary files a/docs/readme/bento-v4.png and /dev/null differdiff --git a/docs/readme/bento-v5.png b/docs/readme/bento-v5.pngnew file mode 100644index 0000000..42d30f6Binary files /dev/null and b/docs/readme/bento-v5.png differdiff --git a/docs/readme/games-v4.png b/docs/readme/games-v4.pngdeleted file mode 100644index a59c6d1..0000000Binary files a/docs/readme/games-v4.png and /dev/null differdiff --git a/docs/readme/games-v5.png b/docs/readme/games-v5.pngnew file mode 100644index 0000000..cb3ec30Binary files /dev/null and b/docs/readme/games-v5.png differ