Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmadisetti/steam-tui
Rust TUI client for steamcmd
https://github.com/dmadisetti/steam-tui
Last synced: 4 days ago
JSON representation
Rust TUI client for steamcmd
- Host: GitHub
- URL: https://github.com/dmadisetti/steam-tui
- Owner: dmadisetti
- License: mit
- Created: 2021-05-10T00:21:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T15:07:21.000Z (9 months ago)
- Last Synced: 2024-05-22T07:04:33.313Z (6 months ago)
- Language: Rust
- Size: 223 KB
- Stars: 805
- Watchers: 13
- Forks: 17
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Steam TUI
[](https://github.com/dmadisetti/steam-tui/actions/workflows/test.yml) [](https://crates.io/crates/steam-tui)
## About
Just a simple TUI client for `steamcmd`. Allows for the graphical launching,
updating, and downloading of steam games through a simple terminal client.
Methodology informed by [steam-cli](https://github.com/berenm/steam-cli).
> [!NOTE]
> Steam no longer has a backend only mode. This client has become more limited,
> but still potenitally useful for those who don't want to use the steam client.
## Usage
Login with `steamcmd` first to cache your credentials (don't trust some random app with your passwords):
```bash
steamcmd
# Steam> login
# Steam> quit
```
Launch the binary `steam-tui`, and rejoice :tada:. Help is in the client.
Unable to launch games? Pressing space will start a steam client and will let
you launch games that need steam libraries or have some sort of DRM.
> [!WARNING]
> ## Still unable to launch games?
>
> You are not alone, but gaming on linux is getting better. You can define a
> custom script to launch a specific game by creating
> `$STEAM_TUI_SCRIPT_DIR/.sh`, steam TUI will pass in the file it
> thinks should be run, but you can ignore this and just do whatever.
> This reduces steam-tui to more of a launcher, but it's better than nothing.
## Features not in the help
It's like an Easter egg for reading documentation!
### Favourites
Pressing `f` will toggle favourites on a game, pressing `F` will filter favourite games.
### Hiding games
Pressing `H` will hide the selected game. Hidden games are recorded in `~/.config/steam-tui/config.json`.
### Showing other things (like demos)
You can enable (or hide by exclusion) `Game` `DLC` `Driver` `Applications` `Config` `Demo` `Tool` `Unknown`, by changing the `allowed_games` field in the config.
## Requirements
[`steamcmd`](https://wiki.archlinux.org/title/steam#SteamCMD) is required to
launch steam-tui, as `steam-tui` is essentially just a graphical wrapper for
this program. `wine` usage will be attempted if a native Linux game is not
found.
## Why ?
~Because why not? Also, the Steam client seems to break on my Arch build. I have
a GT 610, and barely anything graphical works- this is a nice work around.~
**Update**, I got rid of the 610 (let's go 1660), but moved to NixOS and
Wayland and the steam client still doesn't work lol.
## Contributing
At this point, I am very much done with the project. I only really play
[Kerbal](https://www.kerbalspaceprogram.com/) and [5 Dimensional Chess with
Multiverse Time Travel](https://www.5dchesswithmultiversetimetravel.com/), so
additional work on this project is moot. If you [buy me a
coffee](https://github.com/sponsors/dmadisetti), I'd be happy to sink some more
time into this.
### Sponsors
Thank you to those who have heeded my call for more coffee!
- @abowen @KDanisme @jharlan-hash (sponsored major update 0.3.0)
- @MathiasSven (sponsored minor update 0.2.1)
- @vaelund (sponsored major update 0.2.0)
## Missing Features
- Better handling for Proton games
- Filter for only showing installed games