Skip to content

Latest commit

 

History

History
87 lines (71 loc) · 2.89 KB

README.org

File metadata and controls

87 lines (71 loc) · 2.89 KB
Raw

About

Pegasus Skyscraper is a game scraper and metadata generator for the Pegasus-frontend written in Bash.

Pegasus-frontend + Skyscraper = Pegasus Skyscraper

Screenscraper is used as the default scraper.

Showcase

Requirements

  • skyscraper-git AUR / github
    • Arch
      • sudo yay -S skyscraper-git
  • pegasus-frontend-git AUR / github
    • Arch
      • sudo yay -S pegasus-frontend-git
  • wget or curl (only for installation)
    • Debian
      • sudo apt install wget
      • sudo apt install curl
    • Arch
      • sudo pacman -S wget
      • sudo pacman -S curl
  • sed
    • Debian
      • sudo apt install sed
    • Arch
      • sudo pacman -S sed

Installation

  • Using wget
wget https://raw.githubusercontent.com/AfzGit/pegasus-skyscraper/main/pgsk
chmod a+x pgsk
sudo mv pgsk /usr/bin/
  • Using curl
curl https://raw.githubusercontent.com/AfzGit/pegasus-skyscraper/main/pgsk --output pgsk
chmod a+x pgsk
sudo mv pgsk /usr/bin/

Usage

pgsk [DIRECTORY] [PLATFORM] [COMMAND]

[DIRECTORY] = Location of the games folder (like ~/Games/PS2)

[PLATFORM] = name of the console/platform (always lowercase, like ps2)

“[COMMAND]” = Optional command to execute when game is selected in pegasus-frontend, needs to be in quotes (like “pcsx2-qt {file.path}”)

  • Notes:
    • The media folder and the metadata file are both stored in [DIRECTORY]. Add the metadata file in pegasus-frontend for media and games to be detected.
    • The “[COMMAND]” will be stored in ~/.config/pgsk/commands.txt and will execute automatically the next time for the same [PLATFORM].
    • View supported platform by writing pgsk -p

Examples

Example 1:

Fetching media for a GBA game:

pgsk ~/Games/GBA/ gba

stores media and metadata in “~/Games/GBA/”

Example 2:

Fetching media for a WII game and setting a command:

pgsk ~/Games/WII/ wii "dolphin-emu {file.path}"

stores media and metadata in “~/Games/WII/” also sets the command to execute when selected in pegasus. Once set, these commands are stored in “~/.config/pgsk/commands.txt” and will be called automatically next time without the [COMMAND] argument for wii.

Example 3:

It is recommended to drop all your commands in the config file:

~/config/pgsk/commands.txt (Check config sample here)

gba:mgba-qt -f {file.path}

then use pgsk and it will detect the command automatically and set it.

pgsk ~/Games/GBA/ gba