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 to Beta instead of Alpha

Browse Source
This commit is contained in:
Philip Kristoffersen
2021-10-02 07:38:24 +02:00
parent f0862857e4
commit 83df94b93b
1 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Readme.md
+12 -9
View File
@@ -21,25 +21,28 @@ The goal is that you do not have to leave your Steam library to launch games fro
- [ ] Scheduling of synchronization - [ ] Scheduling of synchronization
- [ ] Steam Deck support (should work, but need to test when I get one) - [ ] Steam Deck support (should work, but need to test when I get one)
## Very early alpha ## Beta
This tool is still in very early alpha, there are still lots of things to do. This tool is still in beta, there are still lots of things to do, but the things that are there work.
Currently it is only a cli and there are no recuring synchronizations (you have to manually run it or schedule the run yourself). Currently it is only a cli and there are no recuring synchronizations, but those things are coming.
Also only Epic Games, Legendary and Itch.io are supported at the moment, but many more are planned.
It is a Minimal Viable Product currently, I will update it with new features and bug fixes as I get time. Feel free to submit issues and pull requests.
Feel free to submit issues and pull requests
## Getting started ## Getting started
* Download the latest release from the [releases page](https://github.com/PhilipK/steam_shortcuts_sync/releases). * Download the latest release from the [releases page](https://github.com/PhilipK/steam_shortcuts_sync/releases).
* Place it in a folder of your choice. * Place it in a folder of your choice.
* Create a file called `config.toml` in the same folder as the executable.
* Write your [SteamGridDB API key](https://www.steamgriddb.com/profile/preferences/api) in the `config.toml` file (see the [config section](#configuration)).
* Run the executable. * Run the executable.
* Restart Steam to see your new shortcuts. * Restart Steam to see your new shortcuts.
## Getting art for your shortcuts
* Create a file called `config.toml` in the same folder as the executable.
* Get a [SteamGridDB API key](https://www.steamgriddb.com/profile/preferences/api)
* Write it in the `config.toml` file (see how in the [config section](#configuration)).
* Run the executable again
## 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. In the future there will be an UI for changing these configurations.