Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.

Difference between revisions of "Game Porting Toolkit"

From AppleGamingWiki, the wiki about gaming on M1 Apple silicon Macs
(Apple internally refers to this as GPT)
 
(222 intermediate revisions by 57 users not shown)
Line 1: Line 1:
 
{{Image|Game Porting Toolkit.png|Released 6th June, 2023 at WWDC23.}}
 
{{Image|Game Porting Toolkit.png|Released 6th June, 2023 at WWDC23.}}
  
Game Porting Toolkit is Apple's new translation layer released on 6th June, 2023. Game Porting Toolkit ('''GPT''') combines Wine with Apple's own D3DMetal which supports DirectX 11 and 12<ref>{{Refurl|url=https://mastodon.gamedev.place/@gavkar/110501451404624870|title=Gokhan Avkarogullari: "@yiningkarlli @aras @romainguy…" - Gamedev Mastodon}}</ref>. 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. A lot more games work using GPTK, however, games that use anti-cheat or aggressive DRMs generally don't work, along with games that require AVX/AVX 2, e.g. The Last of Us Part I.
+
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 11 and 12<ref>{{Refurl|url=https://mastodon.gamedev.place/@gavkar/110501451404624870|title=Gokhan Avkarogullari: "@yiningkarlli @aras @romainguy…" - Gamedev Mastodon}}</ref>. This is a 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. A lot more games work using GPTK, however, games that use anti-cheat or aggressive DRMs generally don't work.
 +
 
 +
Games that require AVX/AVX 2, e.g. The Last of Us Part I, would need either an
 +
* Intel based Mac
 +
* or a version of Rosetta that is capable of translating AVX/AVX 2 instructions to M1 instructions, which is present on macOS Sequoia.
  
 
== Toolkit install instructions ==
 
== Toolkit install instructions ==
 +
 
=== Requirements ===
 
=== 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 Sequoia should be used, if you want to run a game that has AVX/AVX 2 instructions.
 +
*macOS Sonoma should be used. 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.
 
*macOS Ventura causes large numbers of issues with steamwebhelper.exe crashing so it isn't recommended, use the macOS Sonoma beta.
**If you have an old version Xcode installed, remove it.
 
 
*Visit [https://developer.apple.com/downloads Apple Developer Downloads site], these files are now free to download use for any logged in Apple account.
 
*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.
+
**Search for Command Line Tools for Xcode 15 beta and download the dmg file, and run the contained pkg file.
**Search for Game Porting Toolkit and download it. Open the dmg file and then run the pkg.
+
***If you have an old version Xcode installed, remove it.
 +
**Search for Game Porting Toolkit and download it. Open/mount the dmg file (some commands will require that it is mounted).
 +
 
 +
=== Automated Installer ===
 +
*A new open source installer which automates the steps found in the Homebrew approach below is now available from [https://github.com/installaware/AGPT InstallAware's GitHub Repo]. Scroll down where they have a screenshot of their graphical user interface, and download the DMG from the link right above that.
 +
*The automated installer is notarized by Apple, so has no known malware and runs as soon as you've double-clicked it without any Gatekeeper concerns.
 +
*Neither macOS Sonoma nor an Apple Silicon device are required by the automated installer.
 +
*You also won't need to download the Game Porting Toolkit DMG from Apple, although if available, it will be utilized (you just point the installer to the DMG download, and it takes care of the rest). Of course, in this scenario, you would still need macOS Sonoma and an Apple Silicon device to enjoy 3D acceleration benefits.
 +
*The automated installer also doubles up as a GUI to launch existing installed apps, all visually without ever having to drop down to the command line.
  
 +
=== Macports ===
 +
{{Fixbox|description=Macports option ADVANCED USERS ONLY| ref= | collapsed=yes|
 +
fix=(Optional)
 +
 +
if you want install under Macports here is the guide
 +
change directory into /opt
 +
<pre> cd /opt</pre>
 +
clone the repository for macports-wine
 +
<pre> sudo git clone https://github.com/Gcenx/macports-wine</pre>
 +
follow this guide to configure the local repository then sync
 +
https://guide.macports.org/#development.local-repositories
 +
<pre> sudo port sync </pre>
 +
you are ready to install
 +
first install game-porting-toolkit-d3dmetal , it will fail at first , follow the steps it gives you which tells you where to put the game porting toolkit dmg
 +
<pre> sudo port install game-porting-toolkit-d3dmetal</pre>
 +
next you install the porting toolkit itself and you should be good to move onto the Wine Prefix section in this guide, keep in mind it might fail the first time or two , but it might just need a retry; if it still doesn't work after a couple tries please report issues to https://github.com/Gcenx/macports-wine/issues
 +
<pre> sudo port install game-porting-toolkit</pre>
 +
Keep in mind instead of brew --prefix you will need to replace it with the wine from macports path,
 +
/opt/local/libexec/game-porting-toolkit/bin/wine64 ;
 +
and gameportingtoolkit itself should be in path and if not its under
 +
/opt/local/bin/gameportingtoolkit
 +
}}
 
=== Homebrew ===
 
=== Homebrew ===
 
Note: if you have ever installed Homebrew before, then it is advised 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>. 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.
 
Note: if you have ever installed Homebrew before, then it is advised 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>. 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.
Line 25: Line 60:
 
Install the x86_64 version of Homebrew if you don't already have it.
 
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>
 
<pre>/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"</pre>
 +
 +
Set the path:
 +
<pre>
 +
(echo; echo 'eval "$(/usr/local/bin/brew shellenv)"') >> ~/.zprofile
 +
eval "$(/usr/local/bin/brew shellenv)"
 +
</pre>
  
 
Make sure the brew command is on your path:
 
Make sure the brew command is on your path:
Line 31: Line 72:
 
If this command does not print <code>/usr/local/bin/brew</code>, you should use this command:
 
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>
 
<pre>export PATH=/usr/local/bin:${PATH}</pre>
 
 
{{Fixbox|description=Optionally retain both ARM64 and x86 versions of Brew|ref=|collapsed=yes|fix=
 
{{Fixbox|description=Optionally retain both ARM64 and x86 versions of Brew|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:
 
(Optional) If you want to have both ARM64 and x86 versions of Brew installed, begin by editing your <code>.zshrc</code> file:
Line 49: Line 89:
 
Your shell will now select the right installation of Brew, depending on your architecture.
 
Your shell will now select the right installation of Brew, depending on your architecture.
 
}}
 
}}
 +
 +
(For bash holdovers: zsh instructions above also apply to bash. Just replace <code>.zshrc</code> with <code>.bashrc</code> and <code>.zprofile</code> with <code>.bash_profile</code>.)
  
 
=== Build ===
 
=== Build ===
 
Run this command to download Apple tap:
 
Run this command to download Apple tap:
 
<pre>brew tap apple/apple http://github.com/apple/homebrew-apple</pre>
 
<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. This step depending on specs may take around 75 minutes on M1 to 36 minutes on M2 Max.
 +
<pre>brew 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 install apple/apple/game-porting-toolkit</pre>
 +
 +
=== Prebuild ===
 +
To save time you can use prebuild GPTK formula maintained by Gcenx.
 +
<pre>brew tap gcenx/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.
 
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>
+
<pre>brew install gcenx/wine/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.'''
 
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>
+
<pre>brew update ; brew -v install gcenx/wine/game-porting-toolkit</pre>
 +
 
 +
=== Ensure the toolkit is already on latest version ===
 +
 
 +
Ensure you're in an x86_64 shell to continue the following steps in a Rosetta environment. All subsequent commands should be run within this shell, re-run if you're unsure if you're in correct shell or just doing an update.
 +
<pre>arch -x86_64 zsh</pre>
 +
 
 +
Run Homebrew to gather potential updates and upgrade Apple's GPTK formula:
 +
 
 +
<pre>brew update && brew upgrade apple/apple/game-porting-toolkit</pre>
 +
 
 +
This step depending on specs may take around 48 minutes on M1 to 19 minutes on M2 Max.
 +
 
 +
If you're using Gcenx's premade formula to update prebuild GPTK fomula:
 +
 
 +
<pre>brew update && brew upgrade gcenx/wine/game-porting-toolkit</pre>
 +
 
 +
Remember using Gcenx's prebuild just saves you from building it from source, you need to follow next steps mentioned in this guide below or Apple's README.rtf included with Apple's GPTK DMG, which in case of drastic changes made by Apple will be always right, Wiki has some pros of all community tips and fixes bundled together but it takes a while to be up to date.
 +
 
 +
Doesn't matter if you built GPTK from Apple or using Gcenx's prebuild, if you're updating from previous release, make sure to repeat <code>[[#Preparing the toolkit]]</code> section below.
 +
 
 +
=== 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/redist/lib/ `brew --prefix game-porting-toolkit`/lib/</pre>
 +
 
 +
If for some reason you are installing a previous version of Game Porting Toolkit, refer to the Read Me.rtf file on that disk image for the correct command to copy the D3DMetal libraries.
 +
 
 +
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>
  
 
===Wine prefix ===
 
===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.
+
A Wine prefix contains a virtual C: drive, similar to a Bottle in [[CrossOver]]. 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. This will create a Wine prefix called <code>my-game-prefix</code> but could be renamed to anything.
<pre>WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 winecfg</pre>
+
<pre>WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 winecfg</pre>
 
*A “Wine configuration” window should appear on your screen.
 
*A “Wine configuration” window should appear on your screen.
 
*Change the version of Windows to Windows 10.
 
*Change the version of Windows to Windows 10.
Line 69: Line 149:
 
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.
 
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 ===
+
Now you are ready to install a launcher or individual Windows games into this Wine prefix, see below.
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>
+
== Commands ==
 +
 
 +
The dmg ships with three scripts starting with <code>gameportingtoolkit</code> to simplify the use of GPTk.
 +
;A. Standard launching
 +
:<pre>gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.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.
 +
:This is exactly the same as <code>MTL_HUD_ENABLED=1 WINEESYNC=1 WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 'C:\Program Files (x86)\Steam\steam.exe'</code>.
 +
;B. Launching without a HUD
 +
:<pre>gameportingtoolkit-no-hud ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'</pre>
 +
:This is like the above, but without <code>MTL_HUD_ENABLED=1</code>.
 +
;C. Launching with Wine ESYNC disabled
 +
:<pre>gameportingtoolkit-no-esync ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'</pre>
 +
:This is again like the basic one, except without <code>WINEESYNC=1</code>. ESYNC is good for performance, but may occasionally suffer from compatibility issues.
 +
 
 +
To run Winecfg:
 +
<pre>gameportingtoolkit ~/my-game-prefix winecfg</pre>
 +
 
 +
Installing individual exe games is as simple as running the installer using any of the commands above. If it does not require installation, just open your Wine prefix’s virtual C: drive in Finder (<code>open ~/my-game-prefix/drive_c</code>) and copy your game into an appropriate subdirectory.
 +
 
 +
=== Replacement ===
 +
A defect of <code>gameportingtoolkit</code> is that it only takes two arguments: the prefix and the exe path. This disallows passing any extra argument (e.g. a <code>-dx11</code> or <code> -debug_mode</code> flag) to your exe; going back to the real ''wine64'' program removes this restriction. A custom shell function can be used to simplify the wine64 call:
 +
<pre>
 +
wine-gptk(){ WINEESYNC=1 WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 "$@"; }
 +
</pre>
  
Put the 3 scripts from the Game Porting Toolkit DMG into here <code>/usr/local/bin</code> using this command:
+
The above function can be written to <code>~/.zshrc</code> so it stays loaded in the shell. <code>wine-gptk 'C:\Program Files (x86)\Steam\steam.exe'</code> would be functionally the same as example B. The difference is that you can pass arguments like <code>wine-gptk notepad 1.txt</code> or <code>wine-gptk imperator.exe -debug_mode</code>.
<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.
+
(The issue does not prevent gaming platforms like Steam from launching games with the required flags. It only prevents you from passing flags to the exe you are directly opening.)
  
== Steam ==
+
== Installing gaming platforms==
 +
=== Steam ===
 
Download the [https://cdn.cloudflare.steamstatic.com/client/installer/SteamSetup.exe Windows version of Steam] and place in your Downloads folder.
 
Download the [https://cdn.cloudflare.steamstatic.com/client/installer/SteamSetup.exe Windows version of Steam] and place in your Downloads folder.
  
Line 85: Line 188:
  
 
'''Run Steam'''
 
'''Run Steam'''
<pre>gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)/Steam/steam.exe'</pre>
+
<pre>gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'</pre>
  
 
'''Log into Steam'''
 
'''Log into Steam'''
  
A common issue is that Steam will present with a blank black window.
+
A common issue is that Steam will present with a blank black window. Try the [[#Steam login black screen]] section.
 
 
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 ==
+
=== Battle.net ===
Download the [https://download.battle.net/en-gb/?platform=windows Windows version of Battle.net].
+
Download the [https://download.battle.net/en-gb/?platform=windows Windows version of Battle.net] and place in your Downloads folder.
  
Make a new Wineprefix for Battle.net - we will refer to this as battle-net from now:
+
Make a new Wineprefix for Battle.net, you can choose to use <code>my-game-prefix</code> or change this to anything else.
<pre>WINEPREFIX=~/battle-net `brew --prefix game-porting-toolkit`/bin/wine64 winecfg</pre>
+
<pre>WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 winecfg</pre>
 
*A “Wine configuration” window should appear on your screen.
 
*A “Wine configuration” window should appear on your screen.
 
*Change the version of Windows to <code>Windows 10</code>.
 
*Change the version of Windows to <code>Windows 10</code>.
 
*Choose Apply and then OK to exit winecfg.
 
*Choose Apply and then OK to exit winecfg.
 +
 +
If you are running Diablo IV, then you need to run this script to update the Wineprefix to appear as a more recent version of Windows:
 +
<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>
  
 
'''Run Battle.net launcher'''
 
'''Run Battle.net launcher'''
<pre>gameportingtoolkit ~/battle-net ~/Downloads/Battle.net-Setup.exe</pre>
+
<pre>gameportingtoolkit ~/my-game-prefix ~/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.  
 
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:
 
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>
+
<pre>arch -x86_64 gameportingtoolkit-no-hud ~/my-game-prefix 'C:\Program Files (x86)\Diablo IV\Diablo IV Launcher.exe'</pre>
  
== Epic and GOG.com support ==
+
=== Epic / GOG.com / Amazon Prime Gaming support with the Heroic Games Launcher ===
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.
+
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 / GOG / Amazon Prime games.
  
* Install the [https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/releases native macOS Heroic Games Launcher] or from Homebrew.
+
# Install the [https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/releases native macOS Heroic Games Launcher] or from Homebrew [Requires 2.9.0 and/or newer]:
* Open Heroic, and log into your Epic Games and/or GOG.com account.
+
#* Ensure you're using ARM zsh:<pre>arch -arm64e zsh</pre>
* 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.
+
#* Install Heroic's cask:<pre>brew install --cask heroic</pre>
** At the time of writing this, the newest numbered version of Wine-Crossover is <code>Wine-Crossover-Wine-22.1.0</code>
+
#Go to <code>Settings</code> > <code>Game Defaults</code> > Make sure GPTK is selected as preferred method.
* Press the folder icon that appears after installing it to open the directory containing Heroic's Wine installations.
+
#Check <code>ESYNC</code> and <code>Show Stats Overlay</code> eventually you can use environment variables explained above.
* Right-click on the version of Wine you just installed and press "Show Package Contents".
+
#Make sure your Game Porting Toolkit Wine Prefix is selected. If you followed Apple's guide this is <code>/Users/$USER/my-game-prefix</code>.
* Open this directory in the Terminal.
+
#If you open <code>Settings</code> > <code>Other</code> section you can also enable <code>ESYNC</code> and <code>Metal HUD</code> by add any environment variables you want like <code>WINEESYNC=1</code> and <code>MTL_HUD_ENABLED=1</code>. Removing them or setting to <code>0</code> will disable them.
** If you have "OpenInTerminal" this is one button, otherwise press "Show Path Bar" and navigate where it says with "cd".
+
#Install and test desired game.
** 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 (x86)\Steam\steam.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 (x86)\Steam\steam.exe'</pre>
 
 
 
'''C. Launching with Wine ESYNC disabled'''
 
<pre>gameportingtoolkit-no-esync ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'</pre>
 
 
 
To enter Winecfg:
 
<pre>gameportingtoolkit ~/my-game-prefix winecfg</pre>
 
  
 
== Shortcut ==
 
== Shortcut ==
 +
{{Image|Game Porting Toolkit Steam icon.png|Icon made by user Omsier.|150px}}
 
You can make a shortcut for Steam for example by using macOS built-in Automator app.
 
You can make a shortcut for Steam for example by using macOS built-in Automator app.
 
*Open Automator.
 
*Open Automator.
Line 172: Line 242:
 
export PATH="/usr/local/bin:${PATH}"
 
export PATH="/usr/local/bin:${PATH}"
  
arch -x86_64 gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'
+
arch -x86_64 gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe' > /dev/null 2>&1 &
 
</pre>
 
</pre>
 
*Save the shortcut somewhere e.g. Applications.
 
*Save the shortcut somewhere e.g. Applications.
Line 184: Line 254:
  
 
== Troubleshooting ==
 
== Troubleshooting ==
 +
=== Steam login black screen ===
 
{{Image|GPTK Steam black screen.png|Steam login black screen issue.}}
 
{{Image|GPTK Steam black screen.png|Steam login black screen issue.}}
'''Steam login black screen'''
 
  
 +
{{Fixbox|description=Alternate Steam launch command|ref=|fix=
 
Close the Terminal window and then reopen and retry the command, repeat several times.
 
Close the Terminal window and then reopen and retry the command, repeat several times.
  
 +
<!-- Isn't this the same as the one above in "Steam"? -->
 
Alternate way of launching Steam (after installing):
 
Alternate way of launching Steam (after installing):
 
<pre>
 
<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'
+
MTL_HUD_ENABLED=1 WINEESYNC=1 WINEPREFIX=~/my-game-prefix /usr/local/Cellar/game-porting-toolkit/1.0.4/bin/wine64 'C:\Program Files (x86)/Steam/steam.exe'
 
</pre>
 
</pre>
  
If still not working then try using [[CrossOver]] and create a Steam bottle, then redirect this WINEPREFIX to that bottle:
+
If still not working then try using [[CrossOver]] and create a Steam bottle, then login, then redirect this WINEPREFIX to that bottle:
 
<pre>
 
<pre>
WINEPREFIX="/Users/[username]/Library/Application Support/CrossOver/Bottles/Steam/"  
+
WINEPREFIX="/Users/$USER/Library/Application Support/CrossOver/Bottles/Steam/" /usr/local/Cellar/game-porting-toolkit/1.0.4/bin/wine64 'C:\Program Files (x86)/Steam/steam.exe'
 
</pre>
 
</pre>
 +
}}
  
'''Steam crashes straight after opening'''
+
{{Fixbox|description=Use macOS Steam login|ref=<ref>https://github.com/IsaacMarovitz/Whisky/issues/41#issuecomment-1585640483</ref>|fix=
 +
#Login to Steam macOS.
 +
#From <code>/Users/$USER/Library/Application Support/Steam</code>, copy three files/folders: config, registry.vdf, userdata.
 +
#Paste into <code>~/my-game-prefix/drive_c/Program Files (x86)/Steam/</code>
  
Disconnect any external monitors.
+
Alternatively, login to Steam macOS and paste this into terminal:
 +
<pre>
 +
cp -R $HOME/Library/Application\ Support/Steam/{config,registry.vdf,userdata} "$HOME/my-game-prefix/drive_c/Program Files (x86)/Steam/"
 +
</pre>
 +
}}
 +
=== Battle.net login black screen ===
 +
 
 +
try Whisky install.</br>
 +
open the Whisky -> Battle.net bottle volume -> Bottle Configuration -> DXVK-DXVK enable</br>
 +
After restarting Battle.net, you'll still have to wait no more than 10 minutes, during which time the screen will remain black until the icons load.
  
'''Battle.net launcher won't re-launch'''
+
=== Steam crashes straight after opening ===
 +
{{Fixbox|description=Disconnect external monitors|ref=<ref>Reference</ref>|fix=
 +
Disconnect any external monitors, or alternatively stop mirroring the screen.
 +
}}
  
 +
=== Battle.net launcher won't re-launch ===
 
Re-install the launcher to reopen, no other fix at the moment.
 
Re-install the launcher to reopen, no other fix at the moment.
  
 +
===Windows version too old===
 +
{{Fixbox|description=Windows version too old|ref=<ref>Reference</ref>|fix=
 
'''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.
 
'''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>
 
<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 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/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
+
WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wineserver -k
 
</pre>
 
</pre>
 +
}}
  
'''steamwebhelper.exe crashes'''
+
=== steamwebhelper.exe crashes ===
 +
This is caused by Steam being run through macOS Ventura or below, most users should upgrade to macOS Sonoma. You can use the CrossOver workaround to login to Steam but you'll experience constant crashing.
  
This is caused by Steam being run through macOS Ventura or below, upgrade to macOS Sonoma.
+
=== Nothing loads after a crash ===
 +
Try closing all Wine threads:
 +
<pre>killall -9 wineserver && killall -9 wine64-preloader</pre>
  
'''My game won't run and crashes with an invalid instruction'''
+
=== Anti-cheat and DRM ===
 +
Anti-cheat (e.g. Easy Anti Cheat) and DRM (e.g. Denuvo) are long known to be incompatible with wine, because they hook into undocumented nooks and crannies in the Windows system.  Some games have workarounds e.g. Elden Ring. For other games, you need to wait until the DRM is removed by the game's developer.
  
AVX and AVX2 games are not supported by Apple's arm64 chipset.
+
=== My game won’t run because it requires Mono, .NET, or the MSVCRT runtime ===
 +
For the example of VC Redistributable, download the x64 version here: https://aka.ms/vs/17/release/vc_redist.x64.exe
  
'''My game won't run because its anti-cheat or DRM software is incompatible with Wine translation.'''
+
<pre>
 
+
WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 vc_redist.x64.exe
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.
+
</pre>
  
'''My game won’t run because it requires Mono, .NET, or the MSVCRT runtime.'''
+
Generic commands:
  
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>
 
<pre>
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 <some-installer.exe>
+
WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 <some-installer.exe>
 
</pre>
 
</pre>
  
 
And .MSI packages can be installed by launching the Windows uninstaller application and choosing to install a downloaded .msi package:
 
And .MSI packages can be installed by launching the Windows uninstaller application and choosing to install a downloaded .msi package:
 
<pre>
 
<pre>
WINEPREFIX=~/my-game-prefix `brew --prefix game-porting-toolkit`/bin/wine64 uninstaller
+
WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 uninstaller
 
</pre>
 
</pre>
  
'''Controller issues'''
+
===My game won’t boot anymore even though I made no changes.===
 +
 
 +
If the game stopped booting without being updated, you can try clearing the D3DMetal shader cache.
 +
Run the following commands:
  
 +
cd $(getconf DARWIN_USER_CACHE_DIR)/d3dm
 +
cd ''GAME_NAME''
 +
rm -r shaders.cache
 +
 +
Do you have a different problem or other feedback?
 +
 +
Please let us know through https://feedbackassistant.apple.com.
 +
 +
=== Controller issues ===
 +
{{Fixbox|description=Steam beta|ref=<ref>Reference</ref>|fix=
 
Issues may be fixed by enrolling into the Steam beta.
 
Issues may be fixed by enrolling into the Steam beta.
 +
}}
 +
{{Fixbox|description=Steam Big Picture Mode Controller Settings|ref=<ref>Fix EVERY controller issue on M1 Mac! video on YT by Andrew Tsai (bylk5VRlJPE) </ref>|fix=
 +
Right click on the game -> Properties -> Controller -> Override for "Game Name" -> Disable Steam Input
 +
}}
 +
{{Fixbox|description=Preventing Launchpad from opening when pressing home|fix=
 +
This is useful especially when using Steam's Big Picture mode.<br>
 +
Paste this command in terminal :<br>
 +
<pre>defaults write com.apple.GameController bluetoothPrefsMenuLongPressAction -integer 0</pre>
 +
Disabling share button (Optional) :<br>
 +
<pre>defaults write com.apple.GameController bluetoothPrefsShareLongPressSystemGestureMode -integer -1</pre>
 +
}}
  
'''My game looks pixelated and the display resolution is limited'''
+
=== My game looks pixelated and the display resolution is limited ===
 
+
{{Fixbox|description=Enable Retina mode|ref=|fix=
 
Enable Retina (high resolution) mode:
 
Enable Retina (high resolution) mode:
 
<pre>
 
<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
+
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>
 
</pre>
 
Some games will not run with Retina mode enabled. To disable it:
 
Some games will not run with Retina mode enabled. To disable it:
 
<pre>
 
<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
+
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>
 
</pre>
 +
}}
 +
 +
===AVX===
 +
AVX and AVX2 games are not supported by Rosetta on Apple Silicon (arm64) on macOS prior to Sequoia. Such games include:
 +
 +
* [[Samurai Showdown]],
 +
* [[Death Stranding]],
 +
* [[Assassin's Creed: Odyssey]],
 +
* [[Yakuza Remastered Collection]],
 +
* [[Yakuza: Like A Dragon]],
 +
* [[Saints Row: The Third Remastered]],
 +
* [[Left Alive]] (Requires FMA),
 +
* [[Dying Light 2]],
 +
* [[Madden NFL 22]],
 +
* [[Lost Judgment]],
 +
* [[WWE 2K22]],
 +
* [[Ratchet & Clank: Rift Apart]],
 +
* [[Sonic Frontiers]],
 +
* [[Starfield]]
 +
* [[Red Dead Redemption 2]]
 +
* [[NBA2K 24]]
 +
 +
List may contain games with Mac port available or with already known AVX bypass fixes. Feel free to update this section just like in Dying Light 2's case.
 +
 +
AVX requirement can be bypassed in some games, e.g Dying Light 2.
 +
 +
{{Fixbox|description=AVX Fix for Dying Light 2|ref=<ref>Reference</ref>|fix=
 +
There is a workaround in Dying Light 2 which is to simply remove/rename the "runtime_dx11.dll"
 +
 +
#Right click on DL2 on steam
 +
#Manage
 +
#Local files
 +
#Navigate to "ph\work\bin\x64"
 +
#Rename "runtime_dx11.dll" to "runtime_dx11.dll.bak"
 +
#Start the game
 +
 +
If for some reason you need the "runtime_dx11.dll" back, just remove the ".bak" or verify game files integrity in steam
 +
}}
 +
 +
'''Important Update:'''
 +
 +
Apple Game Porting Toolkit 2 -released on June, 2024- promised AXV2 instruction set support [https://developer.apple.com/games/game-porting-toolkit/ Refer to Apple's GPTK documentation here], it seems that AVX and AVX2 instruction set are supported
 +
on macOS 15.0 and later, so, running AVX games are at least theoretically possible on M1 macs by upgrading to macOS 15.0 (or downloading its beta/developer beta).
  
 
== Game compatibility list ==
 
== Game compatibility list ==
 +
{{ii}} '''Total number of games: '''{{#cargo_query:tables=Compatibility_macOS|fields=COUNT(*)|group by=_pageNamespace|where=Compatibility_macOS.wine='perfect' OR Compatibility_macOS.wine='playable' OR Compatibility_macOS.wine='runs' OR Compatibility_macOS.wine='menu'}}
 +
{{mm}} ''This list was last refreshed on '''{{CURRENTMONTHNAME}} {{CURRENTDAY}},  {{CURRENTYEAR}}'''. [{{fullurl:{{FULLPAGENAMEE}}|action=purge}} Purge] the page to refresh it.''
 +
 +
''
 +
Note: this list is querying '''any''' Wine compatibility, not specifically GPTK. Compatibility status on this table does not necessarily represent GPTK compatibility.
 +
''
 +
 +
{{#cargo_query:
 +
tables=Compatibility_macOS
 +
|fields=Compatibility_macOS._pageName, Compatibility_macOS.wine
 +
|where=Compatibility_macOS.wine='perfect' OR Compatibility_macOS.wine='playable' OR Compatibility_macOS.wine='runs'
 +
|limit=500
 +
|offset=0
 +
|format=template
 +
|intro={{ListOfGames/intro}}
 +
|template=ListOfGames/row
 +
|outro=</table></div>
 +
}}
 +
 +
{{#cargo_query:
 +
tables=Compatibility_macOS
 +
|fields=Compatibility_macOS._pageName, Compatibility_macOS.wine
 +
|where= Compatibility_macOS.wine='unplayable' OR Compatibility_macOS.wine='menu'
 +
|limit=500
 +
|offset=0
 +
|format=template
 +
|intro={{ListOfGames/intro}}
 +
|template=ListOfGames/row
 +
|outro=</table></div>
 +
}}
 +
 +
Old list - this should be made into individual wiki articles in order to populate the automated list above, which tracks all game compatibility methods using Wine.
 +
 
Working games:
 
Working games:
* Bloodstained: Ritual of the Night
+
* [[AnimA: Reign of Darkness]]
* Control (DX12 mode, if downloaded from Heroic, needs to be ran by Terminal)
+
* [[Astroneer]]
* Crysis Remastered
+
* [[Assassins Creed 3 Remastered]]
* Cuphead
+
* [[Atomic Heart]]
* Cyberpunk 2077
+
* [[ARK: Survival Evolved]] - (~50 fps on low settings)
* Deep Rock Galactic
+
* [[Batman: Arkham Knight]] - launches with steam no-esync or crash
* Deceive Inc. - works well if launched without EAC
+
* [[BeamNG.drive]] - Disable ESync. Grass textures have blue artifacts on default maps. Download external maps to fix grass.
* Derail Valley (awesome performance, no missing manuals - in-game objects for train operation - like on CrossOver)
+
* [[Borderlands 3]]
* Diablo IV [https://www.reddit.com/r/macgaming/comments/14307be/comment/jn7dxzo/?utm_source=reddit&utm_medium=web2x&context=3 ]
+
* [[Blood: Fresh Supply]]
* Dyson Sphere Program (some objects and main character weren't visible before)
+
* [[Bloodstained: Ritual of the Night]]
* Elden Ring
+
* [[Brick Rigs]]
* Final Fantasy VII Remake Intergrade (~50 FPS on High settings at 1080p with M1 Pro)
+
* [[Bright Lights of Svetlov]]
* God of War (Works somewhat well on M1 Pro (16gb), wouldn't recommend lesser hardware.)
+
* [[Genshin Impact]] 3.7 (m2max with 4k 60fps stable)
* Going Medieval
+
* [[Chasm: The Rift]] (It works but you can't change any video options as it will crash. You have to manually edit the config file.)
* Guilty Gear Strive
+
* [[Choo Choo Charles]] - (40-50fps on base M1)
* Halo 3 (MCC - No Online due to Easy Anti-Cheat Compatibility) [https://www.reddit.com/r/macgaming/comments/143zoos/halo_3_mcc_no_online_eac_m1_pro_game_porting/]
+
* [[Control]] (DX12 mode, if downloaded from Heroic, needs to be ran by Terminal)
* HI-Fi RUSH
+
* [[Crime Scene Cleaner]]
* Hogwarts Legacy
+
* [[Crysis Remastered]]
* 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)
+
* [[Cultic]]
* Kena: Bridge of Spirits
+
* [[Cuphead]] - (~90fps on M2 Pro 12CPU/19GPU)
* Metal Gear Solid V: The Phantom Pain
+
* [[Cyberpunk 2077]]
* Overwatch 2
+
* [[Days Gone]]
* QUBE 2
+
* [[Dead Space Remake]]
* Risk of Rain 2 (does not require `-disable-gpu-skinning` like Crossover 22)
+
* [[Deep Rock Galactic]]
* Scarlet Nexus
+
* [[Deceive Inc.]] - works well if launched without EAC
* Sonic Omens
+
* [[Derail Valley]] (awesome performance, no missing manuals - in-game objects for train operation - like on CrossOver)
* Sonic P-06
+
* [[Diablo IV]] [https://www.reddit.com/r/macgaming/comments/14307be/comment/jn7dxzo/?utm_source=reddit&utm_medium=web2x&context=3 ]
* Spider-Man (2018)
+
* [[DJMAX Respect V]] - Playable via Steam with Whiskey, which includes GPTK; BGAs do not appear during gameplay or in-menu; menu is currently a black screen so changing modes isn't feasible but Freestyle/default loads fine when hitting enter to get to song selection, which works as expected; no crashes on video setting changes (fullscreen <> windowed, different resolutions); recommend unlimiting framerate (vsync causes some visual stuttering but doesn't affect input or create lag; tested on M1 Pro, 16GB
* Spider-Man Miles Morales - ''requires Windows ver fix''
+
* [[Dread Templar]]
* SpongeBob SquarePants: The Cosmic Shake
+
* [[Duke Nukem 3D HRP (eduke32)]]
* StarCraft: Remastered - Game runs fine but opening Option menu the second time will cause game not recognizing any inputs.
+
* [[Dying Light 2]] (needs AVX fix above)
* Tetris Effect: Connected - Game window likes to be uncooperative; really doesn't like retina mode, works otherwise
+
* [[Dyson Sphere Program]] (some objects and main character weren't visible before)
* Warframe - ''To get installer/launcher working add dwrite (disabled) to library overrides in winecfg''
+
* [[Elden Ring]]
 +
* [[Evil Nun: The Broken Mask]]
 +
* [[Final Fantasy VII Remake Intergrade]] (~50 FPS on High settings at 1080p with M1 Pro)
 +
* [[Five Nights At Freddy's Security Breach]]
 +
* [[Friends vs. Friends]]
 +
* [[Gloomwood]]
 +
* [[God of War]] (Works somewhat well on M1 Pro (16gb), wouldn't recommend lesser hardware.)
 +
* [[Going Medieval]]
 +
* [[Guilty Gear Strive]]
 +
* [[Grand Theft Auto V]]
 +
* [[Green Hell]]
 +
* [[Halo 3]] (MCC - No Online due to Easy Anti-Cheat Compatibility) [https://www.reddit.com/r/macgaming/comments/143zoos/halo_3_mcc_no_online_eac_m1_pro_game_porting/]
 +
* [[Halo Reach]] (MCC)
 +
* [[Hard Reset Redux]]
 +
* [[Hatsune Miku: Project DIVA Mega Mix+]] - works with Retina mode; [https://github.com/blueskythlikesclouds/DivaModLoader/releases DivaModLoader] and [https://github.com/Still34/azura-diva/releases DivaNoSpy] recommended; run Steam with WINEDEBUG=-all WINEESYNC=0 WINEDLLOVERRIDES="dinput8.dll=n,b"; may randomly crash at the title screen: use [https://github.com/nastys/IntroPatch/releases IntroPatch] as a workaround
 +
* [[HI-Fi RUSH]]
 +
* [[Hitman 3]] - works well with Crossover 24-GPTK-2-macOS Sequoia
 +
* [[Hogwarts Legacy]] - launches fine first time but then won't relaunch - can be fixed by deleting ~/my-game-prefix/drive_c/ProgramData/Hogwarts Legacy - these are the files that are created at first launch that prevent relaunching
 +
* [[Horizon zero dawn]] - works very well
 +
* [[Infinity Racer XD]]
 +
* [[Jected - Rivals]]
 +
* [[Kena: Bridge of Spirits]]
 +
* [[Metal Gear Solid V: The Phantom Pain]]
 +
* [[Naruto Shippuden: Ultimate Ninja Storm 4]]
 +
* [[Need for Speed Heat]]
 +
* [[Only Up!]] - (Macbook Air 13,M1,16GB,7GPU) Playable through Steam at 1440x900, lowest settings, vsync off, resolution scale: 25-30%, fps lock: 30. Gives 30 fps with drops to 25 when loading map. Without lock, with other apps closed could give 30-60fps with lowest settings. The higher the hero climbs, the more memory used. At highest point I could climb to memory usage was about 11.5GB.
 +
* [[Outer Wilds]] (through steam)
 +
* [[Overwatch 2]]
 +
* [[QUBE 2]]
 +
* [[Party Animals]]
 +
* [[Payday3]]
 +
* [[People Playground]]
 +
* [[Poppy Playtime Chapter 1]]
 +
* [[Poppy Playtime Chapter 2]]
 +
* [[PowerSlave Exhumed]]
 +
* [[Prodeus]]
 +
* [[Project Warlock]]
 +
* [[Prey]] - Fixed the black textures with gptk beta version 1.03. Run with Heroic
 +
* [[Ready or Not]]
 +
* [[Return To Castle Wolfenstein (RealRTCW 4.0.12)]]
 +
* [[Resident Evil 2 (2019)]] – works fine if you switch to the DX11 version in Steam settings
 +
* [[Resident Evil 3 (2020)]] – works fine if you switch to the DX11 version in Steam settings
 +
* [[Rise of The Triad: Ludicrous Edition]]
 +
* [[Risk of Rain 2]] (does not require `-disable-gpu-skinning` like Crossover 22)
 +
* [[Rivals of Aether]]
 +
* [[Scarlet Nexus]]
 +
* [[Sonic GT]]
 +
* [[Sonic illusions]]
 +
* [[Sonic Omens]]
 +
* [[Sonic Project '06]]
 +
* [[Spider-Man Miles Morales]] - ''requires Windows ver fix''
 +
* [[SpongeBob SquarePants: The Cosmic Shake]]
 +
* [[StarCraft: Remastered]]
 +
* [[Tetris Effect: Connected]] - Game window likes to be uncooperative; really doesn't like retina mode, works otherwise
 +
* [[The Mortuary Assistant]]
 +
* [[This Bed We Made]]
 +
* [[Tiny Tina Wonderlands]]
 +
* [[Turbo Overkill]]
 +
* [[Turok 2: Seeds of Evil (Remastered)]]
 +
* [[Ultimate Fishing Simulator]]
 +
* [[V Rising]]
 +
* [[Viewfinder]] - Macbook air m1 8gb 60fps most of the time at max settings 1680x1050 resolution
 +
* [[Warframe]] - ''To get installer/launcher working add dwrite (disabled) to library overrides in winecfg''
 +
* [[WRATH: Aeon of Ruin]]
 +
* [[Vampyr]] - 25-30fps on Ultra settings, tested on M1 MBA (DX11 game!)
 +
* [[Tell Me Why]] - On maxed out settings, runs around 35-45fps on base M1 MBA (DX11 game!)
 +
* [[It Takes Two]] - Semi-frequent stuttering, but runs well and isn't an issue for such a casual game.
  
 
Not working well:
 
Not working well:
* Horizon Zero Dawn - slowdown issues
+
* [[Genshin Impact]] - Launches, but stuck when calling menu using esc
 +
* [[CarX Drift Racing Online]] - Game freezes after launch.
 +
* [[Fallout 4]] - Game starts and runs well on m1 Pro at high settings, very smooth movement (wasd) but mouse is not picked up correctly. Looking around is not really a thing. Mouse works fine in menu
 +
* [[FallGuys through Heroic]] - Game and anticheat launch, but game only shows black screen for a few seconds then crashes. Cursor gets changed to custom cursor
  
 
Not working yet:
 
Not working yet:
* Among Us
+
*[[Street Fight 6 Demo]] (it will show black screen because of D3Dmetal error)
* Company of Heroes 3
+
* [[Apex Legends]] (it will stuck because of anti-cheat)
* F1 22 - Crash on launch (  "Exception": "C0000005 EXCEPTION_ACCESS_VIOLATION at 0000000141bd8687")
+
* Any games that use the EA Launcher
* Halo Infinite - Crash on launch
+
** [[Need for Speed Unbound]]
* Hitman 3 - launcher works, crash at 0x0000014136dddd hitman3+0x136dddd: int $3
+
** [[Tom Clancy's The Division 2]]
* Microsoft Flight Simulator 2020 (Steam) - Crash on launch
+
* [[Among Us]]
* Monster Hunter Rise - DX12 Game, it launches but window goes dark after compiling shaders.
+
* [[Assassins Creed Odyssey]]
* Monster Hunter World - Black Screen on Launch
+
* [[Assassins Creed Valhalla]]
* Red Dead Redemption 2
+
* [[Assetto Corsa]] - Stuck on "Installing DirectX Runtime" and when it passes, it says running but then just stops
* Rogue Company - anti-cheat conflict.
+
* [[Company of Heroes 3]]
* Sea of Thieves - Launches, but the prompt to sign into an xbox live account appears blank and cannot
+
* [[Death Stranding]]
* Many (all?) DX9 games
+
* [[Doom (2016)]] - "FATAL ERROR: wglCreateContextAttribsARB failed" message on launch
** 30XX - "Failed to create D3D device" -> crash on launch; this is a rare 64-bit DX9 game
+
* [[Kerbal Space Program 2]] - Loads into Main Menu but crashes on a step when loading into KSC and crashes with no reports
** Killing Floor 1 - Crash on launch
+
* [[F1 20]] - Crash on launch (DX11 Version Works)
** Left 4 Dead 2 - Black screen -> crash on launch
+
* [[F1 21]] - Crash on launch
** Mega Man Zero/ZX Legacy Collection - "Failed to create d3d9 device" -> crash on launch
+
* [[F1 22]] - Crash on launch (  "Exception": "C0000005 EXCEPTION_ACCESS_VIOLATION at 0000000141bd8687")
** Sonic Mania - Crash on launch
+
* [[Grand Theft Auto IV]] - Rockstar games launcher crashes on launch, cracked version should work fine
** StarCraft II -> "Failed to initialize DirectX" error
+
* [[Halo Infinite]] - Crash on launch
** Battlefield 2 - DirectX installation failed, won't launch, see the [https://gist.github.com/chrismwendt/1d01a306cdc8618a06bdfb555743e25c error log]
+
* [[Horizon Forbidden West]] - F16C instructions requirement
 +
* [[Microsoft Flight Simulator 2020]] (Steam) - Crash on launch
 +
* [[Monster Hunter Rise]] - DX12 Game, it launches but window goes dark after compiling shaders.
 +
* [[Monster Hunter World]] - Black Screen on Launch
 +
* [[New World]] - Game loaded but couldn't connect to server due to Easy Anti Cheat
 +
* [[Payday 2]]
 +
* [[Red Dead Redemption 2]]
 +
* [[Resident Evil]] (HD remaster, 2015) – crashes right after CAPCOM screen
 +
* [[Resident Evil 5]] – crashes right after launching
 +
* [[Rogue Company]] - anti-cheat conflict.
 +
* [[s&box]] - crashes right on launch. (it should be DX11)
 +
* [[Sea of Thieves]] - Launches, but the prompt to sign into an xbox live account appears blank and cannot
 +
* [[Saints Row IV: Re-Elected]] - Launches, but crashes when trying to load into game
 +
* [[Slime Rancher 2]] - Launches, but can't into game from main menu
 +
* [[Sonic Frontiers]] - AVX Requirement
 +
* [[SpongeBob Squarepants: Battle for Bikini Bottom Rehydrated]] - Crashes when loading
 +
* [[Teardown]] - When trying to launch, gives a error, "The program teardown.exe has encountered a serious problem and needs to close. We are sorry for the inconvenience."
 +
* [[The Elder Scrolls V: Skyrim Special Edition]] - the launcher gives a "The program skyrimselauncher.exe has encountered a serious problem" message, not allowing us to get into the game
 +
* [[theHunter: Call of the Wild]] - Crash on launch (Unhandled exception: page fault on read access to 0x0000000000000000 in 64-bit code (0x00000140b227f8))
 +
* [[The Joy of Creation: Story Mode]] - Crash on launch
 +
* [[Uncharted: Legacy of Thieves Collection]] - Requires AVX
 +
* All DX9 games (as this toolkit supports DX11 & DX12 only)
 +
** [[30XX]] - "Failed to create D3D device" -> crash on launch; this is a rare 64-bit DX9 game
 +
** [[Battleblock Theater]] - Black screen -> crash on launch
 +
** [[Black Mesa]] - Starts to load to main menu at first but then crashes
 +
** [[Castle Crashers]] - Black screen -> crash on launch
 +
** [[Killing Floor 1]] - Crash on launch
 +
** [[Left 4 Dead 2]] - Black screen -> crash on launch
 +
** [[Lego Batman: The Videogame]] - Black screen -> crash on launch
 +
** [[Lego Batman 2: DC Super Heros]] - Black screen -> crash on launch
 +
** [[Lego Batman 3: Beyond Gotham]] - Black screen -> crash on launch (You can switch to DX11 but are currently unable to do so since the game will not launch)
 +
** [[Mega Man Zero/ZX Legacy Collection]] - "Failed to create d3d9 device" -> crash on launch
 +
** [[Sonic Mania]] - Crash on launch
 +
** [[Space Engineers]] - Gets to first loading screen then crashes
 +
** [[StarCraft II]] -> "Failed to initialize DirectX" error
 +
** [[Star Wars: The Old Republic]]
 +
** [[Battlefield 2]] - DirectX installation failed, won't launch, see the [https://gist.github.com/chrismwendt/1d01a306cdc8618a06bdfb555743e25c error log]
 +
 
  
  
 
{{References}}
 
{{References}}
 +
[[Category:Lists]]

Latest revision as of 16:40, 27 September 2024

Released 6th June, 2023 at WWDC23.
Released 6th June, 2023 at WWDC23.

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 11 and 12[1]. This is a 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. A lot more games work using GPTK, however, games that use anti-cheat or aggressive DRMs generally don't work.

Games that require AVX/AVX 2, e.g. The Last of Us Part I, would need either an

  • Intel based Mac
  • or a version of Rosetta that is capable of translating AVX/AVX 2 instructions to M1 instructions, which is present on macOS Sequoia.

Toolkit install instructions

Requirements

  • macOS Sequoia should be used, if you want to run a game that has AVX/AVX 2 instructions.
  • macOS Sonoma should be used. You can download the pkg installer from 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 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, and run the contained pkg file.
      • If you have an old version Xcode installed, remove it.
    • Search for Game Porting Toolkit and download it. Open/mount the dmg file (some commands will require that it is mounted).

Automated Installer

  • A new open source installer which automates the steps found in the Homebrew approach below is now available from InstallAware's GitHub Repo. Scroll down where they have a screenshot of their graphical user interface, and download the DMG from the link right above that.
  • The automated installer is notarized by Apple, so has no known malware and runs as soon as you've double-clicked it without any Gatekeeper concerns.
  • Neither macOS Sonoma nor an Apple Silicon device are required by the automated installer.
  • You also won't need to download the Game Porting Toolkit DMG from Apple, although if available, it will be utilized (you just point the installer to the DMG download, and it takes care of the rest). Of course, in this scenario, you would still need macOS Sonoma and an Apple Silicon device to enjoy 3D acceleration benefits.
  • The automated installer also doubles up as a GUI to launch existing installed apps, all visually without ever having to drop down to the command line.

Macports

Macports option ADVANCED USERS ONLY

(Optional)

if you want install under Macports here is the guide change directory into /opt

 cd /opt

clone the repository for macports-wine

 sudo git clone https://github.com/Gcenx/macports-wine

follow this guide to configure the local repository then sync https://guide.macports.org/#development.local-repositories

 sudo port sync 

you are ready to install first install game-porting-toolkit-d3dmetal , it will fail at first , follow the steps it gives you which tells you where to put the game porting toolkit dmg

 sudo port install game-porting-toolkit-d3dmetal

next you install the porting toolkit itself and you should be good to move onto the Wine Prefix section in this guide, keep in mind it might fail the first time or two , but it might just need a retry; if it still doesn't work after a couple tries please report issues to https://github.com/Gcenx/macports-wine/issues

 sudo port install game-porting-toolkit

Keep in mind instead of brew --prefix you will need to replace it with the wine from macports path, /opt/local/libexec/game-porting-toolkit/bin/wine64 ; and gameportingtoolkit itself should be in path and if not its under /opt/local/bin/gameportingtoolkit

Homebrew

Note: if you have ever installed Homebrew before, then it is advised to remove ARM64 Homebrew as this can interfere with this build process. Either use a Homebrew uninstall script or delete the folder /opt/homebrew/bin. If you prefer to keep both ARM64 and x86 versions of brew installed, you may add a "brew-switcher" to your .zshrc 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:

softwareupdate --install-rosetta

Enter an x86_64 shell to continue the following steps in a Rosetta environment. All subsequent commands should be run within this shell.

arch -x86_64 zsh

Install the x86_64 version of Homebrew if you don't already have it.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Set the path:

(echo; echo 'eval "$(/usr/local/bin/brew shellenv)"') >> ~/.zprofile
eval "$(/usr/local/bin/brew shellenv)"

Make sure the brew command is on your path:

which brew

If this command does not print /usr/local/bin/brew, you should use this command:

export PATH=/usr/local/bin:${PATH}
Optionally retain both ARM64 and x86 versions of Brew

(Optional) If you want to have both ARM64 and x86 versions of Brew installed, begin by editing your .zshrc file:

nano ~/.zshrc

Scroll down (by using the arrow keys or Control + V) to the bottom of the file, and paste the following script:

if [ "$(arch)" = "arm64" ]; then
    eval "$(/opt/homebrew/bin/brew shellenv)"
else
    eval "$(/usr/local/bin/brew shellenv)"
fi

You may now restart your terminal and use the following command to return to an x86_64 shell:

arch -x86_64 zsh

Your shell will now select the right installation of Brew, depending on your architecture.

(For bash holdovers: zsh instructions above also apply to bash. Just replace .zshrc with .bashrc and .zprofile with .bash_profile.)

Build

Run this command to download Apple tap:

brew tap apple/apple http://github.com/apple/homebrew-apple

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. This step depending on specs may take around 75 minutes on M1 to 36 minutes on M2 Max.

brew install apple/apple/game-porting-toolkit

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.

brew update ; brew install apple/apple/game-porting-toolkit

Prebuild

To save time you can use prebuild GPTK formula maintained by Gcenx.

brew tap gcenx/homebrew-apple

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.

brew install gcenx/wine/game-porting-toolkit

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.

brew update ; brew -v install gcenx/wine/game-porting-toolkit

Ensure the toolkit is already on latest version

Ensure you're in an x86_64 shell to continue the following steps in a Rosetta environment. All subsequent commands should be run within this shell, re-run if you're unsure if you're in correct shell or just doing an update.

arch -x86_64 zsh

Run Homebrew to gather potential updates and upgrade Apple's GPTK formula:

brew update && brew upgrade apple/apple/game-porting-toolkit

This step depending on specs may take around 48 minutes on M1 to 19 minutes on M2 Max.

If you're using Gcenx's premade formula to update prebuild GPTK fomula:

brew update && brew upgrade gcenx/wine/game-porting-toolkit

Remember using Gcenx's prebuild just saves you from building it from source, you need to follow next steps mentioned in this guide below or Apple's README.rtf included with Apple's GPTK DMG, which in case of drastic changes made by Apple will be always right, Wiki has some pros of all community tips and fixes bundled together but it takes a while to be up to date.

Doesn't matter if you built GPTK from Apple or using Gcenx's prebuild, if you're updating from previous release, make sure to repeat #Preparing the toolkit section below.

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.

ditto /Volumes/Game\ Porting\ Toolkit-1.0/redist/lib/ `brew --prefix game-porting-toolkit`/lib/

If for some reason you are installing a previous version of Game Porting Toolkit, refer to the Read Me.rtf file on that disk image for the correct command to copy the D3DMetal libraries.

Put the 3 scripts from the Game Porting Toolkit DMG into here /usr/local/bin using this command:

cp /Volumes/Game\ Porting\ Toolkit*/gameportingtoolkit* /usr/local/bin

Wine prefix

A Wine prefix contains a virtual C: drive, similar to a Bottle in CrossOver. 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. This will create a Wine prefix called my-game-prefix but could be renamed to anything.

WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 winecfg
  • 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.

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

Commands

The dmg ships with three scripts starting with gameportingtoolkit to simplify the use of GPTk.

A. Standard launching
gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'
This launches the given Windows game binary with a visible extended Metal Performance HUD and filters logging to output from the Game Porting Toolkit.
This is exactly the same as MTL_HUD_ENABLED=1 WINEESYNC=1 WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 'C:\Program Files (x86)\Steam\steam.exe'.
B. Launching without a HUD
gameportingtoolkit-no-hud ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'
This is like the above, but without MTL_HUD_ENABLED=1.
C. Launching with Wine ESYNC disabled
gameportingtoolkit-no-esync ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe'
This is again like the basic one, except without WINEESYNC=1. ESYNC is good for performance, but may occasionally suffer from compatibility issues.

To run Winecfg:

gameportingtoolkit ~/my-game-prefix winecfg

Installing individual exe games is as simple as running the installer using any of the commands above. If it does not require installation, just open your Wine prefix’s virtual C: drive in Finder (open ~/my-game-prefix/drive_c) and copy your game into an appropriate subdirectory.

Replacement

A defect of gameportingtoolkit is that it only takes two arguments: the prefix and the exe path. This disallows passing any extra argument (e.g. a -dx11 or -debug_mode flag) to your exe; going back to the real wine64 program removes this restriction. A custom shell function can be used to simplify the wine64 call:

wine-gptk(){ WINEESYNC=1 WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 "$@"; }

The above function can be written to ~/.zshrc so it stays loaded in the shell. wine-gptk 'C:\Program Files (x86)\Steam\steam.exe' would be functionally the same as example B. The difference is that you can pass arguments like wine-gptk notepad 1.txt or wine-gptk imperator.exe -debug_mode.

(The issue does not prevent gaming platforms like Steam from launching games with the required flags. It only prevents you from passing flags to the exe you are directly opening.)

Installing gaming platforms

Steam

Download the Windows version of Steam and place in your Downloads folder.

Install Steam

gameportingtoolkit ~/my-game-prefix ~/Downloads/SteamSetup.exe

Run Steam

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

Log into Steam

A common issue is that Steam will present with a blank black window. Try the #Steam login black screen section.

Battle.net

Download the Windows version of Battle.net and place in your Downloads folder.

Make a new Wineprefix for Battle.net, you can choose to use my-game-prefix or change this to anything else.

WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 winecfg
  • 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 you are running Diablo IV, then you need to run this script to update the Wineprefix to appear as a more recent version of Windows:

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

Run Battle.net launcher

gameportingtoolkit ~/my-game-prefix ~/Downloads/Battle.net-Setup.exe

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:

arch -x86_64 gameportingtoolkit-no-hud ~/my-game-prefix 'C:\Program Files (x86)\Diablo IV\Diablo IV Launcher.exe'

Epic / GOG.com / Amazon Prime Gaming support with the Heroic Games Launcher

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 / GOG / Amazon Prime games.

  1. Install the native macOS Heroic Games Launcher or from Homebrew [Requires 2.9.0 and/or newer]:
    • Ensure you're using ARM zsh:
      arch -arm64e zsh
    • Install Heroic's cask:
      brew install --cask heroic
  2. Go to Settings > Game Defaults > Make sure GPTK is selected as preferred method.
  3. Check ESYNC and Show Stats Overlay eventually you can use environment variables explained above.
  4. Make sure your Game Porting Toolkit Wine Prefix is selected. If you followed Apple's guide this is /Users/$USER/my-game-prefix.
  5. If you open Settings > Other section you can also enable ESYNC and Metal HUD by add any environment variables you want like WINEESYNC=1 and MTL_HUD_ENABLED=1. Removing them or setting to 0 will disable them.
  6. Install and test desired game.

Shortcut

Icon made by user Omsier.
Icon made by user Omsier.

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:
#!/bin/zsh

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

arch -x86_64 gameportingtoolkit ~/my-game-prefix 'C:\Program Files (x86)\Steam\steam.exe' > /dev/null 2>&1 &
  • 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 Command+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

Steam login black screen issue.
Steam login black screen issue.
Alternate Steam launch command

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

Alternate way of launching Steam (after installing):

MTL_HUD_ENABLED=1 WINEESYNC=1 WINEPREFIX=~/my-game-prefix /usr/local/Cellar/game-porting-toolkit/1.0.4/bin/wine64 'C:\Program Files (x86)/Steam/steam.exe'

If still not working then try using CrossOver and create a Steam bottle, then login, then redirect this WINEPREFIX to that bottle:

WINEPREFIX="/Users/$USER/Library/Application Support/CrossOver/Bottles/Steam/" /usr/local/Cellar/game-porting-toolkit/1.0.4/bin/wine64 'C:\Program Files (x86)/Steam/steam.exe'
Use macOS Steam login[2]
  1. Login to Steam macOS.
  2. From /Users/$USER/Library/Application Support/Steam, copy three files/folders: config, registry.vdf, userdata.
  3. Paste into ~/my-game-prefix/drive_c/Program Files (x86)/Steam/

Alternatively, login to Steam macOS and paste this into terminal:

cp -R $HOME/Library/Application\ Support/Steam/{config,registry.vdf,userdata} "$HOME/my-game-prefix/drive_c/Program Files (x86)/Steam/"

Battle.net login black screen

try Whisky install.
open the Whisky -> Battle.net bottle volume -> Bottle Configuration -> DXVK-DXVK enable
After restarting Battle.net, you'll still have to wait no more than 10 minutes, during which time the screen will remain black until the icons load.

Steam crashes straight after opening

Disconnect external monitors[3]

Disconnect any external monitors, or alternatively stop mirroring the screen.

Battle.net launcher won't re-launch

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

Windows version too old

Windows version too old[4]

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.

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

steamwebhelper.exe crashes

This is caused by Steam being run through macOS Ventura or below, most users should upgrade to macOS Sonoma. You can use the CrossOver workaround to login to Steam but you'll experience constant crashing.

Nothing loads after a crash

Try closing all Wine threads:

killall -9 wineserver && killall -9 wine64-preloader

Anti-cheat and DRM

Anti-cheat (e.g. Easy Anti Cheat) and DRM (e.g. Denuvo) are long known to be incompatible with wine, because they hook into undocumented nooks and crannies in the Windows system. Some games have workarounds e.g. Elden Ring. For other games, you need to wait until the DRM is removed by the game's developer.

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

For the example of VC Redistributable, download the x64 version here: https://aka.ms/vs/17/release/vc_redist.x64.exe

WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 vc_redist.x64.exe

Generic commands:

WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 <some-installer.exe>

And .MSI packages can be installed by launching the Windows uninstaller application and choosing to install a downloaded .msi package:

WINEPREFIX=~/my-game-prefix $(brew --prefix game-porting-toolkit)/bin/wine64 uninstaller

My game won’t boot anymore even though I made no changes.

If the game stopped booting without being updated, you can try clearing the D3DMetal shader cache. Run the following commands:

cd $(getconf DARWIN_USER_CACHE_DIR)/d3dm
cd GAME_NAME
rm -r shaders.cache

Do you have a different problem or other feedback?

Please let us know through https://feedbackassistant.apple.com.

Controller issues

Steam beta[5]

Issues may be fixed by enrolling into the Steam beta.

Steam Big Picture Mode Controller Settings[6]

Right click on the game -> Properties -> Controller -> Override for "Game Name" -> Disable Steam Input

Preventing Launchpad from opening when pressing home

This is useful especially when using Steam's Big Picture mode.
Paste this command in terminal :

defaults write com.apple.GameController bluetoothPrefsMenuLongPressAction -integer 0

Disabling share button (Optional) :

defaults write com.apple.GameController bluetoothPrefsShareLongPressSystemGestureMode -integer -1

My game looks pixelated and the display resolution is limited

Enable Retina mode

Enable Retina (high resolution) mode:

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

Some games will not run with Retina mode enabled. To disable it:

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

AVX

AVX and AVX2 games are not supported by Rosetta on Apple Silicon (arm64) on macOS prior to Sequoia. Such games include:

List may contain games with Mac port available or with already known AVX bypass fixes. Feel free to update this section just like in Dying Light 2's case.

AVX requirement can be bypassed in some games, e.g Dying Light 2.

AVX Fix for Dying Light 2[7]

There is a workaround in Dying Light 2 which is to simply remove/rename the "runtime_dx11.dll"

  1. Right click on DL2 on steam
  2. Manage
  3. Local files
  4. Navigate to "ph\work\bin\x64"
  5. Rename "runtime_dx11.dll" to "runtime_dx11.dll.bak"
  6. Start the game

If for some reason you need the "runtime_dx11.dll" back, just remove the ".bak" or verify game files integrity in steam

Important Update:

Apple Game Porting Toolkit 2 -released on June, 2024- promised AXV2 instruction set support Refer to Apple's GPTK documentation here, it seems that AVX and AVX2 instruction set are supported on macOS 15.0 and later, so, running AVX games are at least theoretically possible on M1 macs by upgrading to macOS 15.0 (or downloading its beta/developer beta).

Game compatibility list

Total number of games: 188
This list was last refreshed on November 21, 2024. Purge the page to refresh it.

Note: this list is querying any Wine compatibility, not specifically GPTK. Compatibility status on this table does not necessarily represent GPTK compatibility.


Game Rating
7 Days to Die Perfect
Age of Empires II: Definitive Edition Playable
Age of Empires II: HD Edition Playable
Age of Mythology: Extended Edition Perfect
Age of Wonders 4 Runs
Aliens: Fireteam Elite Perfect
Among Us Playable
Annie and the Art Gallery Perfect
Astroneer Perfect
Batman Arkham Knight Perfect
Battlefield 3 Playable
Battlefield 5 Playable
BeamNG.drive Runs
BioShock Infinite Runs
Boson X Perfect
Bright Lights of Svetlov Playable
Brotato Perfect
Capcom Fighting Collection Perfect
Cities: Skylines II Playable
Clustertruck Perfect
Codename: Loop Perfect
Cogmind Perfect
Control Perfect
Counter-Strike 2 Perfect
Crime Scene Cleaner Perfect
Cult Of The Lamb Perfect
Cuphead Perfect
Cyberpunk 2077 Perfect
Dark Souls Remastered Perfect
Days Gone Playable
Dead Space Perfect
Deadlock Perfect
Definitely Not Fried Chicken Perfect
Deus Ex Runs
Diablo II Perfect
Diablo IV Perfect
Disco Elysium Perfect
Dishonored Playable
DRAFTYCAR Runs
DREDGE Perfect
Dying Light Perfect
Elden Ring Perfect
Elite: Dangerous Playable
EVE Online Perfect
Everspace 2 Perfect
F1 2020 Perfect
Fallout 4 Playable
Fallout Shelter Perfect
Fallout: New Vegas Playable
Farthest Frontier Playable
Final Fantasy VII Remake Intergrade Perfect
Final Fantasy XIV Perfect
Final Fantasy XV Perfect
Firewatch Perfect
Floating Point Perfect
Freeways Perfect
Genshin Impact Perfect
Geometry Dash Perfect
Ghost of Tsushima Director's Cut Perfect
Ghostrunner Playable
God of War Playable
Grand Theft Auto V Perfect
Grim Dawn Perfect
GTFO Playable
Guild Wars 2 Perfect
Guilty Gear Strive Perfect
Gunfire Reborn Perfect
Half-Life 2 Perfect
Halo 3 Playable
Halo: Reach Perfect
Hatsune Miku: Project DIVA Mega Mix+ Perfect
Hellblade: Senua's Sacrifice Playable
Heroes of Might and Magic III Perfect
High On Life Perfect
Hitman 3 Playable
Hogwarts Legacy Perfect
Horizon zero dawn Perfect
Hot Wheels Unleashed Perfect
Hotline Miami Playable
House flipper 2 Perfect
It Takes Two Playable
Jazz Jackrabbit 2 Perfect
Jected - Rivals Playable
Journey Perfect
Killer7 Perfect
Kingdom Come: Deliverance Playable
L.A. Noire Runs
Left 4 Dead 2 Playable
Lego Star Wars: The Skywalker Saga Perfect
Lethal Company Perfect
Magicite Perfect
Manor Lords Perfect
Marvel’s Spider-Man Remastered Playable
Mass Effect Legendary Edition Perfect
Mass Effect: Andromeda Playable
Master of Olympus: Zeus Gold (AKA: Zeus + Poseidon) Playable
Max Payne Runs
Metal Gear Solid V: The Phantom Pain Playable
METALLIC CHILD Perfect
Metro 2033 Redux Perfect
Muck Perfect
My Hero Ultra Rumble Perfect
NASCAR Heat 5 Runs
Necromunda: Hired Gun Playable
NieR: Automata Perfect
Noita Perfect
One piece odessey Perfect
Osu! Perfect
Outer Wilds Playable
Paladins Perfect
Palia Perfect
Palworld Perfect
Parkasaurus Perfect
Party animals Perfect
Path of Exile Perfect
Pathologic 2 Runs
Penumbra Overture Playable
Persona 3 Reload Perfect
Persona 5 Tactica Perfect
Planet of Lana Perfect
PlateUp! Perfect
Portal Playable
Portal 2 Playable
Potion Craft: Alchemist Simulator Perfect
PowerWash Simulator Perfect
Project Zomboid Perfect
Raft Perfect
Ready or Not Perfect
Remnant: From the Ashes Perfect
Resident Evil 2 (2019) Playable
Resident Evil 3 (2020) Playable
Risk of Rain 2 Perfect
Risk of Rain Returns Playable
Rocket League Playable
ROUNDS Perfect
S.T.A.L.K.E.R.: Shadow of Chernobyl Perfect
Sable Perfect
Satisfactory Playable
Scarlet Nexus Playable
Sekiro: Shadows Die Twice Playable
Slime Rancher Perfect
Slime Rancher 2 Perfect
Soul Calibur 6 Playable
Spore Playable
Spyro Reignited Trilogy Playable
Star Trek Online Playable
Star Wars Episode I: Racer Playable
Star Wars Jedi: Fallen Order Perfect
Super Hexagon Playable
System Shock: Enhanced Edition Perfect
Team Fortress 2 Perfect
Teardown Playable
Tell Me Why Perfect
Tetris Effect: Connected Playable
The Elder Scrolls IV: Oblivion Runs
The Elder Scrolls V: Skyrim Special Edition Perfect
The Escapists 2 Perfect
The Evil Within Perfect
The Evil Within 2 Perfect
The Forest Perfect
The Karters 2: Turbo Charged Perfect
The Sims 4 Perfect
The Stanley Parable: Ultra Deluxe Playable
The Witcher Playable
The Witcher 3 Playable
This Bed We Made Perfect
Thumper Perfect
Tomb Raider I-III Remastered Perfect
Torchlight II Runs
Train Simulator 2021 Perfect
Ultimate Fishing Simulator Perfect
Valheim Playable
Vampyr Playable
Warhammer 40,000: Boltgun Playable
Wattam Runs
Wreckfest Playable
XIII Perfect
Yakuza 0 Perfect
Yu-Gi-Oh! Duel Links Perfect


Game Rating
Age Of Mythology: Retold Unplayable
Animal Well Unplayable
Atomic Heart Unplayable
Batman: Arkham Asylum Menu
Batman: Arkham Origins Unplayable
Battle Brothers Unplayable
Borderlands 2 Unplayable
Civilization VI Unplayable
Code Vein Unplayable
Death Stranding Unplayable
Deathloop Unplayable
Deus Ex: Human Revolution - Director's Cut Unplayable
Doom (2016) Unplayable
Doom Eternal Unplayable
F1 22 Unplayable
Fall Guys: Ultimate Knockout Unplayable
FIFA 22 Menu
Final Fantasy XVI Unplayable
Fortnite Unplayable
Ghostwire tokyo Menu
Goose Goose Duck Unplayable
Grand Theft Auto IV Unplayable
Just Cause 3 Unplayable
Just Cause 4 Menu
Mafia III Unplayable
Mafia: Definitive Edition Unplayable
Maplestory Unplayable
Middle-earth: Shadow of Mordor Unplayable
Minecraft: Dungeons Unplayable
Mount and Blade II: Bannerlord Unplayable
NASCAR 21: Ignition Menu
Ori and the Blind Forest: Definitive Edition Unplayable
Overwatch 2 Unplayable
Persona 4 Golden Unplayable
Persona 5 Unplayable
Polygon Unplayable
Railway Empire Unplayable
Red Dead Redemption 2 Unplayable
Resident Evil Unplayable
Resident Evil 5 Unplayable
Resident Evil 7 Unplayable
Resident Evil Revelations 2 Unplayable
Resident Evil Village Unplayable
RFactor 2 Unplayable
SCP Secret Laboratory Unplayable
Shadow Tactics: Blades of the Shogun Menu
Shadowrun Returns Unplayable
Sniper elite 4 Unplayable
Sniper: Ghost Warrior Contracts Menu
Sniper: Ghost Warrior Contracts 2 Menu
Sonic Frontiers Unplayable
Sonic Origins Unplayable
Space engine Unplayable
Space Engineers Menu
Star Wars: Empire at War Unplayable
Terraria Unplayable
The Last of Us Unplayable
Titanfall 2 Unplayable
Tom Clancy's Rainbow Six Siege Unplayable
Trackmania (2020) Unplayable


Old list - this should be made into individual wiki articles in order to populate the automated list above, which tracks all game compatibility methods using Wine.

Working games:

Not working well:

  • Genshin Impact - Launches, but stuck when calling menu using esc
  • CarX Drift Racing Online - Game freezes after launch.
  • Fallout 4 - Game starts and runs well on m1 Pro at high settings, very smooth movement (wasd) but mouse is not picked up correctly. Looking around is not really a thing. Mouse works fine in menu
  • FallGuys through Heroic - Game and anticheat launch, but game only shows black screen for a few seconds then crashes. Cursor gets changed to custom cursor

Not working yet:


References

  1. Gokhan Avkarogullari: "@yiningkarlli @aras @romainguy…" - Gamedev Mastodon - last accessed on {{{date}}}
  2. https://github.com/IsaacMarovitz/Whisky/issues/41#issuecomment-1585640483
  3. Reference
  4. Reference
  5. Reference
  6. Fix EVERY controller issue on M1 Mac! video on YT by Andrew Tsai (bylk5VRlJPE)
  7. Reference