SaberMage / Alsa-USB

USB audio support for Retropie + EmulationStation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Alsa-USB

Effortless USB audio support for Retropie + EmulationStation

Installation

Download the install script by running:

wget -N https://raw.githubusercontent.com/SaberMage/Alsa-USB/main/install.sh && chmod +x install.sh && bash install.sh
  1. The terminal will clear and show a number of messages as installation proceeds
  2. At the end of installation, you will be prompted to press a key. Your device will then reboot
  3. Alsa-USB is ready to roll!

After installing:

  • Default behavior: USB audio is enabled when connected, onboard audio is enabled when USB disconnects
  • Changes to audio output only occur outside of gameplay
  • Behavior, USB volume, and audio device can all be modified from the Alsa-USB menu, now found under EmulationStation Home->Configs

Note: Alsa-USB is compatible with Naprosnia's RetroPie BGM Player

Screenshot: Retropie Configs Menu Icon Screenshot: Alsa-USB Main Menu Screenshot: Alsa-USB Volume Options Screenshot: Alsa-USB Auto-Switch Menu


Known Issues / Limitations

  • Processes, apps and games must all be restarted in order to switch to/from USB audio. There is no known or anticipated fix for this
  • Because of this, audio device swaps will not occur or trigger any process restarts during gameplay. You must exit to the EmulationStation menu or restart the device for changes to take effect
  • Alsa-USB was tested on a 4GB Raspberry Pi 4B housed in a PiBoy DMG. Two different USB audio devices have been tested thoroughly over the course of development
  • If you have a USB audio device that doesn't jive with Alsa-USB, please let me know! I will do my best to add support for it, if I can.

Manual Installation

  • All files you need are in each directory under /nexus
  • For each directory, there is a file beginning with __ - The text following __ indicates the parent directory path (where commas are slashes)
  • Some directory names have a prefix. The prefix indicates the necessary file operations:
  • A_ is for append - File(s') contents should be inserted into the correspondingly-named and located file
  • S_ is for symlink - File(s) here contain ,, in their names. Before ,, is the filepath for a symlink to be created. After ,, is the linked file
  • (no prefix) - File(s) simply need copied into a directory, overwriting any existing file(s) of the same name(s)

So, to install:

  1. Download the install files by running: sudo mkdir ~/au-install && cd ~/au-install && sudo git clone --depth 1 "https://github.com/SaberMage/Alsa-USB" && sudo rm -rf ./Alsa-USB/.git && sudo chmod 777 -R ./Alsa-USB && cd ./Alsa-USB
  2. Visit the first directory under /nexus
  3. Perform the corresponding file operations
  4. Repeat steps 2 and 3 above for each of the remaining directories under /nexus, until all have been processed
  5. Run cd ~ && sudo rm -rf ./au-install to cleanup the install files
  6. Reboot the device

Menu screenshots are in the works!

About

USB audio support for Retropie + EmulationStation

License:GNU General Public License v3.0


Languages

Language:Shell 100.0%Language:Makefile 0.0%