Skip to content

Latest commit

 

History

History
149 lines (111 loc) · 6.43 KB

README.md

File metadata and controls

149 lines (111 loc) · 6.43 KB

osu-winello

osu! stable installer for Linux with patched Proton-osu and other features.

ezgif com-video-to-gif(1)

Index

Installation

Prerequisites

The only requirements, besides 64- and 32-bit graphics drivers, are git, zenity,wget and xdg-desktop-portal (for in-game links).

You can easily install them like this:

Ubuntu/Debian: sudo apt install -y git wget zenity xdg-desktop-portal

Arch Linux: sudo pacman -Syu --needed --noconfirm git wget zenity xdg-desktop-portal

Fedora: sudo dnf install -y git wget zenity xdg-desktop-portal

openSUSE: sudo zypper install -y git wget zenity xdg-desktop-portal

Drivers:

As obvious as this might sound, installing drivers the right way is needed to have a great experience overall and avoid poor performance or other problems.

Keep in mind that osu! needs lib32 drivers in order to run as it should, so if you're having performance problems, it's probably related to this.

Please make sure to follow the instructions below:

PipeWire:

PipeWire isn't really a dependency but is highly recommended, especially with this script.

Check if it's already on your system with:

export LANG=C
pactl info | grep "Server Name"

If it shows Server Name: PulseAudio (on Pipewire) , then you're good to go.

Otherwise, make sure to install it following the instructions at here:

Installing osu!:

git clone https://github.com/NelloKudo/osu-winello.git
cd osu-winello
chmod +x ./osu-winello.sh
./osu-winello.sh

You can now launch osu! with:

osu-wine

!! \o/ !! ⚠ :

  • You might need to relaunch your terminal to launch the game.
  • Use -40/35ms offset to make up for Wine quirks (or -25 if you're using audio compatibility mode)

Features:

  • Comes with updatable patched Proton-osu binaries with the latest osu! patches for low-latency audio, better performance, alt-tab behavior, crashes fixes and more.
  • Uses umu-launcher to run Proton-osu on Steam's runtime, providing great performance on every system.
  • Provides osu-handler for importing maps and skins, Discord RPC with rpc-bridge and support for native file managers!
  • Supports the latest tosu and legacy gosumemory for streaming etc. with automatic install! (Check flags!)
  • Installs osu! on either default or custom path (using GUI), also working for already existing osu! installations from Windows!
  • Skips the pain of downloading Wineprefix thanks to my fork of osu-wineprefix
  • Support for Windows fonts pre-installed in Proton (JP fonts, special characters etc.)

Troubleshooting

Please refer to osu-winello's wiki for troubleshooting of any type.

If that doesn't help, either:

  • Join ThePooN's Discord and ask in #osu-linux, they'll know how to help! <3
  • Write me on Discord (marshnello)

Flags:

Installation script:

./osu-winello.sh: Installs the game
./osu-winello.sh --no-deps: Installs the game but skips installing dependencies
./osu-winello.sh uninstall: Uninstalls the game

Game script:

osu-wine: Runs osu!
osu-wine --winecfg : Runs winecfg on the osu! Wineprefix
osu-wine --winetricks: Install packages on osu! Wineprefix
osu-wine --regedit: Opens regedit on osu! Wineprefix
osu-wine --kill: Kills osu! and related processes in osu! Wineprefix
osu-wine --kill9: Kills osu! but with wineserver -k9
osu-wine --update: Updates wine-osu to latest version
osu-wine --fixprefix: Reinstalls the osu! Wineprefix from system
osu-wine --info: Troubleshooting and more info
osu-wine --remove: Uninstalls osu! and the script
osu-wine --changedir: Changes directory of the install according to the user
osu-wine --devserver <server>: Runs osu on the specified devserver
osu-wine --fixfolders: Reinstalls registry keys for native file manager in case they break
osu-wine --fixrpc: Reinstalls rpc-bridge if needed!
osu-wine --tosu: Installs and runs tosu without any needed config!
osu-wine --gosumemory: Installs and runs gosumemory without any needed config!
osu-wine --disable-memory-reader: Turn off gosumemory and tosu

Steam Deck Support

Since osu! runs on Proton, you can play that on Steam Deck as well!

It is recommended to not manually install PipeWire on the Steam Deck as it is already installed by default and attempting to do so may cause audio issues.

Credits

Special thanks to:

And that's all. Have fun playing osu!

Check the guide above for troubleshooting or extra tools!