[Note: I have created a Wineskin package that fixes many of the issues listed here. You can find it here: https://osu.ppy.sh/community/forums/topics/682197]
[Note: I have created a troubleshooting tool that automatically fixes some of these issues. You can find it here: https://osu.ppy.sh/community/forums/topics/1036678]
Over the course of playing osu! on OSX I've experienced multiple issues and found ways to fix them.
This is assuming you are using the Wineskin wrapper to run osu! on OSX.
osu! folder can be found by going to Show package contents > drive_c > osu!
Next you'll need to update the Wine engine. I highly recommend you do this regardless of whether you are facing issues or not. The engine included with the osu! Wineskin is incredibly outdated (In software development, 2 - 3 years is a very long time). The engine is essentially what runs osu! so this is one of the more volatile steps. Updating the engine provided me with a significant performance boost, fixed many of the issues I was having previously, and it allowed my game to run under OSX driver mode (more on that later).
To update the engine we'll need a way to download engines. Download Wineskin Winery: http://wineskin.urgesoftware.com/tiki-index.php?page=Downloads
Now open Wineskin Winery and follow these steps:
For some reason WineskinX11 (the XQuartz included with Wineskin) won't start osu! properly. You'll notice this if you get an error "Invalid Drawable" in the logs. The way that this has been fixed is to install XQuartz on your system and use this XQuartz instead of the default. I have a better alternative:
After that follow the rest of the steps in Before you do anything but when clicking “Change Engine Used” select the engine that you wish to use.
Example:
Before: 153776 yuikonnu & ayaponzu* - Super Nuko World.osz
After: 153776 yuikonnu ayaponzu - Super Nuko World.osz
Unfortunately I don't know why this happens but it's a simple fix:
See the section: Discord Rich Presence doesn't work!
If you haven't already make sure to do a data backup. The steps to do this are listed under How to do a data backup
This is due to Wine using a function similar to a "Game Mode" but has the side effect of blacking out everything except the game. For the technical folk out there you can read up on it here: https://developer.apple.com/library/content/documentation/GraphicsImaging/Conceptual/QuartzDisplayServicesConceptual/Articles/DisplayCapture.html
Here's how to fix it:
Communication between processes is different in different operating systems. Discord on macOS expects to receive information from a macOS game. Discord on osu! expects to send information to a Discord on a Windows machine. You'll need to replace the discord-rpc.dll file to allow communication properly (Thanks to slc for pointing out this alternative file):
If that doesn't work press F9 (to show osu! users) and then press ESC.
pissed significantly miffed that I couldn't read a mapping tutorial on my second monitor when osu! was open.
[Note: I have created a troubleshooting tool that automatically fixes some of these issues. You can find it here: https://osu.ppy.sh/community/forums/topics/1036678]
Over the course of playing osu! on OSX I've experienced multiple issues and found ways to fix them.
This is assuming you are using the Wineskin wrapper to run osu! on OSX.
Miscellaneous Information
Wineskin can be found right clicking the osu! icon and clicking "Show package contents".osu! folder can be found by going to Show package contents > drive_c > osu!
Before you do anything
I highly recommend you back up the entire osu! folder. Some of these steps initially made my game crash or stuck in an update loop. In the event that happens you may have to start from scratch and redownload the Wineskin wrapper from the OSX osu! tumblr (found here: http://osuosx.tumblr.com)Before you fix anything
If you haven't already, start by updating the Wineskin wrapper. The wrapper is rather outdated and probably won't fix anything but it can't really hurt. To update the wrapper:Steps
The wrapper version (shown near the bottom of the window above "Install Software") should now be 2.6.2 or higher. Don't close the Wineskin window yet; we'll use it later.- Open (double click) on Wineskin
- Click "Advanced"
- Click "Tools" (next to Configuration and Options)
- Click "Update Wrapper" (in the right column)
Next you'll need to update the Wine engine. I highly recommend you do this regardless of whether you are facing issues or not. The engine included with the osu! Wineskin is incredibly outdated (In software development, 2 - 3 years is a very long time). The engine is essentially what runs osu! so this is one of the more volatile steps. Updating the engine provided me with a significant performance boost, fixed many of the issues I was having previously, and it allowed my game to run under OSX driver mode (more on that later).
To update the engine we'll need a way to download engines. Download Wineskin Winery: http://wineskin.urgesoftware.com/tiki-index.php?page=Downloads
Now open Wineskin Winery and follow these steps:
Steps
Now that the latest engine is installed we'll need to change the engine used in the Wineskin wrapper. Go back to Wineskin and follow these steps:- Click the refresh button below the list of "Installed Engines"
- Click the plus button below the list of "Installed Engines"
- The "Add Engine" window should now appear. The default selected option should be the latest engine available. At the time of writing WS9Wine2.22 is the latest
- Click "Download and Install"
- Click "OK"
Steps
Now you can go onto the other steps!- Click "Change Engine Used"
- The default selected option should be the engine you just installed
- Click OK to change the engine
Help! My game won't open and/or opens this program called XQuartz!
You must update the wine engine for this to work properly.For some reason WineskinX11 (the XQuartz included with Wineskin) won't start osu! properly. You'll notice this if you get an error "Invalid Drawable" in the logs. The way that this has been fixed is to install XQuartz on your system and use this XQuartz instead of the default. I have a better alternative:
Steps
Now if you start osu! you will hopefully notice less input lag and frame drops. At least that's what happened for me. Additionally, you won't need to wait for XQuartz to start up anymore.- Click "Set Screen Options" (Under the "Tools" tab in Wineskin)
- Click "Use Mac Driver instead of X11"
- Click "Done"
- Click "Options" (near the top of the Wineskin window next to "Tools")
- Uncheck "Force use of system installed XQuartz instead of using built in WineskinX11"
Reverting to an older Wine version
See Before you do anything on downloading Wineskin Winery. When clicking “Add Engine” be sure to select the Wine version that you wish to install. Then click “Download and Install”.After that follow the rest of the steps in Before you do anything but when clicking “Change Engine Used” select the engine that you wish to use.
Help! My game won't start after updating to High Sierra!
High Sierra interferes with a few of Wineskin's startup processes. Here's how to fix it:Steps
- Click "Set Screen Options" (Under the "Tools" tab in Wineskin)
- Uncheck "Auto Detect GPU Info for Direct3D"
- Uncheck "Use Direct3D Boost (if available)"
- Click "Done"
osu! runs really slow and/or the Song Setup window does not show
If your computer is rather old or you're running macOS Mojave you may experience problems with various elements of the Wineskin including performance or UI elements. In this case, you may wish to reenable XQuartz as the graphical engine for the Wineskin. Follow the steps for Help! My game won't open and/or opens this program called XQuartz! but in reverse. Consider this as a last resort if nothing else works. You will also need to download and install XQuartz (https://www.xquartz.org).osu! or Wineskin will not open!
Sometimes, the quarantine attribute will still be stuck on the Wineskin wrapper. The quarantine attribute will prevent osu! from writing files and performing all the actions that it needs to. Here is how to disable the quarantine attribute.Steps
Thanks to Bedrock for the command- Move the osu! application to the Desktop
- Open the Terminal application
- Type in cd Desktop and press enter
- Type in sudo xattr -dr com.apple.quarantine 'osu!.app' (osu!.app must be in single quotes) and press enter
- Type in your password. The password you type will not show up on screen but it will be registered. Press enter after you are done.
- Try running osu!
Help! osu! is stuck loading a beatmap!
For unknown reasons, osu! on OSX does not handle large image files. Delete the background image of the beatmap (or rename it) to fix this.Notable beatmaps that have this issue
- 568455 fhana - Outside of Melancholy ~Yuuutsu no Mukougawa~
- 707380 ClariS - SHIORI vs Hitorigoto [no video]
A beatmap just won't import!
Make sure the .osz file doesn't have any strange characters in the filename. Rename the .osz file and remove any non alphanumeric characters (dashes should be fine).Example:
Before: 153776 yuikonnu & ayaponzu* - Super Nuko World.osz
After: 153776 yuikonnu ayaponzu - Super Nuko World.osz
The updater keeps downloading discord-rpc.dll!
Steps
- Download a copy of the working discord-rpc.dll here: https://drive.google.com/file/d/1x17jM9fnbyfbGM9vY6H54UXWECSILwlY/view?usp=sharing
- Move the file into your osu! folder
See the section: Discord Rich Presence doesn't work!
osu! crashes after a key is pressed!
Keyboard layouts other than the default US layout may not work with osu!. This is especially true for keyboard layouts that produce a character other than those part of the ASCII format, such as Japanese, Chinese or Korean. Set your keyboard layout to the US layout to fix this.There isn't a menu bar in edit mode!
The menu bar is still there, just that it's completely black. You'll notice a strip of black on top of "compose design timing song setup". Click on that strip and then the menus will display.Oh no! I'm stuck in an update loop and/or I'm crashing on startup!
Unfortunately for you, there aren't a concrete set of steps to resolve this. However, there are several things you can try but at worst you'll have to reinstall the Wineskin package.If you haven't already make sure to do a data backup. The steps to do this are listed under How to do a data backup
discord-rpc.dll keeps downloading
See The updater keeps downloading discord-rpc.dll!
Restore a backup
If this problem occurred after following one of the steps in this entire guide then you can restore to a working state by pasting the contents of your backup (which you should have made before starting this guide!) into the osu! folder.
Update your wine engine
Newer versions of wine have several bug fixes and features that may make osu! work properly again. If have not already done so follow the steps in Before you fix anything
Check your release stream
Newer release streams may not be able to be run on Wine. You may have gotten a newer release stream if you clicked "Force Update" in your osu! options. This can also happen for other reasons. Here's how to revert your release stream:
- Open osu!.cfg in the osu! folder with a text editor
- On the first line after "_ReleaseStream = " change the value to "Stable40"
- The line should now read: "_ReleaseStream = Stable40"
- Save the file and exit
- Now delete all files ending in a .dll extension
Reinstalling the Wineskin package
You must do a data backup before doing this option.
If all else fails you'll have to start from scratch:
If all else fails you'll have to start from scratch:
- Delete the entire osu! application (Make sure you have done a data backup)
- Download the latest wrapper from http://osuosx.tumblr.com
- Follow the steps for Before you fix anything before running osu!
- Copy the entirety of your data backup into the osu! folder
- (If you are running High Sierra) See Help! My game won't start after updating to High Sierra!
How to do a data backup
This backup saves all of your osu! data such as scores, replays and songs. You may want to do this if you are crashing on startup or stuck in an update loop.Steps
- Create a folder to store all the copied osu! data
- Open your osu! folder
- Select all files (CMD + A) and then copy them over to your folder
- In your new folder delete all .dll files
- Delete osu!.exe
- Delete osu!.cfg
- Check that you have folders: Data, Downloads, Logs, Screenshots (if you took one), Skins, Songs
- Check you have files: collection.db, osu!.db, osu!.(name).cfg, presence.db, scores.db
How to restore a data backup
Steps
If you are experiencing issues you may wish to delete osu!.(name).cfg as well. (Note: This will reset your in game settings and you will be required to login again)- Make sure osu! is closed
- Select all the files (CMD + A) in your data backup folder
- Copy the selection (CMD + C)
- Paste the files (CMD + V) directly into your osu! folder
Updating the osu! executable
At times, the executable provided in a wrapper may be outdated and won’t update for some reason. In this case, you’ll need to update the executable manually:Steps
- Make sure osu! is closed
- Download the latest osu!install.exe from https://osu.ppy.sh/p/download
- Rename the osu!install.exe to osu!.exe
- Open the osu! folder
- Copy osu!.exe into the folder, replacing the existing osu!.exe
Help! I'm running a dual monitor setup and osu! blacks out my other screen!
This will only work if you have enabled "Use Mac Driver".This is due to Wine using a function similar to a "Game Mode" but has the side effect of blacking out everything except the game. For the technical folk out there you can read up on it here: https://developer.apple.com/library/content/documentation/GraphicsImaging/Conceptual/QuartzDisplayServicesConceptual/Articles/DisplayCapture.html
Here's how to fix it:
Steps
- Click "Registry Editor" (Under the "Tools" tab in Wineskin in the left column)
- Go to this registry folder: HKEY_CURRENT_USER > Software > Wine > Mac Driver
- Double click on "CaptureDisplaysForFullscreen"
- Change "Y" to "n" in the text box
- Click "OK"
- Close the "Registry Editor" window
Help! Clicking on a different window automatically minimises osu!
Admittedly I have no idea why it does this but there is a simple fix:Steps
- Open your osu! options (In the actual game)
- Scroll to "Graphics" options
- Uncheck "Fullscreen mode" (Under the subheading "Layout")
There's noticeable audio latency
This is especially prevalent if you have programs like Boom or Boom2 installed. Boom post processes your audio which increases the quality but also increases the audio latency. You can fix this without quitting Boom.Steps
Now audio will be routed directly to your audio device instead of through Boom.- Click "Config Utility" (in the left column under the "Tools" tab in Wineskin)
- Click on the "Audio" tab
- Change "Output Device" to your headset/headphones or speaker.
- Click "Apply" and then "Ok"
Discord Rich Presence doesn't work!
See the section Discord Rich Presence under my Wineskin thread: community/forums/topics/1106057.Communication between processes is different in different operating systems. Discord on macOS expects to receive information from a macOS game. Discord on osu! expects to send information to a Discord on a Windows machine. You'll need to replace the discord-rpc.dll file to allow communication properly (Thanks to slc for pointing out this alternative file):
Steps
- Download xnu-discord-rpc.dll from this guy here: https://github.com/goeo-/discord-rpc/releases (If you have a Github account consider starring the fork)
- Navigate to the osu! folder (Right click osu! > Show Package Contents > drive_c > osu!)
- Delete the existing discord-rpc.dll file
- Drag the xnu-discord-rpc.dll file into it and rename it to discord-rpc.dll
The game lags when I select a Beatmap and I can't change Visual Settings at the bottom
Follow the steps for Help! My game won't open and/or opens this program called XQuartz!The mouse cursor is showing on top of the osu! cursor
Follow the steps for Help! I'm running a dual monitor setup and osu! blacks out my other screen!.If that doesn't work press F9 (to show osu! users) and then press ESC.