generate-custom-collections.sh

# TODO: add more games
# format:
# [custom-collection]:"game1;game2;case-insensitive;supports spaces;etc"
typeset -A GAMES=(
    [artoffighting]="aof;art of fighting;the art of fighting"
    [asterix]="asterix;obelix"
    [contra]="contra;super contra;scontra;probotector"
    [darkstalkers]="darkstalkers;dstlk;vhunt;vsav"
    [earthwormjim]="earthwormjim;earthworm jim"
    [fatalfury]="fatalfury;fatal fury;rbff;fatfur;garou"
    [finalfight]="finalfight;final fight;ffight"
    [jojo]="jojo;jojoba"
    [kof]="kof;king of fighter;the king of fighter"
    [marvelvscapcom]="mvsc;marvelvscapcom;mshvsfa;msh;xmcota;xmvsf;Marvel vs. Capcom;Marvel Superheroes vs.;X-Men vs."
    [megamanx]="megamanx;megaman x;mega man x;SLUS-00561;SLUS-01334;SLUS-01395"
    [metalslug]="metalslug;Metal Slug;mslug"
    [metroid]="metroid;Super Metroid"
    [pokemon]="pokemon;pokémon"
    [powerinstinct]="powerinstinct;powerins;pwrinst;groovef;Power Instinct"
    [romhacks]="romhacks;sfiii3an;sfz3mix;Clock Tower Deluxe"
    [samuraishodown]="samuraishodown;samurai shodown;samsho;samsh5"
    # careful not to add just "sonic",
    # because it will pickup "Sonic Wings", and other non-hedgehog games
    [sonic]="sonic the hedgehog;sonic and knuckles;sonic & knuckles"
    [streetfighter]="sf1;sf2;sfii;street fighter;hsf;ssf;sfa;sfz"
    [streetsofrage]="streetsofrage;streets of rage;bare knuckle;mt_srage;mp_sor"
    [supermario]="super mario"
    [tmnt]="tmnt;teenage mutant ninja turtles;"
    [zelda]="zelda;the legend of zelda;legend of zelda;tloz;link's awakening"
)

VALID_EXTENSIONS="zip|ZIP|7z|7Z|chd|CHD|cdi|CDI|gdi|GDI|iso|ISO|cue|CUE|rar|RAR|smc|SMC|sfc|SFC"

COLLECTIONS="$(ls -1 ./)"
COLLECTIONS="${COLLECTIONS}"

ES_COLLECTIONS_PATH="$HOME/.emulationstation/collections"

INSTALLED_SYSTEMS="$(ls -1 /opt/retropie/configs)"
INSTALLED_SYSTEMS="${INSTALLED_SYSTEMS/all/}"
ROMS_PATH="$HOME/RetroPie/roms"

shopt -s nocasematch

force_delete=false
list_only=false
collection_name=false
while getopts ':fln:' OPTION; do
    case "$OPTION" in
        f) echo "FORCE DELETE: on"
            force_delete=true ;;
        l) echo "List supported custom collections"
            rm "./SUPPORTED_CUSTOM_COLLECTIONS.txt"
            list_only=true ;;
        n)
            collection_name=$OPTARG ;;
        ?) echo "Script usage: .bin/$(basename $0) -[f][l][n <name>]" >&2
            exit 1 ;;
    esac
done

if ! [[ $collection_name == false ]]; then
    if ! [[ -v $GAMES[$collection_name] ]]; then
        echo "Found: $collection_name"
        collection_games="${GAMES[$collection_name]}"
        GAMES=(["$collection_name"]="$collection_games")
    fi
fi

for collection in "${!GAMES[@]}"; do
    IFS=';'
    filenames="${GAMES[$collection]}"
    filenames=($filenames)
    unset IFS
    collected=()
    name="custom-${collection}.cfg"

    if $list_only; then
        echo "$collection"
        collected+=($collection)
        printf "%s\n" "${collection}" >> "./SUPPORTED_CUSTOM_COLLECTIONS.txt"
        continue
    fi

    if $force_delete; then
        if [[ -f "${ES_COLLECTIONS_PATH}/${name}" ]]; then
            echo "Deleting file $name"
            rm -r "${ES_COLLECTIONS_PATH}/${name}"
        fi
    fi

    echo "Scanning collection: $collection"

    if [[ -f "${ES_COLLECTIONS_PATH}/${name}" ]]; then
        echo "SKIPPING $collection: Custom collection $name already exists."
        echo "-----------------"
        continue
    fi

    for filename in "${filenames[@]}"; do
        IFS=$'\n'
        filename="${filename}"

        for system in $INSTALLED_SYSTEMS; do
            if ! [[ -d $ROMS_PATH/${system} ]]; then
                continue
            fi

            results="$(ls -1 $ROMS_PATH/${system})"

            for file in $results; do
                if [[ $file = $filename* ]]; then
                    if ! [[ $file =~ .*\.($VALID_EXTENSIONS)$ ]]; then
                        echo "✘ SKIPPING: Unknown file extension for $file";
                        continue
                    fi

                    echo "✓ FOUND MATCH: [$system] $ROMS_PATH/${system}/$file"
                    file=$ROMS_PATH/${system}/$file

                    if ! [[ -f $file ]]; then
                        continue
                    fi

                    collected+=($file)
                fi
            done
        done
        unset IFS
    done


    if ! [ -z "$collected" ]; then
        echo "Adding entries to $ES_COLLECTIONS_PATH/$name"
        printf "%s\n" "${collected[@]}" > "$ES_COLLECTIONS_PATH/$name"
    else
        echo "No games collected for $collection"
    fi
    echo "-----------------"
done

echo "
Done."