Scanning Games and Roms - RetroArcher/RetroArcher.bundle Wiki

Scanning games

ℹ️ Note that valid games/roms found will have a short video generated. This video will be placed inside the <plex data folder location>\Plex Media Server\Plug-in Support\Data\com.github.agents.retroarcher.retroarcher directory.

ℹ️ If your start videos are 1080p and 20 seconds in length, they will take approximately 5-6GB per 1000 files.

ℹ️ The length of the video can be adjusted in the plug-in settings within Plex. 20 seconds is enough in my testing for Android clients version 10 and below. If your setup includes Android 11+ or Windows clients a longer amount may be desired. Moonlight-qt may take a while to launch if it is searching for gamepads, see Issue #522.

⚠️ If you move your ROMs after you have already scanned, the entire folder structure must remain exactly the same. Do not move a game from gamecube subfolder to Nintendo Gamecube subfolder and expect everything to work.

⚠️ Note that Plex will start collecting meta-data once the videos are added. The metadata collected can take up a lot of space. Most users will have large rom collections, much larger than a standard movie library. Therefore consider that the metadata folder will grow tremendously. It is recommended to use a separate large SSD for your Plex Data folder only.

⚠️ Verify the encoder selected in the agent settings is compatible with your hardware.

Encoder Comments
h264_nvenc Nvidia Encoder
h264_qsv Intel Quick Sync
h264_videotoolbox Mac
libx264 CPU Encoding
mpeg2_qsv Intel Quick Sync
mpeg2video MPEG-2

  1. Place start videos in <plex data folder location>\Plex Media Server\Plug-ins\RetroArcher.bundle\Contents\Resources\StartVideos
    • Games
      • Can contain game specific start videos
      • There should be a folder named the same as the platform name (Nintendo 64 for example)
      • Video file name must be the same as the rom name except the extension.
      • Only a single file is allowed for the game specific start video.
    • Platforms
      • If no game specific start video is found the script will look for platform specific start videos
      • There should be a folder named the same as the platform name (Nintendo 64 for example)
      • Video file name is not important
      • There can be multiple platform specific videos for each platform. The script will choose a random one if multiple are found.
    • Main
      • If no game specific or platform start video is found the script will look for generic start videos
      • No folders are required in this directory
      • Video file name is not important
      • There can be multiple videos in this directory. The script will choose a random one if multiple are found.
    • Note: Only one video is currently provided with the plugin. There is a repository dedicated to creating and generating these videos, but need help with theme music and artwork creation.
  2. Verify that your rom directory is set in the Plex agent settings.
    • Roms need to be contained within system folders inside the directory you specified.
    • The folder naming convention is forgiving, allowing you to use your folder structure from RetroPie, Batocera, Recalbox, LaunchBox. If a folder isn't being scanned, contact us and let us know.
  3. Run the following commands in command prompt/terminal (these will execute scripts within python)
    • Windows CMD (correct the directory as required)
      cd /d <plex data folder location>\Plex Media Server\Plug-ins\RetroArcher.bundle\Contents\Code\retroarcher
      py -3 retroarcher.py --scan
      
      • run this as a scheduled task if you wish or run manually when you add/remove games/roms
    • Linux Terminal (correct the directory as required)
      sudo apt update
      sudo apt install ffmpeg
      cd <plex data folder location>\Plex Media Server\Plug-ins\RetroArcher.bundle\Contents\Code\retroarcher
      python3 retroarcher.py --scan
      
      • set this up as a cron job if you wish or run manually when you add/remove roms