Retrodeck support

.github/workflows/release.yml

@@ -140,19 +140,21 @@ jobs:
         env:
           GROUT_VERSION: ${{ needs.prepare.outputs.version }}
 
-      - name: Package Batocera AMD64
-        run: task package:batocera-amd64
+      - name: Package AMD64 platforms
+        run: task package:batocera-amd64 package:retrodeck
 
       - name: Create distribution
         run: |
           cd dist/Batocera-amd64 && zip -r ../Grout-Batocera-amd64.zip Grout.sh Grout
+          cd dist/RetroDECK && zip -r ../Grout-RetroDECK.zip Grout.sh Grout
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
           name: amd64-artifacts
           path: |
             dist/Grout-Batocera-amd64.zip
+            dist/Grout-RetroDECK.zip
 
   build-x86:
     needs: prepare
@@ -306,6 +308,7 @@ jobs:
             **/Grout-Batocera-arm64.zip
             **/Grout-Batocera-x86.zip
             **/Grout-Batocera-amd64.zip
+            **/Grout-RetroDECK.zip
             **/grout
           draft: false
           prerelease: ${{ inputs.beta }}
@@ -383,6 +386,7 @@ jobs:
             "Grout-Batocera-arm64.zip"
             "Grout-Batocera-amd64.zip"
             "Grout-Batocera-x86.zip"
+            "Grout-RetroDECK.zip"
           )
 
           # Build the assets JSON object

cache/manager.go

@@ -2,6 +2,7 @@ package cache
 
 import (
 	"database/sql"
+	"grout/internal/appdir"
 	"grout/internal/fileutil"
 	"grout/romm"
 	"os"
@@ -446,27 +447,15 @@ func (cm *Manager) SyncPlatformGames(platforms []romm.Platform) (int, error) {
 }
 
 func getCacheDBPath() string {
-	wd, err := os.Getwd()
-	if err != nil {
-		return filepath.Join(os.TempDir(), ".cache", "grout.db")
-	}
-	return filepath.Join(wd, ".cache", "grout.db")
+	return filepath.Join(appdir.CacheDir(), "grout.db")
 }
 
 func GetArtworkCacheDir() string {
-	wd, err := os.Getwd()
-	if err != nil {
-		return filepath.Join(os.TempDir(), ".cache", "artwork")
-	}
-	return filepath.Join(wd, ".cache", "artwork")
+	return filepath.Join(appdir.CacheDir(), "artwork")
 }
 
 func GetCacheDir() string {
-	wd, err := os.Getwd()
-	if err != nil {
-		return filepath.Join(os.TempDir(), ".cache")
-	}
-	return filepath.Join(wd, ".cache")
+	return appdir.CacheDir()
 }
 
 // DeleteCacheFolder removes the entire cache directory and resets the singleton

cfw/cfw.go

@@ -9,36 +9,37 @@ import (
 type CFW string
 
 const (
-	NextUI   CFW = "NEXTUI"
-	MuOS     CFW = "MUOS"
-	Knulli   CFW = "KNULLI"
-	Spruce   CFW = "SPRUCE"
-	ROCKNIX  CFW = "ROCKNIX"
-	Trimui   CFW = "TRIMUI"
-	Allium   CFW = "ALLIUM"
-	Onion    CFW = "ONION"
-	Koriki   CFW = "KORIKI"
-	Batocera CFW = "BATOCERA"
-	MinUI    CFW = "MINUI"
+	NextUI    CFW = "NEXTUI"
+	MuOS      CFW = "MUOS"
+	Knulli    CFW = "KNULLI"
+	Spruce    CFW = "SPRUCE"
+	ROCKNIX   CFW = "ROCKNIX"
+	Trimui    CFW = "TRIMUI"
+	Allium    CFW = "ALLIUM"
+	Onion     CFW = "ONION"
+	Koriki    CFW = "KORIKI"
+	Batocera  CFW = "BATOCERA"
+	MinUI     CFW = "MINUI"
+	RetroDECK CFW = "RETRODECK"
 )
 
 func GetCFW() CFW {
 	cfwEnv := strings.ToUpper(os.Getenv("CFW"))
 	cfw := CFW(cfwEnv)
 
 	switch cfw {
-	case MuOS, NextUI, Knulli, Spruce, ROCKNIX, Trimui, Allium, Onion, Koriki, Batocera, MinUI:
+	case MuOS, NextUI, Knulli, Spruce, ROCKNIX, Trimui, Allium, Onion, Koriki, Batocera, MinUI, RetroDECK:
 		return cfw
 	default:
 		log.SetOutput(os.Stderr)
-		log.Fatalf("Unsupported CFW: '%s'. Valid options: NextUI, muOS, Knulli, Spruce, ROCKNIX, Trimui, Allium, Onion, Koriki, Batocera, MinUI", cfwEnv)
+		log.Fatalf("Unsupported CFW: '%s'. Valid options: NextUI, muOS, Knulli, Spruce, ROCKNIX, Trimui, Allium, Onion, Koriki, Batocera, MinUI, RetroDECK", cfwEnv)
 		return ""
 	}
 }
 
 func (c CFW) IsBasedOnEmulationStation() bool {
 	switch c {
-	case Knulli, ROCKNIX, Batocera:
+	case Knulli, ROCKNIX, Batocera, RetroDECK:
 		return true
 	default:
 		return false

cfw/directories.go

@@ -9,6 +9,7 @@ import (
 	"grout/cfw/muos"
 	"grout/cfw/nextui"
 	"grout/cfw/onion"
+	"grout/cfw/retrodeck"
 	"grout/cfw/rocknix"
 	"grout/cfw/spruce"
 	"grout/cfw/trimui"
@@ -40,6 +41,8 @@ func GetRomDirectory() string {
 		return batocera.GetRomDirectory()
 	case MinUI:
 		return minui.GetRomDirectory()
+	case RetroDECK:
+		return retrodeck.GetRomDirectory()
 	}
 	return ""
 }
@@ -81,6 +84,8 @@ func GetBIOSDirectory() string {
 		return batocera.GetBIOSDirectory()
 	case MinUI:
 		return minui.GetBIOSDirectory()
+	case RetroDECK:
+		return retrodeck.GetBIOSDirectory()
 	}
 	return ""
 }
@@ -132,6 +137,8 @@ func GetArtDirectory(romDir string, platformFSSlug, platformName string) string
 		return batocera.GetArtDirectory(romDir)
 	case MinUI:
 		return minui.GetArtDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetArtDirectory(romDir)
 	default:
 		return ""
 	}
@@ -180,6 +187,8 @@ func BaseSavePath() string {
 		return batocera.GetBaseSavePath()
 	case MinUI:
 		return minui.GetBaseSavePath()
+	case RetroDECK:
+		return retrodeck.GetBaseSavePath()
 	}
 	return ""
 }
@@ -192,6 +201,8 @@ func GetArtMarqueeDirectory(romDir string, platformFSSlug, platformName string)
 		return knulli.GetArtDirectory(romDir)
 	case Batocera:
 		return batocera.GetArtDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetArtDirectory(romDir)
 	default:
 		return ""
 	}
@@ -205,6 +216,8 @@ func GetArtVideoDirectory(romDir string, platformFSSlug, platformName string) st
 		return knulli.GetVideoDirectory(romDir)
 	case Batocera:
 		return batocera.GetVideoDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetVideoDirectory(romDir)
 	default:
 		return ""
 
@@ -219,6 +232,8 @@ func GetArtThumbnailDirectory(romDir string, platformFSSlug, platformName string
 		return knulli.GetArtDirectory(romDir)
 	case Batocera:
 		return knulli.GetArtDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetArtDirectory(romDir)
 	default:
 		return ""
 	}
@@ -232,6 +247,8 @@ func GetArtBezelDirectory(romDir string, platformFSSlug, platformName string) st
 		return knulli.GetBezelDirectory(romDir)
 	case Batocera:
 		return batocera.GetBezelDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetBezelDirectory(romDir)
 	default:
 		return ""
 	}
@@ -245,6 +262,8 @@ func GetManualDirectory(romDir string, platformFSSlug, platformName string) stri
 		return knulli.GetManualDirectory(romDir)
 	case Batocera:
 		return batocera.GetManualDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetManualDirectory(romDir)
 	default:
 		return ""
 	}
@@ -258,6 +277,8 @@ func GetBoxbackDirectory(romDir string, platformFSSlug, platformName string) str
 		return knulli.GetArtDirectory(romDir)
 	case Batocera:
 		return batocera.GetArtDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetArtDirectory(romDir)
 	default:
 		return ""
 	}
@@ -271,6 +292,8 @@ func GetFanartDirectory(romDir string, platformFSSlug, platformName string) stri
 		return knulli.GetArtDirectory(romDir)
 	case Batocera:
 		return batocera.GetArtDirectory(romDir)
+	case RetroDECK:
+		return retrodeck.GetArtDirectory(romDir)
 	default:
 		return ""
 	}

cfw/metadata.go

@@ -4,6 +4,7 @@ import (
 	"grout/cfw/batocera"
 	"grout/cfw/knulli"
 	"grout/cfw/muos"
+	"grout/cfw/retrodeck"
 	"grout/cfw/rocknix"
 	"grout/internal/emulationstation"
 	"grout/internal/gamelist"
@@ -36,12 +37,21 @@ func FillGamesMetadata(entries []gamelist.RomGameEntry) {
 	logger := gaba.GetLogger()
 	switch GetCFW() {
 	case Knulli, ROCKNIX, Batocera:
-		if err := gamelist.AddRomGamesToGamelist(entries, gamelist.GameListFileName); err != nil {
+		if err := gamelist.AddRomGamesToGamelist(entries, gamelist.GameListFileName, nil); err != nil {
 			logger.Warn("Failed to add games to ES gamelist.xml", "error", err)
 		}
 		scheduleESRestart()
+	case RetroDECK:
+		options := &gamelist.AddRomGamesToGamelistOptions{
+			PathResolver: func(entry gamelist.RomGameEntry, filename gamelist.FileName) string {
+				return retrodeck.GetGamelistPath(entry.RomDirectory, string(filename))
+			},
+		}
+		if err := gamelist.AddRomGamesToGamelist(entries, gamelist.GameListFileName, options); err != nil {
+			logger.Warn("Failed to add games to ES gamelist.xml", "error", err)
+		}
 	case Spruce, Allium, Onion, Koriki:
-		if err := gamelist.AddRomGamesToGamelist(entries, gamelist.MiyooGameListFileName); err != nil {
+		if err := gamelist.AddRomGamesToGamelist(entries, gamelist.MiyooGameListFileName, nil); err != nil {
 			logger.Warn("Failed to add games to miyoogamelist.xml", "error", err)
 		}
 	case MuOS:

cfw/platforms.go

@@ -9,6 +9,7 @@ import (
 	"grout/cfw/muos"
 	"grout/cfw/nextui"
 	"grout/cfw/onion"
+	"grout/cfw/retrodeck"
 	"grout/cfw/rocknix"
 	"grout/cfw/spruce"
 	"grout/cfw/trimui"
@@ -33,6 +34,7 @@ func buildPlatformAliasMap() map[string][]string {
 		koriki.Platforms,
 		batocera.Platforms,
 		minui.Platforms,
+		retrodeck.Platforms,
 	}
 
 	// Build reverse map: primary folder -> list of RomM slugs that use it as primary
@@ -138,6 +140,8 @@ func GetPlatformMap(c CFW) map[string][]string {
 		return batocera.Platforms
 	case MinUI:
 		return minui.Platforms
+	case RetroDECK:
+		return retrodeck.Platforms
 	default:
 		return nil
 	}

cfw/retrodeck/config.go

@@ -0,0 +1,47 @@
+package retrodeck
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+)
+
+const configPathEnv = "RETRODECK_CFG"
+
+// Paths holds the subset of RetroDECK path configuration relevant to Grout.
+type Paths struct {
+	RDHomePath          string `json:"rd_home_path"`
+	RomsPath            string `json:"roms_path"`
+	SavesPath           string `json:"saves_path"`
+	BiosPath            string `json:"bios_path"`
+	DownloadedMediaPath string `json:"downloaded_media_path"`
+	VideosPath          string `json:"videos_path"`
+}
+
+type retrodeckConfig struct {
+	Paths Paths `json:"paths"`
+}
+
+// LoadConfig reads the RetroDECK config file from the path set in RETRODECK_CFG.
+func LoadConfig() (*Paths, error) {
+	cfgPath := os.Getenv(configPathEnv)
+	if cfgPath == "" {
+		return nil, fmt.Errorf("%s environment variable not set", configPathEnv)
+	}
+	return ParseConfig(cfgPath)
+}
+
+// ParseConfig reads and parses the RetroDECK config file at the given path.
+func ParseConfig(path string) (*Paths, error) {
+	data, err := os.ReadFile(path)
+	if err != nil {
+		return nil, fmt.Errorf("reading retrodeck config: %w", err)
+	}
+
+	var cfg retrodeckConfig
+	if err := json.Unmarshal(data, &cfg); err != nil {
+		return nil, fmt.Errorf("parsing retrodeck config: %w", err)
+	}
+
+	return &cfg.Paths, nil
+}