Skip to content

Provides a single TUI-based registry for drm-free, wine and steam games on linux, accessed through a rofi launch menu.

License

Notifications You must be signed in to change notification settings

nicohman/eidolon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eidolon builds.sr.ht status

A conversion of steam_suite to rust with additional features. Provides a single TUI-based registry for drm-free, wine and steam games on linux, accessed through a rofi launch menu. Simple, fast and lightweight. This is a mirror of the sr.ht repository. Please file issues for eidolon here and patches here, though I will still accept issues and pull requests on github.

See it in action

A gif showing eidolon working

Installation

You can now install from crates.io. Just run cargo install eidolon and install rofi via your distro's package manager!

You'll need rofi and cargo installed. Run:

git clone https://git.sr.ht/~nicohman/eidolon && cd eidolon

cargo install --path . --force

Alternatively, check here for a possibly out of date binary. In addition, you can download a version built from the latest git commit at my website

Unofficial packages

It appears someone is maintaining a package on the AUR. If anyone else wants to maintain a package somewhere, feel free to! If you tell me about it, I'll even add a link here.

Usage

eidolon help for list of commands:

eidolon
nicohman <nicohman@demenses.net>
Provides a single TUI-based registry for drm-free, wine and steam games on linux, accessed through a rofi launch menu.

USAGE:
    eidolon <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    add       Adds selected file to registry
    help      Prints this message or the help of the given subcommand(s)
    import    Attempts to import in game directory from dir path
    list      Lists installed games
    menu      Show game menu
    rm        Remove a game from the registry
    run       Runs a game by name
    update    Updates registry with installed steam, lutris wine, and itch games

Configuration

Right now, only three config options exist: menu_command, prefix_command and steam_dirs. The config file is saved in ~/.config/eidolon/config.json, of course in the JSON format.

menu_command : The command to be run to display the eidolon menu. Will be given an alphabetical list of names through STDIN, and a name is expected back through STDOUT.

steam_dirs : a |-seperated list of steam install directories, with $HOME replacing the home directory.

prefix_command : A command that will be run as a prefix to every game command. Good for optirun or steam runtime launching.

Default config file:

{
steam_dirs: ["$HOME/.local/share/steam/steamapps"],

menu_command: "rofi -theme sidebar -mesg 'eidolon game:' -p '> ' -dmenu",

prefix_command: ""
}

Todo

  • Please suggest any features you want as an issue!