Skip to content

Itch.io integration plugin

suchmememanyskill edited this page Aug 7, 2022 · 14 revisions

Itch.io Integration Plugin

This wiki page contains some how-to's on common actions performed in relation to the itch.io integration plugin

Logging in

  1. Open Alfae
  2. Click on Plugins in the top right, click on Itch.io Integration in the dropdown menu that appears, then click on Log in
  3. Press on the Take me to the api page link. This will open a browser and take you to the itch.io api keys page
    • Log in on the site if you have not already
  4. Press Generate new API key on the itch.io page. The page will refresh
  5. Press View on this newly generated key, then copy the key. Paste it into Alfae, and press Login

Installing a free game

Free games are not tied to your account, so they won't show up in the application by default.

  1. Open Alfae
  2. Click on Plugins in the top right, click on Itch.io Integration in the dropdown menu that appears, then press Search free games/demos
    • If only the Log in option show, please log in first
  3. Type a search query in the search bar and click Search
  4. Press the Download button to temporairly add the game to your library.
    • The orange link opens the corresponding web page of the game in your default browser
  5. Follow Installing a paid game from step 4 onwards

Installing a paid game

  1. Open Alfae
  2. Log in if you have not already
  3. Search for the game you want to install either by the search bar, or by scrolling trough all your games
    • Tip: Typing itch.io in the search bar will only show itch.io games
  4. Click on a game you wish to install, then press Install
  5. A menu will pop up asking you what to download. Download the game that's right for your platform
    • If a game provides build information, the version of the game is shown like [Version x.x.x]
    • If both a display name and a file name was found, the display name is displayed normally, and the file name is put between brackets ()
  6. Wait until the game is downloaded
  7. Launch the game by selecting the game, then pressing Launch. Refer to the More options on games section for additional information about an installed game's options

Uninstalling an itch.io game

  1. Open Alfae
  2. Click on an installed game, then click on More, then click on Uninstall
  3. Press Uninstall on the popup that pops up

More options on games

When an itch.io game is installed, a More menu appears with a bunch of options. These options are displayed below

  • Launch: Launches the game. May open the Config/Info menu when the game's configuration is invalid
  • Config/Info: Shows a configuration menu. Besides being able to add additional commandline arguments and showing/opening the install location folder, the user can configure the game's boot entry. On install, the game gets scanned for what executables it has. Every executable is put in this boot entry list, so the user can pick the right executable to launch the game. When multiple executables are found, the user is forced to pick an executable
  • View in browser: Opens the game's store page in the user's default browser
  • Uninstall: Deletes the game from the user's machine
  • Set Boot Configuration: Allows the user to pick how the application is launched. This is useful for example, when launching a windows game on linux and you want to select what Proton version (or bottle from bottles) the game is launched in
    • If the Estimated platform is unknown, set a valid boot entry first in the Config/Info menu
  • Played for xx:xx: Shows how long the user has played the game for
    • This is only shown after playing the game at least once

Adding installed itch.io games to Steam

You can add any installed itch.io game, including (cropped) cover art to steam

  1. Open Alfae
  2. Click on Plugins in the top right, click on Steam Exporter in the dropdown menu that appears, then click on Add games to steam
  3. Restart steam to see the changes
Clone this wiki locally