Skip to content

Commit ae98f74

Browse files
SpexxlSpexxl
authored
Update README.md
1 parent 30eaa46 commit ae98f74

1 file changed

Lines changed: 106 additions & 41 deletions

File tree

‎README.md‎

Lines changed: 106 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,131 @@
1-
# OptiTux GUI 🐧✨
1+
<div align="center">
22

3-
A powerful, modern interface to manage OptiScaler and your game library on Linux with ease.
3+
# OptiTux GUI
44

5-
![OptiTux-GUI Preview](https://github.com/Spexxl/OptiTux-GUI/raw/main/src-tauri/icons/128x128.png)
5+
**A native Linux frontend for managing OptiScaler installations across your game library.**
66

7-
## 📦 Installation
7+
[![Discord](https://img.shields.io/badge/Discord-Join%20the%20server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/e5wyA36Zka)
8+
[![Patreon](https://img.shields.io/badge/Patreon-Support-FF424D?style=for-the-badge&logo=patreon&logoColor=white)](https://www.patreon.com/SpexxLorioh)
9+
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Support-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black)](https://buymeacoffee.com/spexxlorioh)
810

9-
OptiTux is distributed natively for all major Linux ecosystems. Choose the package that best fits your distribution below.
11+
</div>
1012

11-
### 🏹 Arch Linux / CachyOS / Manjaro
12-
For those using Arch-based systems, you have two options:
13+
---
1314

14-
- **Option 1: Pre-compiled Package (Fastest)**
15-
Download the `.pkg.tar.zst` from our [Releases](https://github.com/Spexxl/OptiTux-GUI/releases) and run:
16-
```bash
17-
sudo pacman -U ./OptiTux-x86_64.pkg.tar.zst
18-
```
15+
> [!WARNING]
16+
> **OptiTux GUI is an independent, community-built tool and has no affiliation with the official OptiScaler project.**
17+
> OptiScaler is developed and maintained by its own team. This tool simply provides a graphical interface to manage OptiScaler installations on Linux. All credit for OptiScaler itself goes to its developers — see [Credits](#credits).
1918
20-
- **Option 2: Build with PKGBUILD**
21-
Clone this repo and run `makepkg -si` in the root folder.
19+
---
2220

23-
### 🍎 Debian / Ubuntu / Linux Mint / Pop!_OS
24-
1. Download the latest `.deb` package from [Releases](https://github.com/Spexxl/OptiTux-GUI/releases).
25-
2. Install it using your terminal:
26-
```bash
27-
sudo apt install ./OptiTux_amd64.deb
28-
```
21+
## What is it?
2922

30-
### 🎩 Fedora / Nobara / RHEL
31-
1. Download the latest `.rpm` package from [Releases](https://github.com/Spexxl/OptiTux-GUI/releases).
32-
2. Install it using DNF:
33-
```bash
34-
sudo dnf install ./OptiTux-x86_64.rpm
35-
```
23+
OptiTux GUI lets you install, configure, and remove [OptiScaler](https://github.com/optiscaler/OptiScaler) across your Linux game library — without touching the terminal or manually copying files.
24+
25+
It scans your Steam and Heroic library, detects your GPU, picks the right upscaling backend automatically, and handles everything from downloading OptiScaler releases to writing the correct configuration into `OptiScaler.ini`.
26+
27+
**What you can do with it:**
28+
29+
- Browse your installed games and see which ones have OptiScaler active
30+
- **Quick Install** — one click, done. Detects your GPU, picks the best upscaler, downloads if needed, installs and configures
31+
- **Custom Install** — choose the exact OptiScaler version, upscaler backend (FSR, DLSS, XeSS), whether to include the FSR4 INT8 addon, and optionally enable Frame Generation
32+
- Download and manage OptiScaler releases from both the official repository and the OptiTuxDB
33+
- Uninstall cleanly, with automatic backup and restore of the original DLLs
34+
35+
---
36+
37+
## Requirements
38+
39+
OptiTux GUI is built with [Tauri](https://tauri.app/) and runs on Linux.
40+
41+
**Runtime dependencies (required):**
42+
43+
- A working desktop environment with WebView support (WebKitGTK)
44+
45+
**Optional but recommended:**
46+
47+
### `p7zip`
48+
49+
OptiScaler releases ship as `.7z` archives. OptiTux GUI includes a fallback extractor, but the native `p7zip` binary is significantly faster — especially noticeable on large archives.
50+
51+
| Distro | Command |
52+
|--------|---------|
53+
| Arch / Manjaro | `sudo pacman -S p7zip` |
54+
| Fedora / RHEL | `sudo dnf install p7zip p7zip-plugins` |
55+
| Ubuntu / Debian | `sudo apt install p7zip-full` |
56+
| openSUSE | `sudo zypper install p7zip` |
57+
58+
### `pciutils` (`lspci`)
59+
60+
Used to accurately detect your GPU model and architecture. Without it, GPU detection falls back to sysfs, which may be less precise for certain cards.
3661

37-
### 📦 Flatpak (Universal)
38-
Works on any distribution with Flatpak support.
39-
1. Download the `.flatpak` bundle from [Releases](https://github.com/Spexxl/OptiTux-GUI/releases).
40-
2. Install it with:
62+
| Distro | Command |
63+
|--------|---------|
64+
| Arch / Manjaro | `sudo pacman -S pciutils` |
65+
| Fedora / RHEL | `sudo dnf install pciutils` |
66+
| Ubuntu / Debian | `sudo apt install pciutils` |
67+
| openSUSE | `sudo zypper install pciutils` |
68+
69+
---
70+
71+
## Installation
72+
73+
### Arch Linux / Manjaro / EndeavourOS / CachyOS
74+
You can install OptiTux natively on Arch-based systems using the `PKGBUILD` provided in this repository.
75+
76+
1. Download the `PKGBUILD` file from this repository.
77+
2. Open a terminal in the folder where you saved the file and run:
4178
```bash
42-
flatpak install ./OptiTux.flatpak
79+
makepkg -si
4380
```
81+
*This command will handle dependencies and install the app.*
4482

45-
---
83+
### Debian / Ubuntu / Fedora / Nobara
84+
For other distributions, please download the native package from our [Releases](https://github.com/Spexxl/OptiTux-GUI/releases) page:
4685

47-
## 🚀 Key Features
48-
- **OptiScaler Management:** Install and update OptiScaler versions automatically.
49-
- **Game Library:** Scan and organize your Steam, GOG, and Epic games.
50-
- **DPI Scaling:** Full support for modern high-DPI monitors.
51-
- **Native Experience:** No more AppImage/Sandbox issues, full system integration.
86+
- **Debian / Ubuntu / Mint:** Download the [latest .deb](https://github.com/Spexxl/OptiTux-GUI/releases) and install with `sudo apt install ./file.deb`
87+
- **Fedora / RHEL / Nobara:** Download the [latest .rpm](https://github.com/Spexxl/OptiTux-GUI/releases) and install with `sudo dnf install ./file.rpm`
5288

5389
---
5490

55-
## 🛠 Building from source
56-
Requires [Node.js](https://nodejs.org/) and [Rust](https://www.rust-lang.org/).
91+
## Building from source
92+
93+
You will need [Rust](https://rustup.rs/) and [Node.js](https://nodejs.org/) installed.
5794

5895
```bash
96+
# Clone the repository
97+
git clone https://github.com/Spexxl/OptiTux-GUI.git
98+
cd OptiTux-GUI
99+
100+
# Install frontend dependencies
59101
npm install
102+
103+
# Run in development mode
104+
npm run tauri dev
105+
106+
# Build a release binary
60107
npm run tauri build
61108
```
62109

63110
---
64111

65-
## 📄 License
66-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
112+
## Support the project
113+
114+
Running a community hub with version hosting and infrastructure costs time and money. If OptiTux GUI has been useful to you, consider supporting its development:
115+
116+
<div align="center">
117+
118+
[![Patreon](https://img.shields.io/badge/Patreon-SpexxLorioh-FF424D?style=for-the-badge&logo=patreon&logoColor=white)](https://www.patreon.com/SpexxLorioh)
119+
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-spexxlorioh-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black)](https://buymeacoffee.com/spexxlorioh)
120+
121+
</div>
122+
123+
---
124+
125+
## Credits
126+
127+
OptiTux GUI would not exist without the work of the OptiScaler project.
128+
129+
**[OptiScaler](https://github.com/optiscaler/OptiScaler)** — the upscaling compatibility layer that OptiTux GUI manages. All upscaling functionality, DLL injection, and INI configuration logic belongs to the OptiScaler team and its contributors.
130+
131+
If you find OptiScaler useful, consider supporting its developers directly through [their repository](https://github.com/optiscaler/OptiScaler).

0 commit comments

Comments
 (0)