Skip to content

Commit 4cb65b8

Browse files
committed
Fix typos in Amazon platform code
Fix typo in get_settings_serializable method across multiple platforms Fix typos and improve clarity in Linux tips documentation Fix typos and improve clarity in documentation
1 parent a83f0e7 commit 4cb65b8

19 files changed

+39
-39
lines changed

Readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ There is also an [AUR package](https://aur.archlinux.org/packages/steam-boilr-gu
5656

5757
## Integrations
5858

59-
BoilR can import games from many platforms, but there are limits based
59+
BoilR can import games from many platforms, but there are limitations
6060

6161
| Platforms | Windows | Linux (executable) | Linux (flatpak) |
6262
| ------------------------------------------------------------------------------- | ------- | ----------------------------- | ----------------------------------------- |
@@ -117,7 +117,7 @@ If you experience bugs or errors please try the native version and see if that f
117117
### How can I help/contribute?
118118
If you are a coder, you are very welcome! You can fork this repo and then create a pull request.
119119

120-
To check formats and errors of code before run the code:
120+
To check formats and errors of code before running the code:
121121

122122
```shell
123123
cargo fmt
@@ -148,4 +148,4 @@ Nope, please don't, donate it to your favorite charity instead, and if you don't
148148
This project is dual license MIT or Apache 2.0 , it is up to you. In short, you can do what you want with this project, but if in doubt read the license files.
149149

150150
## What is up with the name BoilR?
151-
This tool turns things into Steam, therefor boiler, And it is written in **R**ust so therefor: BoilR
151+
This tool turns things into Steam, therefore boiler, And it is written in **R**ust, so therefore: BoilR

configuration.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Configuration
22

33
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.
4-
You can either manually edit this file or use the UI version to changing the configurations.
5-
Most people will not need to change the configuration and BoilR can find different launchers without problem.
4+
You can either manually edit this file or use the UI version to change the configurations.
5+
Most people will not need to change the configuration and BoilR can find different launchers without problems.
66

77
Here is a simple example of how to write the config file:
88

@@ -16,7 +16,7 @@ And here is a full example of all configuration options:
1616
```toml
1717

1818
[epic_games]
19-
enabled=true #On windows this is default true, on linux default false
19+
enabled=true #On Windows this is default true, on Linux default false
2020
location="C:\\ProgramData\\Epic\\EpicGamesLauncher\\Data\\Manifests" #If this value is not defined, the tool will try to find it automatically (only windows). If it can't find it, it will fail and tell you.
2121
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.
2222

@@ -35,7 +35,7 @@ create_symlinks = true #Only for Linux, To get around a bug in steam where paths
3535

3636
[origin]
3737
enabled=true
38-
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.
38+
location="C:\\ProgramData\\Origin" #If this value is not defined, "%PROGRAMDATA%\\Origin" will be used on Windows, and HOME/Games/origin/drive_c/ProgramData/Origin/ on Linux.
3939

4040
[gog]
4141
enabled=true
@@ -45,8 +45,8 @@ wine_c_drive="/home/username/Games/gog-galaxy/drive_c" #Only for Linux, Is manda
4545

4646
[steam]
4747
location="C:\\Program Files (x86)\\Steam\\" #If this value is not defined, the tool will try to find it automatically. If it can't find it, it will fail and tell you.
48-
optimize_for_big_picture=false #Set icons to wide images, that big picture mode will use. This will make the icons have a wrong ratio in desktop mode, but will improve the look in big picture mode
49-
create_collections=false #Will try to create a steam collection for each platform
48+
optimize_for_big_picture=false #Set icons to wide images that Big Picture mode will use. This will make the icons have a wrong ratio in desktop mode but will improve the look in Big Picture mode
49+
create_collections=false #Will try to create a Steam collection for each platform
5050

5151
[steamgrid_db]
5252
enabled = true #If false, the whole download of custom art will be skipped.
@@ -55,7 +55,7 @@ prefer_animated = false #If true, animated images will be prefered over static i
5555
```
5656

5757

58-
## No Vsync
59-
BoilR runs with Vsync Enabled, to limit its resource use.
60-
This can be a problem for some setups that run Linux, Wayland and Nvidia (but not all).
61-
If BoilR just crashes when you start it, try to add `--no-vsync` as an argument when you launch boilr.
58+
## No VSync
59+
BoilR runs with VSync enabled to limit its resource use.
60+
This can be a problem for some setups that run Linux, Wayland, and Nvidia (but not all).
61+
If BoilR just crashes when you start it, try to add `--no-vsync` as an argument when you launch BoilR.

src/platforms/amazon/amazon_platform.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ fn get_sqlite_path() -> eyre::Result<PathBuf> {
3232
Ok(path)
3333
} else {
3434
Err(eyre::format_err!(
35-
"Amazong GameInstallInfo.sqlite not found at {:?}",
35+
"Amazon GameInstallInfo.sqlite not found at {:?}",
3636
path
3737
))
3838
}
@@ -72,7 +72,7 @@ impl GamesPlatform for AmazonPlatform {
7272
ui.checkbox(&mut self.settings.enabled, "Import from Amazon");
7373
}
7474

75-
fn get_settings_serilizable(&self) -> String {
75+
fn get_settings_serializable(&self) -> String {
7676
toml::to_string(&self.settings).unwrap_or_default()
7777
}
7878

@@ -83,10 +83,10 @@ impl GamesPlatform for AmazonPlatform {
8383

8484
impl AmazonPlatform {
8585
fn get_amazon_games(&self) -> eyre::Result<Vec<AmazonGame>> {
86-
let sqllite_path = get_sqlite_path()?;
86+
let sqlite_path = get_sqlite_path()?;
8787
let launcher_path = get_launcher_path()?;
8888
let mut result = vec![];
89-
let connection = sqlite::open(sqllite_path)?;
89+
let connection = sqlite::open(sqlite_path)?;
9090
let mut statement =
9191
connection.prepare("SELECT Id, ProductTitle FROM DbSet WHERE Installed = 1")?;
9292
while let Ok(State::Row) = statement.next() {

src/platforms/bottles/platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ impl GamesPlatform for BottlesPlatform {
146146
ui.checkbox(&mut self.settings.enabled, "Import from Bottles");
147147
}
148148

149-
fn get_settings_serilizable(&self) -> String {
149+
fn get_settings_serializable(&self) -> String {
150150
toml::to_string(&self.settings).unwrap_or_default()
151151
}
152152

src/platforms/egs/epic_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ impl GamesPlatform for EpicPlatform {
5353
self.render_epic_settings(ui)
5454
}
5555

56-
fn get_settings_serilizable(&self) -> String {
56+
fn get_settings_serializable(&self) -> String {
5757
toml::to_string(&self.settings).unwrap_or_default()
5858
}
5959
}

src/platforms/flatpak/platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ impl GamesPlatform for FlatpakPlatform {
105105
ui.checkbox(&mut self.settings.enabled, "Import from Flatpak");
106106
}
107107

108-
fn get_settings_serilizable(&self) -> String {
108+
fn get_settings_serializable(&self) -> String {
109109
toml::to_string(&self.settings).unwrap_or_default()
110110
}
111111

src/platforms/gamepass/platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ impl GamesPlatform for GamePassPlatForm {
7777
Ok(games_iter.collect())
7878
}
7979

80-
fn get_settings_serilizable(&self) -> String {
80+
fn get_settings_serializable(&self) -> String {
8181
toml::to_string(&self.settings).unwrap_or_default()
8282
}
8383

src/platforms/gog/gog_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ impl GamesPlatform for GogPlatform {
260260
}
261261
}
262262

263-
fn get_settings_serilizable(&self) -> String {
263+
fn get_settings_serializable(&self) -> String {
264264
toml::to_string(&self.settings).unwrap_or_default()
265265
}
266266

src/platforms/heroic/heroic_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ impl GamesPlatform for HeroicPlatform {
273273
});
274274
}
275275

276-
fn get_settings_serilizable(&self) -> String {
276+
fn get_settings_serializable(&self) -> String {
277277
toml::to_string(&self.settings).unwrap_or_default()
278278
}
279279

src/platforms/itch/itch_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ impl GamesPlatform for ItchPlatform {
147147
}
148148
}
149149

150-
fn get_settings_serilizable(&self) -> String {
150+
fn get_settings_serializable(&self) -> String {
151151
toml::to_string(&self.settings).unwrap_or_default()
152152
}
153153

src/platforms/legendary/legendary_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ impl GamesPlatform for LegendaryPlatform {
6666
}
6767
}
6868

69-
fn get_settings_serilizable(&self) -> String {
69+
fn get_settings_serializable(&self) -> String {
7070
toml::to_string(&self.settings).unwrap_or_default()
7171
}
7272

src/platforms/lutris/lutris_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ impl GamesPlatform for LutrisPlatform {
112112
}
113113
}
114114

115-
fn get_settings_serilizable(&self) -> String {
115+
fn get_settings_serializable(&self) -> String {
116116
toml::to_string(&self.settings).unwrap_or_default()
117117
}
118118

src/platforms/minigalaxy/platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ impl GamesPlatform for MiniGalaxyPlatform{
8787
crate::platforms::to_shortcuts(self, Ok(gog_games))
8888
}
8989

90-
fn get_settings_serilizable(&self) -> String {
90+
fn get_settings_serializable(&self) -> String {
9191
toml::to_string(&self.settings).unwrap_or_default()
9292
}
9393

src/platforms/origin/origin_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ impl GamesPlatform for OriginPlatform {
195195
ui.checkbox(&mut self.settings.enabled, "Import from Origin");
196196
}
197197

198-
fn get_settings_serilizable(&self) -> String {
198+
fn get_settings_serializable(&self) -> String {
199199
toml::to_string(&self.settings).unwrap_or_default()
200200
}
201201

src/platforms/platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ where
1515

1616
fn get_shortcut_info(&self) -> eyre::Result<Vec<ShortcutToImport>>;
1717

18-
fn get_settings_serilizable(&self) -> String;
18+
fn get_settings_serializable(&self) -> String;
1919

2020
fn render_ui(&mut self, ui: &mut egui::Ui);
2121
}

src/platforms/playnite/playnite_platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ impl GamesPlatform for PlaynitePlatform {
5858
to_shortcuts_simple(self.get_playnite_games())
5959
}
6060

61-
fn get_settings_serilizable(&self) -> String {
61+
fn get_settings_serializable(&self) -> String {
6262
toml::to_string(&self.settings).unwrap_or_default()
6363
}
6464

src/platforms/uplay/platform.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ impl GamesPlatform for UplayPlatform {
296296
ui.checkbox(&mut self.settings.enabled, "Import from Uplay");
297297
}
298298

299-
fn get_settings_serilizable(&self) -> String {
299+
fn get_settings_serializable(&self) -> String {
300300
toml::to_string(&self.settings).unwrap_or_default()
301301
}
302302

src/settings.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ pub fn save_settings(settings: &Settings, platforms: &Platforms) -> eyre::Result
7777
toml.push('\n');
7878
toml.push_str(section_name.as_str());
7979
toml.push('\n');
80-
let platform_string = platform.get_settings_serilizable();
80+
let platform_string = platform.get_settings_serializable();
8181
toml.push_str(platform_string.as_str());
8282
}
8383

tips_for_linux.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@ If you are on Linux, and want to use one of the launchers that is not available
44
If you want to avoid launching into Lutris, here are a few ways that you can do that.
55

66
### GOG
7-
I recommend you just use Heroic. But if you really really want to use GOG Galaxy you can:
7+
I recommend you just use Heroic. But if you really, really want to use GOG Galaxy you can:
88

99
- Install [Lutris](https://lutris.net/)
1010
- Install GOG from Lutris [here](https://lutris.net/games/gog-galaxy/)
11-
- Set the path to GOG in the config.toml (or through the ui)
11+
- Set the path to GOG in the config.toml (or through the UI)
1212
- Run BoilR
1313
- Remember to pick which version of Proton you want to use for a game, before the first time you play it.
1414

1515
### Epic
1616

17-
I recommend you just use Heroic, Rare or [Legendary](https://github.com/derrod/legendary). But if you really really want to use EGS you can:
17+
I recommend you just use Heroic, Rare, or [Legendary](https://github.com/derrod/legendary). But if you really, really want to use EGS you can:
1818

1919
- Install [Lutris](https://lutris.net/)
2020
- Install EGS from Lutris [here](https://lutris.net/games/epic-games-store/)
21-
- Set the path to EGS in the config.toml (or through the ui)
21+
- Set the path to EGS in the config.toml (or through the UI)
2222
- Run BoilR
2323
- Remember to pick which version of Proton you want to use for a game, before the first time you play it.
2424

2525
### Origin
2626

27-
- Download the origin installer
28-
- Run the installer by adding it to steam via the "add a non-steam game" option
29-
- Remember to set "compatability" to a newer proton version
27+
- Download the Origin installer
28+
- Run the installer by adding it to Steam via the "add a non-Steam game" option
29+
- Remember to set "compatibility" to a newer Proton version
3030
- After the install, BoilR can find and add the games
3131
- Validate that the found games have the correct Proton version

0 commit comments

Comments
 (0)