Batocera

https://wiki.batocera.org/
Admin
Batocera is a free and open-source Linux operating system for retro gaming that runs hundreds of...
Tokens:848,594
Snippets:6,240
Trust Score:9.7
Update:7 hours ago
Show doc for...
Tokens:
Raw
### Install the nes-alter-ego package

Source: https://wiki.batocera.org/create_pacman_package

Example command to install the nes-alter-ego package created in the example workflow.

```bash
pacman -U /userdata/system/package/nes-alter-ego-1.0.0-1-any.pkg.tar.zst
```

--------------------------------

### Create start script with nano

Source: https://wiki.batocera.org/systems:bottles

Use this command via SSH/Xterm to create the start script file for the game in /userdata/roms/bottles. Replace <myGame> with the game's name.

```bash
nano /userdata/roms/bottles/<myGame>.sh
```

--------------------------------

### Example output from hcitool dev and bluetoothctl

Source: https://wiki.batocera.org/bluetooth_controllers_-_manual_setup

Shows the output of `hcitool dev` listing adapters and the subsequent `bluetoothctl` session starting a scan on the selected adapter.

```text
# hcitool dev
Devices:
    hci1    90:80:62:00:88:00
    hci0    DC:A6:32:04:10:7F

# bluetoothctl
Agent registered
[bluetooth]# scan on
Discovery started
[CHG] Controller 90:80:62:00:88:00 Discovering: yes
```

--------------------------------

### Make start script executable

Source: https://wiki.batocera.org/systems:bottles

Run this command to make the game's start script executable. Replace <myGame> with the game name (avoid spaces if possible).

```bash
chmod +x /userdata/roms/bottles/<myGame>.sh
```

--------------------------------

### Install Flatpak package from local folder

Source: https://wiki.batocera.org/systems:flatpak

Move the package folder to roms/flatpak/ and run flatpak install with the package name. Example uses emby-theater-snap_3.0.15_amd64.snap.

```bash
flatpak install emby-theater-snap_3.0.15_amd64.snap
```

--------------------------------

### Install a package with pacman -S

Source: https://wiki.batocera.org/pacman_package_manager

Installs or upgrades a package. The example installs `nes-alter-ego`; the output shows dependency resolution, download/install sizes, confirmation prompt, and post-transaction hooks. After installation, the game is added to EmulationStation and appears in the gamelist.

```bash
 # pacman -S nes-alter-ego
 resolving dependencies...
 looking for conflicting packages...
 Packages (1) nes-alter-ego-1.0.0-1
 Total Download Size:   0.40 MiB
 Total Installed Size:  0.49 MiB
 :: Proceed with installation? [Y/n] 
 (1/1) checking keys in keyring                      [----------------------------------------------] 100%
 (1/1) checking package integrity                    [----------------------------------------------] 100%
 (1/1) loading package files                         [----------------------------------------------] 100%
 (1/1) checking for file conflicts                   [----------------------------------------------] 100%
 (1/1) checking available disk space                 [----------------------------------------------] 100%
 (1/1) reinstalling nes-alter-ego                    [----------------------------------------------] 100%
 :: Running post-transaction hooks...
 (1/1) batocera-install.hook
 Entry for Alter_Ego.nes added in /userdata/roms/nes/gamelist.xml
```

--------------------------------

### Install package from repository with pacman -S

Source: https://wiki.batocera.org/pacman_package_manager

Installs a package from a configured repository. The example installs 'nes-alter-ego' from the Batocera repository.

```bash
pacman -S nes-alter-ego
```

--------------------------------

### Create device name file with example device name

Source: https://wiki.batocera.org/diy-arcade-controls

Example using the device name from the earlier ls command. Replace with your actual device name.

```bash
touch /usr/share/batocera/datainit/system/configs/xarcade2jstick/usb-Ultimarc_IPAC_2_Ultimarc_IPAC_2_9-if01-event-kbd
```

--------------------------------

### Symlink start script to ports folder

Source: https://wiki.batocera.org/systems:bottles

Run this command to create a symlink from the start script to the /userdata/roms/ports folder. Replace <myGame> with the game name (avoid spaces if possible).

```bash
ln -s /userdata/roms/bottles/<myGame>.sh /userdata/roms/ports/<myGame>.sh
```

--------------------------------

### Output of ledspicerd -l

Source: https://wiki.batocera.org/ledspicer

Example output from the command. Shows configuration loading, device initialization, and a prompt to select an LED for testing.

```text
Set interval to 33ms
Setting FPS to 30
Reading /userdata/system/configs/ledspicer/basicColors.xml
Loading library /usr/lib/ledspicer/devices/UltimarcUltimate.so
Opening USB session
Processing Ultimarc Ipac Ultimate IO Id: 1
Ultimarc Ipac Ultimate IO Id: 1 with 96 LEDs divided into 23 elements
LED 31 is not set for Ultimarc Ipac Ultimate IO Id: 1
LED 32 is not set for Ultimarc Ipac Ultimate IO Id: 1
LED 33 is not set for Ultimarc Ipac Ultimate IO Id: 1
...
Initializing Device Ultimarc Ipac Ultimate IO Id: 1
Connecting to 0xd209:0x410 Id: 1
Detecting interface
No Game Controller mode detected
Claiming interface 2
Dropping privileges to user id 1000 and group id 1000
Privileges dropped
Reading /userdata/system/configs/ledspicer/profiles/main.xml
Reading /userdata/system/configs/ledspicer/animations/IdleGradient.xml
Test LEDs (q to quit)

Select a Led (r to reset, q to quit):
```

--------------------------------

### Example dd command for GT King Pro

Source: https://wiki.batocera.org/hardware:gt_king

Concrete example using the image batocera-s922x-gtkinpro-33-20220203.img and internal storage /dev/mmcblk0. Verify the correct eMMC block before running to avoid bricking the device.

```bash
dd if=batocera-s922x-gtkinpro-33-20220203.img of=/dev/mmcblk0 bs=1M && sync
```

--------------------------------

### Example syslinux.cfg file with low resolution video option

Source: https://wiki.batocera.org/batocera-and-crt

Complete example syslinux.cfg file showing the modified APPEND line with 'video=DVI-I-1:640x480ieS'. This file is used to boot Batocera at a lower resolution for CRT displays.

```text
UI menu.c32

TIMEOUT 50
TOTALTIMEOUT 300

SAY Booting Batocera.linux...

MENU CLEAR
MENU TITLE Batocera.linux
MENU SHIFTKEY

LABEL batocera
	MENU LABEL Batocera.linux (^normal)
	MENU DEFAULT
	LINUX /boot/linux
	APPEND label=BATOCERA console=tty3 quiet loglevel=0 vt.global_cursor_default=0 mitigations=off video=DVI-I-1:640x480ieS
	INITRD /boot/initrd.gz

LABEL verbose
	MENU LABEL Batocera.linux (^verbose)
	LINUX /boot/linux
	APPEND label=BATOCERA vt.global_cursor_default=0
	INITRD /boot/initrd.gz
```

--------------------------------

### Bottles start script for a game

Source: https://wiki.batocera.org/systems:bottles

Use this Bash script as the start script for a Bottles game in Batocera. It kills existing Bottles processes, fixes PulseAudio permissions, and launches the game via flatpak with the specified bottle and executable names. Replace <myBottleMainName> and <myBottleExecutableName> with your actual names.

```bash
#!/bin/bash
killall -9 bottles
chown -R root:audio /var/run/pulse
chmod -R g+rwX /var/run/pulse
su - batocera -c "DISPLAY=:0.0 flatpak run --command=bottles-cli com.usebottles.bottles run -b '<myBottleMainName>' -p '<myBottleExecutableName>' --args-replace"
```

--------------------------------

### Run keyboardToPadsLauncher for troubleshooting

Source: https://wiki.batocera.org/diy-arcade-controls

Run `keyboardToPadsLauncher /dev/input/event3 run` to troubleshoot keyboardToPads errors. Replace the event number with your setup.

```bash
keyboardToPadsLauncher /dev/input/event3 run
```

--------------------------------

### Enable and start LEDSpicer service via command line

Source: https://wiki.batocera.org/ledspicer

Run these commands to enable and start the LEDSpicer service from the command line. A restart is not needed after using these commands.

```bash
batocera-services enable ledspicer
batocera-services start ledspicer
```

--------------------------------

### Install local package with pacman -U

Source: https://wiki.batocera.org/pacman_package_manager

Installs or upgrades a local package in .tar.xz format without needing a repository setup.

```bash
 pacman -U mypackage-1.0.0-1.tar.xz
```

--------------------------------

### BATOEXEC exec basic example

Source: https://wiki.batocera.org/create_pacman_package

Executes a command every time the package is installed, upgraded, or uninstalled. Uses /bin/bash as the interpreter; note that pipes are unsupported and any stdout output will be shown.

```text
exec = /bin/bash
echo "You have successfully run a command in a script of a package!"
```

--------------------------------

### Game-Start Script (ledspicer.sh)

Source: https://wiki.batocera.org/ledspicer

Loads a profile when a game starts. Uses the rom path and name to determine the system, and checks colors.ini for an arcade override. Must be executable.

```bash
#!/usr/bin/env bash
 
romPath="${1}"
romName="${2}"
 
system=$(echo "$romPath" | awk -F'/roms/' '{print $2}' | cut -d'/' -f1)
 
if grep -q "\\[$romName\\]" /userdata/system/configs/ledspicer/colors.ini;
  then system="arcade"; 
fi
 
emitter -r LoadProfileByEmulator "$romName" "$system"
```

--------------------------------

### Create .keys file to map hotkeys to quit bottle games

Source: https://wiki.batocera.org/systems:bottles

Use this to map hotkey-combo keys to quit a bottle game. Execute the nano command to create a .keys file for the game, then paste the JSON content to bind the hotkey and start buttons to kill the bottles process.

```bash
nano /userdata/roms/ports/<myGame>.sh.keys
```

```json
{
    "actions_player1": [
        {
            "trigger": [
                "hotkey",
                "start"
            ],
            "type": "exec",
            "target": [
            "killall -9 bottles"
            ]
        }
    ]
}
```

--------------------------------

### Example upgrade output

Source: https://wiki.batocera.org/upgrade_manually

Sample output shown after running batocera-upgrade, indicating the download URL and progress.

```text
Starting the upgrade...
url: https://mirrors.o2switch.fr/batocera/x86_64/stable/last/boot.tar.xz
need to download 1876mb
/userdata/system/upgrade/boot.tar.xz     0%[                              ]   9.55M  1.82MB/s    eta 19m 42s
```
Tokens:
Raw