Skip to content

Commit

Permalink
Improved Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cbartondock committed May 7, 2022
1 parent 8ac67db commit 268274f
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 10 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Before running any scripts, dependencies must be installed using:
npm ci
```

Unfortunately, because of an issue with `better-sqlite3` you will most likely also have to run `npm ci` after building for windows if you want `npm run start` to work. Otherwise, you will likely see the runtime error `better-sqlite3 is not a valid win32 application`.

## Scripts

All script must be run using `npm run` command. For example, `npm run watch:renderer`.
Expand Down
9 changes: 6 additions & 3 deletions src/lang/english/langData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ export const EnglishLang: languageContainer = {
launcherModeInputTitle: 'Launch games via Epic for online services',
docs__md: {
self: [
require('./markdown/epic-parser.md')
require('./markdown/epic-parser.md'),
require('./markdown/epic-parser-input.md')
],
input: [
require('./markdown/epic-parser-input.md')
Expand All @@ -130,7 +131,8 @@ export const EnglishLang: languageContainer = {
launcherModeInputTitle: 'Launch games via UPlay for online services',
docs__md: {
self: [
require('./markdown/uplay-parser.md')
require('./markdown/uplay-parser.md'),
require('./markdown/uplay-parser-input.md')
],
input: [
require('./markdown/uplay-parser-input.md')
Expand All @@ -149,7 +151,8 @@ export const EnglishLang: languageContainer = {
launcherModeInputTitle: 'Launch games via GOG Galaxy',
docs__md: {
self: [
require('./markdown/gog-parser.md')
require('./markdown/gog-parser.md'),
require('./markdown/gog-parser-input.md')
],
input: [
require('./markdown/gog-parser-input.md')
Expand Down
6 changes: 2 additions & 4 deletions src/lang/english/markdown/epic-parser-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Most users shouldn't use this, as they use the standard Epic Games Store install

If, however, for some reason your manifests directory is located in a non-typical location then you can specify the correct manifests directory here.

## Launch Via Epic Games Store
## Launch Via Epic Games Store `[Recommend enabled]`

What it sounds like, this toggle let's you set whether games will launch via the Epic Games Store or directly.

Obviously if you don't launch via the epic games store you will not have access to Epic's online services in game.
What it sounds like, this toggle let's you set whether games will launch via the Epic Games Store or directly. If you don't launch via the epic games store you will not have access to Epic's online services in game.
4 changes: 2 additions & 2 deletions src/lang/english/markdown/gog-parser-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ By default Steam ROM Manager assumes your Galaxy Client is located at `C:\Progra

This field is actually only necessary if you enable launch via GOG Galaxy (see below), as otherwise SRM has no need of the location of the Galaxy Client.

## Launch Via GOG Galaxy
## Launch Via GOG Galaxy `[Recommend disabled]`

What it sounds like, this toggle let's you set whether games will launch via GOG Galaxy or directly. Note that for some games launching from GOG Galaxy may fail, and the steam overlay will most likely not work.
What it sounds like, this toggle let's you set whether games will launch via GOG Galaxy or directly. Note that for some games launching from GOG Galaxy may fail, and the Steam overlay will most likely not work.
4 changes: 3 additions & 1 deletion src/lang/english/markdown/uplay-parser-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
## Ubisoft Directory Override
By default Steam ROM Manager assumes your UPlay install is located in `C:\Program Files (x86)\Ubisoft`. This field allows you to override that path if your UPlay installation is elsewhere.

## Launch Via UPlay
## Launch Via UPlay `[Recommend disabled]`

What it sounds like, this toggle let's you set whether games will launch via UPlay or directly from the game's executable.

For UPlay this doesn't matter too much as UPlay games will automatically launch UPlay in the background even when launched from the executable. Steam Overlay will not work when `Launch via UPlay` is enabled, whereas both Steam and Ubisoft overlays work when `Launch via UPlay` is disabled.

0 comments on commit 268274f

Please sign in to comment.