djib/BoilR
1
0
Fork 0
mirror of https://github.com/djibux/BoilR.git synced 2026-09-01 05:53:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme with checklist

Browse Source
This commit is contained in:
Philip
2021-09-29 22:58:26 +02:00
parent e059ecc25b
commit 4a551aa11c
1 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Readme.md
+16 -7
View File
@@ -2,16 +2,23 @@
## Description ## Description
This little tool will synchronize games from other platforms into your Steam library. This little tool will synchronize games from other platforms into your Steam library, using the Steam Shortcuts feature.
The goal is that you do not have to leave your Steam library to launch games from other launchers/stores. The goal is that you do not have to leave your Steam library to launch games from other launchers/stores.
## Features ## Features
- [x] Download art from [SteamGridDB](https://www.steamgriddb.com/)
* Add shortcuts to games from [Epic Games Store](https://www.epicgames.com/) - [x] [Legendary](https://github.com/derrod/legendary) integration
* Add shortcuts to games from [Legendary](https://github.com/derrod/legendary) - [x] [Epic Games Store](https://www.epicgames.com/) integration
* Add shortcuts to games from [Itch.io](https://itch.io/app) - [x] [Itch.io](https://itch.io/app) integration
* Download custom art for games from [SteamGridDB](https://www.steamgriddb.com/) for any custom steam shortcut. - [x] Cross Platform
- [x] Small (~1.5mb on disk), lightweight (~2mb ram) and fast(~1s sync)
- [ ] Origin integration
- [ ] XBox/Microsoft Store integration
- [ ] GOG integration
- [ ] [Lutris](https://github.com/lutris/lutris) integration
- [ ] UI For configuration
- [ ] Scheduling of synchronization
- [ ] Steam Deck support (should work, but need to test when I get one)
## Very early alpha ## Very early alpha
@@ -34,6 +41,8 @@ Feel free to submit issues and pull requests
## Configuration ## Configuration
The tool reads its configuration from a `config.toml` file. The tool reads its configuration from a `config.toml` file.
In the future there will be an UI for changing these configurations.
Here is a simple example of how to write the config file: Here is a simple example of how to write the config file:
```toml ```toml
[steamgrid_db] [steamgrid_db]