Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NelloKudo/osu-winello
osu! stable installer for Linux with patched Proton-osu and other nice features 8)
https://github.com/NelloKudo/osu-winello
game linux osu osugame wine
Last synced: 3 months ago
JSON representation
osu! stable installer for Linux with patched Proton-osu and other nice features 8)
- Host: GitHub
- URL: https://github.com/NelloKudo/osu-winello
- Owner: NelloKudo
- License: gpl-3.0
- Created: 2022-01-20T17:20:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T23:47:50.000Z (3 months ago)
- Last Synced: 2024-09-18T08:41:50.811Z (3 months ago)
- Topics: game, linux, osu, osugame, wine
- Language: Shell
- Homepage:
- Size: 627 KB
- Stars: 303
- Watchers: 8
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/NelloKudo/osu-winello - osu! on linux script (Jump To / Games)
README
# osu-winello
osu! stable installer for Linux with patched Proton-osu and other features.
# Index
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Drivers](#drivers)
- [PipeWire](#pipewire)
- [Installing osu!](#installing-osu)
- [Features](#features)
- [Troubleshooting](#troubleshooting)
- [Flags](#flags)
- [Steam Deck Support](#steam-deck-support)
- [Credits](#credits)
# Installation
## Prerequisites
The only requirements, besides 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 -Sy --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`
----------
Ubuntu, Debian and related users *might* also need to install `steam` for it to pull some needed library (libGL mostly). Please do that if you're facing any issues with the game not launching!
## 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:
- [Installing Drivers](https://github.com/lutris/docs/blob/master/InstallingDrivers.md)
## 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 PipeWire](https://github.com/NelloKudo/osu-winello/wiki/Installing-PipeWire)
## 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](https://github.com/whrvt/umubuilder) binaries with the latest osu! patches for low-latency audio, better performance, alt-tab behavior, crashes fixes and more.
- Uses [umu-launcher](https://github.com/Open-Wine-Components/umu-launcher) to run Proton-osu on Steam's runtime, providing great performance on every system.
- Provides [osu-handler](https://aur.archlinux.org/packages/osu-handler) for importing maps and skins, Discord RPC with [winestreamproxy](https://github.com/openglfreak/winestreamproxy) and support for native file managers!
- Supports [gosumemory](https://github.com/l3lackShark/gosumemory) for streaming etc. with automatic install! (Check [flags](#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](https://gitlab.com/NelloKudo/osu-winello-prefix) of [osu-wineprefix](https://gitlab.com/osu-wine/osu-wineprefix)
- Support for Windows fonts pre-installed in Proton (JP fonts, special characters etc.)
# Troubleshooting
Please refer to [osu-winello's wiki](https://github.com/NelloKudo/osu-winello/wiki) for troubleshooting of any type.
If that doesn't help, either:
- Join [ThePooN's Discord](https://discord.gg/bc4qaYjqyT) 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 : Runs osu on the specified devserver
osu-wine --fixfolders: Reinstalls registry keys for native file manager in case they break
osu-wine --gosumemory: Installs and runs gosumemory without any needed config!
```
# 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:
- [whrvt aka spectator](https://github.com/whrvt/wine-osu-patches) for his help with Wine, Proton and related, never failed to solve any issue :')
- [ThePooN's Discord](https://discord.gg/bc4qaYjqyT) for supporting Winello since its early stages!
- [umu-launcher](https://github.com/Open-Wine-Components/umu-launcher) for making using Proton as easy as this!
- [gonX's wine-osu](https://drive.google.com/drive/folders/17MVlyXixv7uS3JW4B-H8oS4qgLn7eBw5)
- [Integrating native file manager by Maot](https://gist.github.com/maotovisk/1bf3a7c9054890f91b9234c3663c03a2)
- [KatouMegumi's guide](https://wiki.archlinux.org/title/User:Katoumegumi#osu!_(stable)_on_Arch_Linux)
- [hwsnemo's wine-osu](https://software.opensuse.org//download.html?project=home%3Ahwsnemo%3Apackaged-wine-osu&package=wine-osu)
- [diamondburned's osu-wine](https://gitlab.com/osu-wine/osu-wine)
- [openglfreak's packages](https://github.com/openglfreak)
- Last but not least, every contributor. Thanks for making Winello even better!
And that's all. Have fun playing osu!
## Check the guide above for troubleshooting or extra tools!