Skip to content

Br1ght0ne/rusteam

Repository files navigation

rusteam

Version Downloads License Documentation

Manage your games on the terminal

rusteam is a little Rust CLI utility to help geeks like me manage their favourite games with ease.

Features

  • list and filter games
  • run games with automatic launcher and platform detection
  • cross-platform configuration
  • shell completion generator

Roadmap

  • install games from downloaded files
  • support more launchers, search methods, etc.

Install

cargo install rusteam

Then, generate a config file:

rusteam config init

This places a config file in ~/.config/rusteam/config.toml, which you can start editing.

Usage

# Get the list of possible subcommands
rusteam help

# Get completions for your shell. zsh in my case
rusteam completion zsh > /some/dir/on/your/fpath

# List all your games, sorted alphabetically
rusteam ls

# Find games with names containing a pattern
rusteam ls rpg

# Run a game. For example, Slay the Spire
rusteam play spire

Configuration reference

Field Description
games_root Where all your games are located. Default: "~/Games"

Author

Oleksii Filonenko

Contributing

Contributions, issues and feature requests are welcome!

Feel free to check open issues.