Skip to content

Latest commit

 

History

History
112 lines (73 loc) · 4.59 KB

README.md

File metadata and controls

112 lines (73 loc) · 4.59 KB
Raw

Tests Excavator Repo size

Emulators Scoop Bucket

This is a Scoop bucket for emulators. It's focused on Windows emulators and core tooling.

This bucket is curated and not intended to be a catch-all. All emulators in this bucket are maintained, have active development, and have a strong active user-base. For other emulators, games, and other apps, check out scoop-games or other scoop buckets.

Interested in adding something? To add a new emulator, please read the Contributing Guide.

1. (Prerequisite) Installing Scoop

Windows 10 and Windows 11 include PowerShell installed by default. Open the start menu and type PowerShell. You might see both Windows PowerShell and PowerShell 7 (x64), the latter is recommended, but the former works too. Scoop and apps will be installed by default in the user home folder. ~/scoop aka %HOMEDRIVE%%HOMEPATH%\scoop aka C:\Users\<username>\scoop\

Install Scoop by executing the following command in PowerShell (start > PowerShell):

iwr -useb get.scoop.sh | iex

2. Adding Emulators Bucket to Scoop

To use this bucket, you must have scoop installed first. To add this bucket to scoop, run

scoop bucket add emulators https://github.com/borger/scoop-emulators.git

The bucket will be installed at ~/scoop/buckets/emulators/ aka %HOMEDRIVE%%HOMEPATH%\scoop\buckets\emulators\ aka C:\Users\<username>\scoop\buckets\emulators\.

To see what apps are available to install (from all added buckets), run

scoop search

3. Installing Emulators using Scoop

The emulators will be installed at ~/scoop/apps/<app-name>/current. For each installed emulator, the app config and data persist across your installs/updates. This is managed by Scoop. Shortcuts will be automatically created on your start menu.

With the emulators' scoop bucket installed, run

scoop install <app-name>
# examples:
scoop install retroarch
scoop install citra-canary yuzu mesen

Notes on the Install Path

There's no way to specify a custom install folder per installed app in Scoop, there is however an alternative solution. You can create a Junction which creates a link to a custom install location.

To create a symlink, run the command in command prompt (start > cmd). You can also switch to cmd from PowerShell by running cmd. You may need to run cmd as an administrator.

mklink /D "<destination-path>" "%HOMEDRIVE%%HOMEPATH%\scoop\apps\<app-name>\current"

List of Emulators

Each file listed in the bucket folder is an app available to install.

4. Updates

This bucket checks for updates every hour to ensure it stays updated with the latest releases from all our favorite emulators. However, its up to you to run the scoop update commands in order to update.

4a. Updating Scoop and bucket metadata

To update scoop metadata, run

    scoop update

4b. Updating Emulators from the Scoop Bucket

To update all the apps installed via Scoop, run

scoop update *

To update a specific emulator via scoop, run

scoop update <app-name>
# examples:
scoop update retroarch
scoop update citra-canary mesen

4c. Automating Updates

Create a PowerShell script and add it to Windows' Task Scheduler or add multiple "start a program" actions to run daily or in your preferred schedule. The script contents would just be:

scoop update
scoop update *

Credits

  • lukesampson for creating Scoop and the original Retroarch manifest.
  • hermanjustnu for the original scoop-emulator repo.
  • Ash258 for creating the original RPCS3 manifest.
  • Calinou for creating the scoop-games repository.
  • beyondmeat for helping add more emulators to this bucket, fixing various bugs, and maintaining manifests.