Getting started

Welcome to the documentation of the Pegasus Frontend! Here you can find information about how to install and configure Pegasus on your device, and further along, about the various customization possibilities. Let's get started!

Installation

Pegasus is available for various devices and operating systems. Currently there are official releases for the following platforms:

You can find the latest releases on pegasus-frontend.org, in the Downloads section. On most platforms, Pegasus is just a single file, which you can extract and run anywhere on your system. If there are additional system requirements, they are mentioned on the download page as well.

For the Android release, you can find some additional notes and guides HERE.

Other platforms

Pegasus can also run on platforms not listed above (it's confirmed working on macOS, for example), but will need to be compiled manually from source code. If you wish to do that, the Build documentation can help you along the way.

Basic navigation

The first time you start Pegasus, you'll be either greeted with a message that says no games have been found, or depending on your system, there might be already games present from other sources (eg. Steam or EmulationStation).

In either way, you can reach the main menu by pressing the ESC key, the "back button" ( / ) on a gamepad, or by dragging out the menu panel from the right edge of the screen with your mouse or finger.

main menu screenshot

You can navigate in the menu (and in the whole program in general) using the arrow keys, the directional buttons, the left stick or your mouse and finger. You can select item by pressing the Enter key, the "select button" ( / ) or simply clicking/pressing on an item.

Controls

For the full list of the default navigation keys and buttons, visit the Controls page.

Configuration

On the Settings screen, you can set some general parameters, like the language of the interface or whether you'd like to run in full screen or windowed mode. You can also change the "theme", the look and feel of the whole program.

Pegasus is a program that can collect your list of games from various sources. You can import your list of games from other, already installed game libraries, like Steam, for which there is built-in support. For others, especially emulators and standalone games, you can use Pegasus' own collection and metadata files, which is documented on the Game collections and metadata files page.

The behaviour of the game searching can be then configured in the Gaming section:

Outside the Settings menu, there's also the Controls screen, where you can configure your gamepad's layout, and a Help screen that shows some information about Pegasus, and contains a link to this documentation site.

Customization

Now that you're done with the basics, you might want to dig deeper into the customization aspect of Pegasus. Here are a few articles you could take a look, if you're interested:

>> Back to the index