Skip to content

Free fork of NotProton: Windows Steam games in Mac Steam, on CodeWeavers' Wine and Apple's Game Porting Toolkit

docs: Bridgeplay README with visuals from bridgeplay.dev

raymondchinsa1fd136e0ea2
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f6b99d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,93 @@
+<p align="center">
+ <a href="https://bridgeplay.dev"><img src="docs/readme/banner.png" alt="Bridgeplay: Windows games, in your Mac's Steam" width="100%"></a>
+</p>
+
+<p align="center">
+ <b>Windows-only Steam games on Apple Silicon, right inside the Steam you already use.</b><br>
+ Same library. Same Play button. No bottles, no second launcher.
+</p>
+
+<p align="center">
+ <a href="https://bridgeplay.dev"><img alt="Website" src="https://img.shields.io/badge/bridgeplay.dev-000?style=for-the-badge&logo=safari&logoColor=white"></a>
+ <a href="https://github.com/raymondchins/Bridgeplay/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/raymondchins/Bridgeplay?style=for-the-badge&logo=github&color=000&labelColor=1c1c1e"></a>
+ <img alt="Apple Silicon" src="https://img.shields.io/badge/Apple_Silicon-M1_or_later-000?style=for-the-badge&logo=apple&logoColor=white">
+ <img alt="macOS 26+" src="https://img.shields.io/badge/macOS-26%2B-000?style=for-the-badge">
+ <a href="LICENSE"><img alt="License GPL-3.0" src="https://img.shields.io/badge/license-GPL--3.0-000?style=for-the-badge"></a>
+</p>
+
+<br>
+
+<p align="center">
+ <img src="docs/readme/bento.png" alt="What Bridgeplay does: plays inside Steam, up to 3x the frames, DLSS answered by MetalFX, DirectX 12 on Metal, any controller, full Retina, one-click install" width="100%">
+</p>
+
+## What it does
+
+| | |
+|---|---|
+| **Plays 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. |
+
+<p align="center">
+ <img src="docs/readme/tour-steam.png" alt="A Windows game in the Mac Steam library, with Play" width="49%">
+ <img src="docs/readme/tour-props.png" alt="Steam's Compatibility panel with Bridgeplay graphics and frame generation settings" width="49%">
+</p>
+<p align="center"><sub>Illustrations of the real screens.</sub></p>
+
+## Already playing
+
+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.
+
+| Game | Launch settings |
+|---|---|
+| Resident Evil Requiem | D3DMetal · DLSS → MetalFX · DLSS Frame Gen · 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 |
+
+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.
+
+<sub>Games with kernel-level anti-cheat do not run.</sub>
+
+## Install
+
+1. **Download the installer** from [bridgeplay.dev](https://bridgeplay.dev). About 660 MB, with the engine and graphics already inside.
+2. **Open `Install.command`.** It puts everything in place. No terminal.
+3. **Follow the Setup Assistant**: Rosetta, graphics, Steam sign-in and one permission.
+4. **Press Play** on any Windows game in Steam.
+
+## Requirements
+
+| | |
+|---|---|
+| Mac | Apple Silicon, M1 or later. Intel Macs are not supported. |
+| macOS | 26 or later |
+| Steam | A Steam account. Windows games install from Steam as usual. |
+| Download | About 660 MB. Installing Rosetta 2 and signing in to Steam need internet. |
+
+## How it works
+
+Bridgeplay runs inside the native macOS Steam client and registers itself as a Steam Play compatibility tool. Under the hood:
+
+- **Engine:** CodeWeavers' open-source WineCX 11.17 with MSync, running under Rosetta 2.
+- **Graphics:** Apple's Game Porting Toolkit 4.0 beta 3 (D3DMetal), linked locally from Apple's download and never redistributed in this repository. 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.
+
+Building from source: see [docs/DEVELOPING.md](docs/DEVELOPING.md) and [docs/BUILD-LOCAL.md](docs/BUILD-LOCAL.md). The one-click installer lives in [`installer/`](installer/).
+
+## 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/).
+
+<p>
+ <a href="https://github.com/raymondchins"><img src="https://github.com/raymondchins.png?size=64" width="32" height="32" alt="" align="left" style="border-radius:50%"></a>
+ &nbsp;Built by <a href="https://github.com/raymondchins"><b>Raymond Chin</b></a>, Jakarta.
+</p>
+
+<sub>Bridgeplay is not affiliated with Apple, Valve, NVIDIA or CodeWeavers. Game Porting Toolkit is Apple software provided under Apple's license for non-commercial use. Steam is a trademark of Valve Corporation. DLSS is a trademark of NVIDIA Corporation. Game names are trademarks of their owners.</sub>
diff --git a/docs/readme/banner.png b/docs/readme/banner.png
new file mode 100644
index 0000000..94f4176
Binary files /dev/null and b/docs/readme/banner.png differ
diff --git a/docs/readme/bento.png b/docs/readme/bento.png
new file mode 100644
index 0000000..e5f0a06
Binary files /dev/null and b/docs/readme/bento.png differ
diff --git a/docs/readme/tour-props.png b/docs/readme/tour-props.png
new file mode 100644
index 0000000..17851e8
Binary files /dev/null and b/docs/readme/tour-props.png differ
diff --git a/docs/readme/tour-steam.png b/docs/readme/tour-steam.png
new file mode 100644
index 0000000..573fd95
Binary files /dev/null and b/docs/readme/tour-steam.png differ