Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jordanviknar/simplesteamtinker

A work-in-progress simple, fast, and modern Adwaita alternative to SteamTinkerLaunch.
https://github.com/jordanviknar/simplesteamtinker

gamemode gamescope gtk gtk4 libadwaita linux lua proton steam steamtinkerlaunch zink

Last synced: 3 months ago
JSON representation

A work-in-progress simple, fast, and modern Adwaita alternative to SteamTinkerLaunch.

Awesome Lists containing this project

README 

        
> [!WARNING]

> This project may be deprecated in the future, as I have been recently working on a **massive** rewrite, avoiding LGI and focusing more on portability and stability this time around.

___



> [!IMPORTANT]

> SimpleSteamTinker is still in ***HEAVY*** development and very unfinished.

> Expect an incomplete interface and lots of missing/unstable features.

>

> If SteamTinkerLaunch is fast enough for you and fits your needs, you should not use this tool right now.

>

> With that being said, I'd still very much appreciate people testing SimpleSteamTinker and reporting [issues](https://github.com/JordanViknar/SimpleSteamTinker/issues) or contributing.





	

	
SimpleSteamTinker


	
A work-in-progress simple, fast, and modern Adwaita alternative to SteamTinkerLaunch.


	

	

	

	

	

	

	

	

	




## Description



### Situation



I like [SteamTinkerLaunch](https://github.com/sonic2kk/steamtinkerlaunch). It is for me one of the biggest tools to have ever been created for Linux gaming.



However, it presents many flaws in my eyes : it is slow, impractical to use, and not user-friendly.



I want Linux Gaming to be available to everyone, including any non-technical users. In my opinion, SteamTinkerLaunch's interface is not friendly to newcomers.



Finally, my curiosity once led me to look inside its source code, only to be met with a single, extremely long (26k+ lines) Bash script. At that point, I decided there should be an alternative to it.



*And thus came SimpleSteamTinker...*



### Goal



*TL;DR : Simple, Fast, Modern & Friendly*



SimpleSteamTinker aims to be only an alternative solution to SteamTinkerLaunch, not to replace it : the more complex features it provides that aren't used by the average user won't be implemented.



Using Lua, a fast and simple language, and Adwaita, a modern user-friendly interface system, the goal of this project is to have a clean and easy but *powerful* way of launching Steam games with custom options and tools.



It takes inspiration from [Bottles](https://github.com/bottlesdevs/Bottles) and Adwaita applications in general.



Additionally, it is considered SimpleSteamTinker should work *with* Steam rather than hack/replace its features. Anything that can be easily done through Steam will not be reimplemented (Proton version management for example. If you want to use GE-Proton, [ProtonPlus](https://github.com/Vysp3r/ProtonPlus) and [ProtonUp-Qt](https://github.com/DavidoTek/ProtonUp-Qt) are recommended).



And finally, as a side goal : prove that Lua can *also* be used for developing modern applications, just like for example Python (which I often see in Adwaita apps).



## Installation



### Arch Linux-based distributions



SimpleSteamTinker can be installed from Arch Linux, Manjaro, and variants through the provided [PKGBUILD](./install/archlinux/PKGBUILD).



**Always** download the latest version of the PKGBUILD, then use **makepkg** in its directory.



It will eventually be made available on the AUR once the program is complete enough.



To enable a game in SimpleSteamTinker with this installation method, use this text as launch options in Steam :

```bash

sst %command%

```



### Packaging for other distributions



Here are informations which might be useful to you :



SimpleSteamTinker is meant to be installed in `/usr/share/SimpleSteamTinker` (except `sst` which goes into `/usr/bin`).

The system desktop file goes in `/usr/share/applications` and the icons go in `/usr/share/icons` like many applications.



Most of the file structure installation steps can be achieved with the Makefile.

It is recommended to use it if possible in your packaging system.



It depends on :

- Lua 5.4

- [LGI](https://github.com/lgi-devs/lgi) (development version **specifically**) + [GTK4](https://www.gtk.org/) + [libadwaita](https://gnome.pages.gitlab.gnome.org/libadwaita/)

- Steam installation, with a user configured and games installed.

- [LuaFileSystem](https://github.com/lunarmodules/luafilesystem)

- [LuaSocket](https://github.com/lunarmodules/luasocket) + [LuaSec](https://github.com/lunarmodules/luasec)

- [dkjson](https://dkolf.de/src/dkjson-lua.fsl/home)

- [xclip](https://github.com/astrand/xclip) *(Might be replaced/made optional in the future.)*

- [libnotify](https://gitlab.gnome.org/GNOME/libnotify)



And optionally (if they're missing, their related features will simply be disabled) :



[GameMode](https://github.com/FeralInteractive/gamemode), [MangoHud](https://github.com/flightlessmango/MangoHud), [Mesa](https://www.mesa3d.org/) *(for Zink support)*, [switcheroo-control](https://gitlab.freedesktop.org/hadess/switcheroo-control) and [Gamescope](https://github.com/ValveSoftware/gamescope).



## Development



Simply install the project's dependencies described earlier and clone it.



To test the launch of Steam games, insert in their launch options :

```bash

/PATH/TO/CLONED/REPO/sst %command%

```

For example, in my case `/PATH/TO/CLONED/REPO/sst` is `/home/jordan/Programmation/SimpleSteamTinker/sst`.



Additionally, if you want to perform UI-related changes, you'll need [Blueprint](https://gitlab.gnome.org/jwestman/blueprint-compiler).

If, in the future, LGI becomes stable enough with GTK4 to use it directly to generate the UI, Blueprint might be dropped.



*Note : A desktop file won't be provided with this method, and icons won't be installed.*



## Comparison



### Development



| Development | SteamTinkerLaunch | SimpleSteamTinker |

| --- | --- | --- |

| Language | Bash | Lua |

| Code | A single file with 26k lines | Organised in modules and commented |

| UI | Directly generated by the code | (Mostly) done in separate GTK Blueprint files |

| Interface system | yad + GTK3 | LGI + GTK4 + libadwaita |

| License | GPL-3.0 | MPL-2.0 |



### Interface



| Features (interface) | SteamTinkerLaunch | SimpleSteamTinker |

| --- | --- | --- |

| Launch speed (on primary laptop) | ❌ (25 seconds) | ✅ (1 second) |

| Game list | ❌ | ✅ |

| Game status | ❌ | ✅ |

| ProtonDB integration | ✅ | ✅ |

| Launch Button | ✅ | ✅ |

| Steam AppID | ✅ | ✅ |

| Notifications | ✅ | ✅ |

| Pre-game launch window | ✅ | ❌ *(Not implemented to speed up game startup and not get in the user's way. Might change in the future.)* |

| Categories | ✅ | ❌ |

| Custom default game config | ✅ | ❌ |

| Game location | ~ *(impractical)* | ✅ |

| Compatdata location | ❌ | ✅ |

| Help pages *(ProtonDB, PCGamingWiki, etc.)* | ~ *(impractical)* | ✅ |



### Tools, settings, etc.



*(Note : Native Linux features/tools/settings are prioritized over alternatives designed for Windows.)*



| Features (tools, settings, etc.) | SteamTinkerLaunch | SimpleSteamTinker |

| --- | --- | --- |

| Non-Steam game support | ✅ | ❌ *([Bottles](https://github.com/bottlesdevs/Bottles) recommended)* |

| ~~Proton version management~~ | ✅ | ❌ *([ProtonPlus](https://github.com/Vysp3r/ProtonPlus) recommended)* |

| dGPU management | ✅ | ✅ |

| GameMode | ✅ | ✅ |

| Custom launch system | ✅ | 🚧 *(Planned)* |

| Winetricks | ✅ | ❌ *(Planned ?)* |

| Protontricks | ❌ | ❌ *(Planned ?)* |

| Proton settings | ✅ | ✅ |

| DXVK settings | ✅ | 🚧 *(Planned)* |

| VKD3D settings | ✅ | 🚧 *(Planned)* |

| MangoHud | ✅ | ✅ |

| Gamescope | ✅ | ✅ |

| Shader support (ReShade/vkBasalt) | ✅ | 🚧 *(Planned)* |

| SDL Wayland video driver | ✅ | ✅ |

| Zink | ✅ | ✅ |

| PulseAudio latency | ✅ | 🚧 *(Planned)* |

| Vortex | ✅ | ❌ |

| Mod Organizer 2 | ✅ | ❌ |

| HedgeModManager | ✅ | ❌ |

| geo-11 3D Driver | ✅ | ❌ |

| SpecialK | ✅ | ❌ |

| FlawlessWidescreen | ✅ | ❌ |

| Stereo3D | ✅ | ❌ |

| RADV Perftest Options | ✅ | ❌ *(Cannot test properly due to lack of an AMD GPU)* |

| Steam Linux Runtime toggle | ✅ | ❌ |

| steamwebhelper toggle | ✅ | ❌ |

| obs-gamecapture | ✅ | ✅ |

| ~~Nyrna~~ | ✅ | ❌ *(Waiting for Wayland support...)* |

| ~~ReplaySorcery~~ | ✅ | ❌ *(Unmaintaned)* |

| ~~Boxtron~~ | ✅ | ❌ *([ProtonPlus](https://github.com/Vysp3r/ProtonPlus) recommended)* |

| ~~Roberta~~ | ✅ | ❌ *([ProtonPlus](https://github.com/Vysp3r/ProtonPlus) recommended)* |

| ~~Luxtorpeda~~ | ✅ | ❌ *([ProtonPlus](https://github.com/Vysp3r/ProtonPlus) recommended)* |

| Network monitoring and control | ✅ | 🚧 *(Planned)* |

| Discord Rich Presence | ✅ | 🚧 *(Planned)* |



## Bug Reports / Contributions / Suggestions

You can report bugs or suggest features by making an issue, or you can contribute to this program directly by forking it and then sending a pull request.



Any help will be very much appreciated. Thank you.