You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Readme.md
+37-31Lines changed: 37 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,29 +2,32 @@
2
2
3
3
## Description
4
4
5
-
This little tool will synchronize games from other platforms into your Steam library, using the Steam Shortcuts feature.
6
-
The goal is that you do not have to leave your Steam library to launch games from other launchers/stores.
7
-
If you set it up, it will also download artwork from [SteamGridDB](https://www.steamgriddb.com/).
5
+
This little tool will show games from other games platforms in your Steam library.
6
+
It uses the Steam 3rd party shortcuts feature and does not require you to set up anything.
7
+
The goal is that you do not have to leave your Steam library to launch games from other launchers/stores, so that you can find all the games that you have available.
8
+
Optionally you can set BoilR up to automatically download artwork from [SteamGridDB](https://www.steamgriddb.com/).
@@ -41,20 +44,20 @@ Feel free to submit issues and pull requests.
41
44
## Getting cover art for your shortcuts
42
45
43
46
- Get a [SteamGridDB API key](https://www.steamgriddb.com/profile/preferences/api)
44
-
-For the CLI version, Write it in the `config.toml` file (see how in the [config section](#configuration)).
45
-
-for the Ui version , copy it into the auth key input.
47
+
- Write it in the `config.toml` file (see how in the [config section](#configuration)).
48
+
-If you are using the Ui version just put it into the auth key input.
46
49
- Run the executable again
47
50
48
51
## Configuration
49
52
50
-
The tool reads its configuration from a `config.toml` file.
53
+
The tool reads its configuration from a `config.toml` file. If it cannot find one, it will create a default one on its first run.
51
54
You can either manually edit this file or use the UI version to changing these configurations.
52
55
53
56
Here is a simple example of how to write the config file:
54
57
55
58
```toml
56
59
[steamgrid_db]
57
-
auth_key="your steamgrid db auth key"
60
+
auth_key="Write your authentication key between these quotes"
58
61
```
59
62
60
63
And here is a full example of all configuration options:
@@ -67,24 +70,24 @@ location="C:\\ProgramData\\Epic\\EpicGamesLauncher\\Data\\Manifests" #If this va
67
70
create_symlinks = true#Only for Linux, To get around a bug in steam where paths can not contain spaces, BoilR creates symlinks in ~/.boilr/link and uses those.
68
71
69
72
[legendary]
70
-
enabled=false#On windows this is default false, on linux default true
71
-
executable="legendary"#If this value is not defined, "legendary" will be used, it is assumed to be on the path.
73
+
enabled=true
74
+
executable="legendary"#The name of the "legendary" executable will be used, it is assumed to be on the path.
72
75
73
76
[lutris]
74
-
enabled=true#Default true
77
+
enabled=true
75
78
executable="lutris"#The executable to run for lutris, default is "lutris".
76
79
77
80
[itch]
78
-
enabled=false#Default false
81
+
enabled=true
79
82
location="C:\\Users\\user\\AppData\\Roaming\\itch"#If this value is not defined, "%APPDATA%itch" will be used on windows, and HOME/.config/itch on linux.
80
83
create_symlinks = true#Only for Linux, To get around a bug in steam where paths can not contain spaces, BoilR creates symlinks in ~/.boilr/link and uses those.
81
84
82
85
[origin]
83
-
enabled=false#Default false
86
+
enabled=true
84
87
location="C:\\ProgramData\\Origin"#If this value is not defined, "%PROGRAMGDATA%origin" will be used on windows, and HOME/Games/origin/drive_c/ProgramData/Origin/ on linux.
85
88
86
89
[gog]
87
-
enabled=false#Default false
90
+
enabled=true
88
91
location="C:\\ProgramData\\GOG.com\\Galaxy"#The location of GOG Galaxy will default to this value if not defined on windows and "~/Games/gog-galaxy/drive_c/ProgramData/GOG.com/Galaxy" on linux.
89
92
create_symlinks = true#Only for Linux, To get around a bug in steam where paths can not contain spaces, BoilR creates symlinks in ~/.boilr/link and uses those.
90
93
wine_c_drive="/home/username/Games/gog-galaxy/drive_c"#Only for Linux, Is mandatory on linux.
@@ -100,12 +103,12 @@ prefer_animated = false #If true, animated images will be prefered over static i
100
103
101
104
## Tips for Linux
102
105
103
-
If you are on linux, and want to use one of the launchers that is not available natively, i suggest you use Lutris and make sure that the BoilR integration for Lutris is enabled (see config section). If you want to avoid launching into Lutris here here are a few ways that you can do that.
106
+
If you are on Linux, and want to use one of the launchers that is not available natively, I suggest you use Lutris and make sure that the BoilR integration for Lutris is enabled (it is by default, see config section). If you want to avoid launching into Lutris, here are a few ways that you can do that.
0 commit comments