Skip to content

1. Setup

Kaleb edited this page Oct 8, 2024 · 14 revisions

To run this launcher, your Mac must be on at least macOS 13.0 (Ventura).

Download the latest release from the releases page and install the app like you would with any other.

The first time you open the app, you will get an alert saying that your Mac can't check the app for malicious software. This is because I'm a broke university student who can't afford an Apple Developer Program membership. I promise it's safe to open up the app anyways :)

Adding a game

You can add a game by clicking the '+' button in the toolbar. Fill in as much information as you can.

Name

This is just the name of the game that is displayed in the sidebar and the toolbar.

Icon

The app icon that shows in the sidebar. A good source for these is macosicons.com.

Platform

The platform / store of the game. Used to organize the games in the sidebar, as well as automatically generate the launcher command based on the template in the Platforms settings.

Status

The game's status. (i.e. Are you playing it currently? Beaten it? Is it in your backlog? etc.) This is only used as another way to sort the games in the list.


Note: The following options will usually be auto-filled after creating the game. You should only need to edit these if the game's information isn't listed on IGDB

Command

This is the terminal command that will launch your app. Changing this field overrides the automatically generated command on a per-game basis. If you are unfamiliar with terminal commands, you can find a list of templates here. If you need a template for an app that isn't on the list, please let us know and we will do our best to help you figure it out.

Description

This is the description of the game. Pretty self-explanatory.

Genres

This is where you put the genres of your game. You can have as many as you want. Format them with new lines like this:

Action
Adventure
Sci-fi

Header

This is the header image. It'll make the app look a hell of a lot better. Unless you are insane, please use one.

Cover

This is the game's cover art image. It will eventually be used in the planned grid view for games.

Screenshots

A list of screenshots to display below the description in the detail view. Just makes the detail view look nicer.

Developer

The developer of the game. I know you love us, but we are not the devs. Don't put us!

Publisher

The publisher of the game. Hopefully not Activision.

Release Date

The date that the game was released.

IGDB ID

Each game has a unique ID in the IGDB database, which is put here to help identify the correct game for metadata scraping.

Library Management

Changing the sorting method

You can use the dropdown in the toolbar to change the way that the games are sorted in the sidebar. You can also use the ⌘ + <number> keyboard shortcut. There are 4 options:

  1. Platform - Sort games by the platform/store the game is from (Eg. Steam, GOG, Xbox, PlayStation, etc.)
  2. Status - Sort games by your completion status of the game. (Eg. playing, backlog, completed, abandoned, etc.)
  3. Name - Sort games alphabetically by name
  4. Recency - Sort games by when you last played them

Favourite games

You can choose any number of games to mark as your favourites. These games will be sorted alphabetically at the top of the list regardless of the sorting method chosen.

You can do this by right-clicking the game in the sidebar and selecting "Favourite game"

Hide games

If you like to have automatic game detection on but have a few games that you don't want in the list, you can choose to hide those games. Phoenix will remember that you don't want to see that game so it won't add the game back every time you start the app.

You can do this by right-clicking the game in the sidebar and selecting "Hide game"

Unhide games

If you decide you want to unhide a game, you can do so by going to Phoenix > Settings in the menu bar and then selecting the Hidden Games tab. Find the game you want to unhide and click the "Show Game" button next to it in the list.

Delete games

You can delete a game to completely remove all reference to it in Phoenix's memory. A deleted game may be added back if it was detected automatically so if you don't want so see it, either turn off game detection in the "General" tab in settings or hide the game instead.