View source for Game Porting Toolkit

Game Porting Toolkit is Apple's new translation layer released on 6th June, 2023. Game Porting Toolkit ('''GPTK''') combines Wine with Apple's own D3DMetal which supports DirectX 9-12. This is less user-friendly method of installing Windows games on Apple Silicon Macs compared to [[CrossOver]] or [[Parallels]], however it unlocks the ability to play many DirectX 12 games. Many more games not work using GPTK, however games that use anti-cheat or aggressive DRM generally don't worker do games that require AVX/AVX 2, e.g. The Last of Us Part I.

== Toolkit install instructions ==
=== Requirements ===
*macOS Sonoma should be used, currently it is in beta. You can download the pkg installer from [https://mrmacintosh.com/macos-sonoma-full-installer-database-download-directly-from-apple/ Mr Macintosh blog].
*macOS Ventura causes large numbers of issues with steamwebhelper.exe crashing so it isn't recommended, use the macOS Sonoma beta.
*Visit [https://developer.apple.com/downloads Apple Developer Downloads site], these files are now free to download use for any logged in Apple account.
**Search for Command Line Tools for Xcode 15 beta and download the dmg file, then install it.
**If you have an old version Xcode installed, remove it.
**Search for Game Porting Toolkit and download it. Open the dmg file and then run the pkg.

=== Homebrew ===
Note: if you have ever installed Homebrew before, then it is advisable to remove arm64 Homebrew as this can interfere with this build process. Either use a Homebrew uninstall script or delete the folder <code>/opt/homebrew/bin</code>. Otherwise, if you prefer to keep both arm64 and x86 versions of brew installed, you may add a "brew-switcher" to your <code>.zshrc</code> file to allow either version to be used depending on the active architecture. You may follow the steps at the end of this section after installing Brew to achieve this.

Open Terminal (search in Spotlight on macOS).

Install Rosetta:
<pre>softwareupdate --install-rosetta</pre>

Enter an x86_64 shell to continue the following steps in a Rosetta environment. All subsequent commands should be run within this shell.
<pre>arch -x86_64 zsh</pre>

Install the x86_64 version of Homebrew if you don't already have it.
<pre>/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"</pre>

Make sure the brew command is on your path:
<pre>which brew</pre>

If this command does not print <code>/usr/local/bin/brew</code>, you should use this command:
<pre>export PATH=/usr/local/bin:${PATH}</pre>

{{Fixbox|description=Optionally retain both arm64 and x86 versions of Brew|ref=<ref>Reference</ref>|collapsed=yes|fix=
(Optional) If you want to have both arm64 and x86 versions of Brew installed, begin by editing your <code>.zshrc</code> file:
<pre>nano ~/.zshrc</pre>

Scroll down (by using the arrow keys or Control + V) to the bottom of the file, and paste the following script:
<pre>
if [ "$(arch)" = "arm64" ]; then
    eval "$(/opt/homebrew/bin/brew shellenv)"
else
    eval "$(/usr/local/bin/brew shellenv)"
fi
</pre>

You may now restart your terminal and use the following command to return to an x86_64 shell:
<pre>arch -x86_64 zsh</pre>
Your shell will now select the right installation of Brew, depending on your architecture.
}}

=== Build ===
Run this command to download Apple tap:
<pre>brew tap apple/apple http://github.com/apple/homebrew-apple</pre>

Install the game-porting-toolkit formula. This formula downloads and compiles several large software projects. How long this takes will depend on the speed of your computer. It can take over 1 hour to complete depending on the speed of your Mac.
<pre>brew -v install apple/apple/game-porting-toolkit</pre>

If during installation you see an error such as '''“Error: game-porting-toolkit: unknown or unsupported macOS version: :dunno”, your version of Homebrew doesn’t have macOS Sonoma support. Update to the latest version of Homebrew and try again.'''
<pre>brew update brew -v install apple/apple/game-porting-toolkit</pre>

===Wine prefix ===
A Wine prefix contains a virtual C: drive. You will install the toolkit and your game into this virtual C: drive. Run the following command to create a new Wine prefix named my-game-prefix in your home directory.
<pre>WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 winecfg</pre>
*A “Wine configuration” window should appear on your screen.
*Change the version of Windows to Windows 10.
*Choose Apply and then OK to exit winecfg.

If the “Wine configuration” window does not appear, and no new icon appears in the Dock, verify that you have correctly installed the x86_64 version of Homebrew as well as the game-porting-toolkit formula.

=== Preparing the toolkit ===
Make sure the Game Porting Toolkit dmg downloaded earlier is mounted at /Volumes/Game Porting Toolkit-1.0. Use this script to copy the Game Porting Toolkit library directory into Wine’s library directory.
<pre>ditto /Volumes/Game\ Porting\ Toolkit-1.0/lib/ `brew --prefix game-porting-toolkit`/lib/</pre>

Put the 3 scripts from the Game Porting Toolkit DMG into here <code>/usr/local/bin</code> using this command:
<pre>cp /Volumes/Game\ Porting\ Toolkit*/gameportingtoolkit* /usr/local/bin</pre>

Now you are ready to install a launcher or individual Windows games, see below.

== Steam ==
Download the [https://cdn.cloudflare.steamstatic.com/client/installer/SteamSetup.exe Windows version of Steam] and place in your Downloads folder.

'''Install Steam'''
<pre>gameportingtoolkit ~/my-game-prefix ~/Downloads/SteamSetup.exe</pre>

'''Run Steam'''
<pre>gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)/Steam/steam.exe'</pre>

'''Log into Steam'''

A common issue is that Steam will present with a blank black window.

Alternate way of launching Steam (after installing):
<pre>
MTL_HUD_ENABLED=1 WINEESYNC=1 WINEPREFIX=~/my-game-prefix /usr/local/Cellar/game-porting-toolkit/1.0/bin/wine64 'C:\Program Files (x86)\Steam\steam.exe'
</pre>

If this continues then close the Terminal window and then re-open and try again, repeat until the login screen opens. Now you should be able to download and launch Windows games through Steam.

== Battle.net ==
Download the [https://download.battle.net/en-gb/?platform=windows Windows version of Battle.net].

Make a new Wineprefix for Battle.net - we will refer to this as battle-net from now:
<pre>WINEPREFIX=~/battle-net `brew --prefix game-porting-toolkit`/bin/wine64 winecfg</pre>
*A “Wine configuration” window should appear on your screen.
*Change the version of Windows to <code>Windows 10</code>.
*Choose Apply and then OK to exit winecfg.

'''Run Battle.net launcher'''
<pre>gameportingtoolkit ~/battle-net ~/Downloads/Battle.net-Setup.exe</pre>

Be aware that there is an issue launching Battle.net once installed, the only current way to re-login is to 'install' the launcher again. 

Start individual game without the launcher using this command:
<pre>arch -x86_64 gameportingtoolkit-no-hud ~/battle-net 'C:\Program Files (x86)\Diablo IV\Diablo IV Launcher.exe'</pre>

== Epic and GOG.com support ==
This is particularly useful because '''as it currently stands, the real Epic Games Launcher fails to install under the Game Porting Toolkit'''. Heroic supports Epic and GOG.com games.

* Install the [https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/releases native macOS Heroic Games Launcher] or from Homebrew.
* Open Heroic, and log into your Epic Games and/or GOG.com account.
* Go to the "Wine Manager" and install a '''numbered''' version of Wine, such that it won't auto update- we are going to modify it.
** At the time of writing this, the newest numbered version of Wine-Crossover is <code>Wine-Crossover-Wine-22.1.0</code>
* Press the folder icon that appears after installing it to open the directory containing Heroic's Wine installations.
* Right-click on the version of Wine you just installed and press "Show Package Contents".
* Open this directory in the Terminal.
** If you have "OpenInTerminal" this is one button, otherwise press "Show Path Bar" and navigate where it says with "cd".
** It should be something like <code>cd ~/Library/Application Support/heroic/tools/wine/Wine-crossover-wine-22.1.0</code>.
* <pre>cd Contents/MacOS</pre>
* Remove the existing Wine: <pre>rm wine</pre>
* Create a symlink to Game Porting Toolkit's Wine: 
** If using Game Porting Toolkit Wineprefix: <pre>ln -s `/usr/local/bin/brew --prefix game-porting-toolkit`/bin/wine64 wine</pre>
** If using Whisky: <pre>ln -s /Applications/Whisky.app/Contents/Resources/Libraries/Wine/bin/wine64 wine</pre>
* <pre>cd ../Resources</pre>
* Remove the existing Wine: <pre>rm -rfv wine</pre>
* Create a symlink to Game Porting Toolkit's Wine
** If using Game Porting Toolkit Wineprefix: <pre>ln -s `/usr/local/bin/brew --prefix game-porting-toolkit` wine</pre>
** If using Whisky: <pre>ln -s /Applications/Whisky.app/Contents/Resources/Libraries/Wine wine</pre>
* We are now done with Terminal. Install any games you want to try playing.
* Select the game you want to play, and press the settings button in the top-right.
* Make sure the version of Wine you just downloaded and modified is selected.
* Make sure your Game Porting Toolkit Wine Prefix is selected. If you followed Apple's guide this is <code>/Users/you/my-game-prefix</code>.
* If you Open the "Other" section you can also add any environment variables you want like <code>WINEESYNC=1"</code> and <code>"MTL_HUD_ENABLED=1"</code>
* Close the settings and try running the game.

== Commands ==
Installing individual exe games: open your Wine prefix’s virtual C: drive in Finder (open ~/my-game-prefix/drive_c) and copy your game into an appropriate subdirectory.

'''A. Standard launching'''
<pre>gameportingtoolkit ~/my-game-prefix 'C:\Program Files\MyGame\MyGame.exe'</pre>

This launches the given Windows game binary with a visible extended Metal Performance HUD and filters logging to output from the Game Porting Toolkit.

'''B. Launching without a HUD'''
<pre>gameportingtoolkit-no-hud ~/my-game-prefix 'C:\Program Files\MyGame\MyGame.exe'</pre>

'''C. Launching with Wine ESYNC disabled'''
<pre>gameportingtoolkit-no-esync ~/my-game-prefix 'C:\Program Files\MyGame\MyGame.exe'</pre>

To enter Winecfg:
<pre>gameportingtoolkit ~/my-game-prefix winecfg</pre>

== Shortcut ==
You can make a shortcut for Steam for example by using macOS built-in Automator app.
*Open Automator.
*Select New Application.
*In the 2nd column select Run Shell Script.
*Copy and paste this code into the box:
<pre>
#!/bin/zsh

export PATH="/usr/local/bin:${PATH}"

arch -x86_64 gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'
</pre>
*Save the shortcut somewhere e.g. Applications.
*Above shortcut can be customised to any Wineprefix or game.
*Add an icon by selecting the shortcut, pressing {{key|cmd|I}} to Get Info, then dragging and dropping a PNG file onto the top left of the window.

== Logging ==
The provided bin/gameportingtoolkit* scripts can be copied onto your path to facilitate different forms of logging and launching. You can run these scripts from any shell; you don’t need to switch to the Rosetta environment first.

Logging output will appear in the Terminal window in which you launch your game as well as the system log, which can be viewed with the Console app found in Applications ▸ Utilities. Log messages from the Game Porting Toolkit are prefixed with D3DM. By default the gameportingtoolkit* scripts will filter to just the D3DM-prefixed messages.

== Troubleshooting ==
'''Steam login black screen'''

Close the Terminal window and then reopen and retry the command, repeat several times.

Alternate way of launching Steam (after installing):
<pre>
MTL_HUD_ENABLED=1 WINEESYNC=1 WINEPREFIX=<path to the Wine bottle you set up> /usr/local/Cellar/game-porting-toolkit/1.0/bin/wine64 'C:\Program Files (x86)/Steam/steam.exe'
</pre>

If still not working then try using [[CrossOver]] and create a Steam bottle, then redirect this WINEPREFIX to that bottle:
<pre>
WINEPREFIX="/Users/[username]/Library/Application Support/CrossOver/Bottles/Steam/" 
</pre>

'''Steam crashes straight after opening'''

Disconnect any external monitors.

'''Battle.net launcher won't re-launch'''

Re-install the launcher to reopen, no other fix at the moment.

'''My game won’t run because it thinks the version of Windows is too old. Some games detect specific minimum versions of Windows and need to be updated.''' Use this script to update your wineprefix with build 19042 which should work for most games e.g. Spider-Man Remastered.
<pre>
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 reg add 'HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion' /v CurrentBuild /t REG_SZ /d 19042 /f
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 reg add 'HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion' /v CurrentBuildNumber /t REG_SZ /d 19042 /f
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wineserver -k
</pre>

'''steamwebhelper.exe crashes'''

This is caused by Steam being run through macOS Ventura or below, upgrade to macOS Sonoma.

'''My game won't run and crashes with an invalid instruction'''

AVX and AVX2 games are not supported by Apple's arm64 chipset.

'''My game won't run because its anti-cheat or DRM software is incompatible with Wine translation.'''

Likely there will be no fixes for any games that use anti-cheat, e.g. Easy Anti Cheat. Some games have workarounds e.g. Elden Ring. Other games that use say Denuvo may also be incompatible until that DRM is removed by the game's developer.

'''My game won’t run because it requires Mono, .NET, or the MSVCRT runtime.'''

The game porting toolkit’s evaluation environment does not pre-install these runtime support packages. If your game makes use of one of these packages, consider searching for and downloading appropriate installers (.exe or .msi) and installing them to your evaluation environment. Additional runtime installers can be run on your environment by just launching the installer and following its installation instructions:
<pre>
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 <some-installer.exe>
</pre>

And .MSI packages can be installed by launching the Windows uninstaller application and choosing to install a downloaded .msi package:
<pre>
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 uninstaller
</pre>

'''Controller issues'''

Issues may be fixed by enrolling into the Steam beta.

'''My game looks pixelated and the display resolution is limited'''

Enable Retina (high resolution) mode:
<pre>
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 reg add 'HKEY_CURRENT_USER\Software\Wine\Mac Driver' /v RetinaMode /t REG_SZ /d 'Y' /f
</pre>
Some games will not run with Retina mode enabled. To disable it:
<pre>
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 reg add 'HKEY_CURRENT_USER\Software\Wine\Mac Driver' /v RetinaMode /t REG_SZ /d 'N' /f
</pre>

== Game compatibility list ==
Working games:
* Halo 3 (MCC - No Online due to Easy Anti-Cheat Compatibility)
* Cyberpunk 2077
* Final Fantasy VII Remake Intergrade (~50 FPS on High settings at 1080p with M1 Pro)
* God of War (Works somewhat well on M1 Pro (16gb), wouldn't recommend lesser hardware.)
* Elden Ring
* SpongeBob SquarePants: The Cosmic Shake
* Diablo IV [https://www.reddit.com/r/macgaming/comments/14307be/comment/jn7dxzo/?utm_source=reddit&utm_medium=web2x&context=3 ]
* Hogwarts Legacy
* Deep Rock Galactic
* Sonic Omens
* Sonic P-06
* Scarlet Nexus
* Metal Gear Solid V: The Phantom Pain
* Dyson Sphere Program (some objects and main character weren't visible before)
* Derail Valley (awesome performance, no missing manuals - in-game objects for train operation - like on CrossOver)
* Spider-Man (2018)
* Spider-Man Miles Morales - ''requires Windows ver fix''
* Warframe - ''To get installer/launcher working add dwrite (disabled) to library overrides in winecfg''
* HI-Fi RUSH
* QUBE 2
* Deceive Inc. - works well if launched without EAC
* Risk of Rain 2 (does not require `-disable-gpu-skinning` like Crossover 22)
* Crysis Remastered
* Cuphead
* Bloodstained: Ritual of the Night
* Tetris Effect: Connected - Game window likes to be uncooperative; really doesn't like retina mode, works otherwise
* Hatsune Miku: Project DIVA Mega Mix+ - works with Retina mode; DivaModLoader and DivaNoSpy recommended; run Steam with WINEDEBUG=-all WINEESYNC=0 WINEDLLOVERRIDES="dinput8.dll=n,b"; may randomly crash at the title screen (just restart and try again until it works)

Not working well:
* Horizon Zero Dawn - slowdown issues

Not working yet:
* Hitman 3 - launcher works, crash at 0x0000014136dddd hitman3+0x136dddd: int $3
* Among Us
* Tiny Tina's Wonderlands - Intro videos play, dragon animation indicating shader precompilation starts, game freezes, eventually crashes.
* Halo Infinite - Crash on launch
* Street Fighter 6 - Crash on launch
* Company of Heroes 3
* Many (all?) DX9 games
** 30XX - "Failed to create D3D device" -> crash on launch; this is a rare 64-bit DX9 game
** Left 4 Dead 2 - Black screen -> crash on launch
** Killing Floor 1 - Crash on launch
** Sonic Mania - Crash on launch
** Mega Man Zero/ZX Legacy Collection - "Failed to create d3d9 device" -> crash on launch