Skip to content

Commit

Permalink
docs: more generic wording, better explainations [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
imLinguin committed Jul 11, 2024
1 parent 417ded2 commit 770c537
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/steamdeck/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Using Comet with Valve's Steam Deck (running SteamOS) is possible in both Desktop and Game Mode. Comet will only function with games that do support [GOG Galaxy's achievement system](https://www.gog.com/en/games?features=achievements) or any other online related functionality like Leaderboards. **If your game does not work out of the box, check Known Issues below.**

Using `comet_shortcut.sh` will simplify the process of launching Heroic Games Launcher games with Comet in the background. That script works in both Modes.
Using `comet_shortcut.sh` will simplify the process of launching GOG games from Heroic or Lutris with Comet in the background. That script works in both Modes.

This instruction also applies for desktop users who want to use comet in launchers that do not support comet natively.
This instruction also applies for desktop users. If you don't use any launcher see the project [README](https://github.com/imLinguin/comet#via-gogdl-cli) for manual credentials management.


## Installation steps

1. Make sure you are logged into GOG on your launcher of choice.
2. Download the latest release of Comet from [the latest release](https://github.com/imLinguin/comet/releases/latest) or [the latest GitHub Actions run](https://github.com/imLinguin/comet/actions/workflows/build.yml) labelled `comet-x86_64-unknown-linux-gnu` (a 64bit executable for Linux).
3. Extract the downloaded archive to a desired place.
> It is recommended to have the `comet` binary put into the `~/Documents` directory. Otherwise: choose any directory where Heroic has access to.
> It is recommended to have the `comet` binary put into the `~/Documents` directory. Otherwise: choose any directory where your app of choice has access to.
4. Open the `comet_shortcut.sh` file with Kate (right click on the file > Open with Kate), and edit the following values:
- `gog_username`
> Change the `username` value after `=` to your GOG username. If your name includes any special characters make sure to quote the username accordingly
Expand Down
5 changes: 3 additions & 2 deletions docs/steamdeck/comet_shortcut.sh
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@ path_to_comet='/home/deck/Documents/comet/comet'
# Uncomment if debug logs are wanted to be visible in Comet
#export COMET_LOG=debug
# A timeout after which comet will quit when last client disconnects
export COMET_IDLE_WAIT=5 # 15 seconds is the default
export COMET_IDLE_WAIT=5 # comet has a 15 seconds as the default, we make it shorter here, feel free to tweak it to your liking

# Running Comet as a background app
# If you want to use this script in Lutris change --from-heroic to --from-lutris
exec "$path_to_comet" --from-heroic --username "$gog_username" -q &

# If parameters were provided we are in wrapper mode
# This part allows using this script as a wrapper
# e.g comet_shortcut.sh wine game.exe
if [ $# -ne 0 ]; then
comet_pid=$!
exec "$@" &
Expand Down
6 changes: 3 additions & 3 deletions docs/wiki/steamdeck/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Using Comet with Valve's Steam Deck (running SteamOS) is possible in both Desktop and Game Mode. Comet will only function with games that do support [GOG Galaxy's achievement system](https://www.gog.com/en/games?features=achievements) or any other online related functionality like Leaderboards. **If your game does not work out of the box, check Known Issues below.**

Using `comet_shortcut.sh` will simplify the process of launching Heroic Games Launcher games with Comet in the background. That script works in both Modes.
Using `comet_shortcut.sh` will simplify the process of launching GOG games from Heroic or Lutris with Comet in the background. That script works in both Modes.

This instruction also applies for desktop users who want to use comet in launchers that do not support comet natively.
This instruction also applies for desktop users. If you don't use any launcher see the project [README](https://github.com/imLinguin/comet#via-gogdl-cli) for manual credentials management.


## Installation steps

1. Make sure you are logged into GOG on your launcher of choice.
2. Download the latest release of Comet from [the latest release](https://github.com/imLinguin/comet/releases/latest) or [the latest GitHub Actions run](https://github.com/imLinguin/comet/actions/workflows/build.yml) labelled `comet-x86_64-unknown-linux-gnu` (a 64bit executable for Linux).
3. Extract the downloaded archive to a desired place.
> It is recommended to have the `comet` binary put into the `~/Documents` directory. Otherwise: choose any directory where Heroic has access to.
> It is recommended to have the `comet` binary put into the `~/Documents` directory. Otherwise: choose any directory where your app of choice has access to.
4. Open the `comet_shortcut.sh` file with Kate (right click on the file > Open with Kate), and edit the following values:
- `gog_username`
> Change the `username` value after `=` to your GOG username. If your name includes any special characters make sure to quote the username accordingly
Expand Down

0 comments on commit 770c537

Please sign in to comment.