/osu-wine-install-script

An osu! wine installer! Meant to be as Linux-beginner friendly as possible.

Primary LanguageShellGNU General Public License v3.0GPL-3.0

osu-wine-install-script

A complete re-write of my old distro-agnostic osu! wine installer (now on branch old).

It:

  • Installs osu!
  • Installs the wine-discord-ipc-bridge
  • Installs ThePoon's patched wine with a pre-compiled wine binary
  • Generates a launch script to launch osu! with all of these patches
  • Creates a desktop file to launch osu! with the generated launch script
  • Automatically enables audio compatibility in osu! upon installation.
  • Does not require root privileges. The only things that require root are manual system configurations noted in the installation instructions below.

If you run into any problems with this, please open an issue!

Requirements

  • winetricks
  • Install the dependencies listed here. These dependencies are used for gaming on Linux through wine in general, so they're nice to have anyway.

Instructions

  1. git clone https://github.com/mrniceguy127/osu-wine-install-script.git && cd osu-wine-install-script
  2. ./install-osu Let osu! launch and close on its own. When osu launches to the main menu, close it. Even if it happens multiple times (extremely rare).
  3. Follow the instructions under "Adjusting latency" here.
  4. IMPORTANT!!! - Edit the script at ~/.local/bin/osu-wine to adjust latency settings. You should set these values (see comments in file) as low as you can where osu!'s audio is still stable. These values vary by machine. If you don't do this, you will end up with severe audio instability or more latency than you could be getting. See ThePoon's blog post on this.
  5. Launch osu. You can either type osu-wine in a new terminal, or if you like GUI's, you can just search "osu" in whatever application launcher you might have. Use the command osu-kill to force kill osu!.

Sources

  • Pre-compiled wine binary with ThePoon's patch applied. You can find this on his discord server in one of the pinned messages. - Link
  • Official osu! branding icon - Link
  • wine-discord-ipc-bridge - Link
  • Official osu! installer - Link

File listing

  • WINEPREFIX: ~/.local/share/osu-wine/WINE.win32
  • osu! game files folder: ~/.local/share/osu-wine/osu
  • ThePoon's patched wine: ~/.local/share/osu-wine/wine-osu
  • wine-discord-ipc-bridge: ~/.local/share/osu-wine/wine-discord-ipc-bridge
  • osu! folder shortcut: ~/osu
  • osu! launch script: ~/.local/bin/osu-wine
  • osu! kill script: ~/.local/bin/osu-kill
  • osu! desktop file: ~/.local/share/applications/osu!.desktop
  • osu! logo file: ~/.local/share/icons/osulogo.png

Troubleshooting

  • osu-wine command not found after installation.

    • Solution #1: Make sure you opened a new terminal after running the install script.
    • Solution #2: Make sure ~/.local/bin is in your $PATH.

  • osu! simply doesn't work

    • Solution #1: Please create an issue ticket.

  • These instructions are hard to understand!

    • Solution #1: Feel free to open an issue ticket about this and I'll be happy to help / make changes to this README.