README.md (577B)

      1 # SCOUT
      2 A game launcher.
      3 
      4 ## Configuration
      5 SCOUT looks for configuration in `$XDG_CONFIG_HOME/scout`.
      6 
      7 - scout.ini
      8 - cards/*.ini
      9 
     10 ### Cards
     11 Below is an example card file, `mygame.ini`.
     12 ```
     13 [card]
     14 title=My Game
     15 description=Super cool, action-packed!
     16 command=mygame
     17 image=mygame.png
     18 ```
     19 The chosen image must be in [farbeld](https://tools.suckless.org/farbfeld/)
     20 format. Why? Because it's easier to work with.
     21 
     22 ## TODO
     23 - Support game covers
     24 - Clean up controller support
     25 
     26 ## Planned
     27 - Automatically setup controls for supported games
     28 - SwayWM Integration
     29   - Splitscreen support