Merge pull request #151 from rommapp/v4.7.0.0

v4.7.0.0

Author: BrandonKowalski

.github/CHANGELOG.md

@@ -1,3 +1,52 @@
+# v4.7.0.0
+
+## New Features
+
+- **Save Sync Rebuilt**: Save Sync has been completely rebuilt from the ground up with device-aware syncing powered by RomM's new save sync API (#135)
+  - **Conflict Resolution**: New conflict resolution screen when both local and remote saves have changed since last sync
+  - **Save Slots**: User-configurable save slots per game, with slot selection during first sync and manageable from the Synced Games screen
+  - **Backup Retention**: Configurable backup retention policy for save files (keep all, last 5, 10, or 15)
+  - **Sync History**: View a chronological log (stored locally) of all sync actions (uploads, downloads) for this device
+  - **Synced Games Browser**: Browse all synced games grouped by platform, view save details, and manage save slots
+  - **Sync Menu**: New dedicated sync menu accessible via `Y` from the main menu
+  - **Device Registration**: Device registration is performed when setting up save sync, can change device name anytime in settings (#134)
+- **Batocera Support**: Preliminary support for Batocera CFW (#157) - @from-nibly
+- **Server Settings Reconfiguration**: Reconfigure server host, port, protocol, and SSL verification without logging out (#146)
+- **Flip Face Buttons**: New setting to swap face buttons (A <-> B, X <-> Y) for devices where the layout doesn't match expectations (#153)
+- **Cache Purging**: Local cache now purges deleted items using RomM's new identifier endpoints, keeping the cache in sync with the server more efficiently (#83)
+- **muOS Jacaranda Icon Support**: Grout icons now display correctly on muOS Jacaranda and prior versions - @pawndev
+
+## Improvements
+
+- **Save Sync Platform Mapping**: Restored save sync platform mapping for manual directory configuration
+- **muOS Splash & Preview Options**: Configuration for downloading screenshot, title, and marquee artwork (#86) - @pawndev
+- **Gamelist.xml Support**: Added miyoogamelist.xml support for Spruce and Allium (#140) - @pawndev
+- **Trimui Stock Save Sync**: Added save directory mappings for Trimui stock OS (#128) - @malkavi
+- Removed state machine from search for cleaner navigation
+- Updated translations across all supported languages (#123)
+
+## Bug Fixes
+
+- Fixed save mapping for muOS NDS
+- Fixed launch scripts and binaries not being executable in zip files (#155)
+- Fixed Spruce launch script - @pawndev
+- Fixed initial device registration flow
+- Fixed Trimui packaging - @malkavi
+
+## Documentation
+
+- Added Anbernic RG34XX as tested on ROCKNIX - @SethBarberee
+- Added Anbernic RG34XXSP to muOS installation guide
+- Added Anbernic RG CUBE to muOS compatibility list
+- Added RGB30 to ROCKNIX installation guide - @pawndev
+- Updated Knulli tested devices
+
+## Contributors
+
+Thanks to @pawndev, @from-nibly, @malkavi, @SethBarberee, and @ivan for their contributions to this release! :heart:
+
+---
+
 # v4.6.1.0
 
 ## New Features

.github/workflows/release.yml

@@ -49,11 +49,11 @@ jobs:
                pak.json > pak.json.tmp && mv pak.json.tmp pak.json
 
             # Update build pak.json (will be copied during build)
-            mkdir -p build/Grout.pak
+            mkdir -p build64/Grout.pak
             jq --arg version "${{ steps.version.outputs.value }}" \
                --arg changelog "${{ inputs.changelog }}" \
                '.version = $version | .changelog[$version] = $changelog' \
-               pak.json > build/Grout.pak/pak.json
+               pak.json > build64/Grout.pak/pak.json
           else
             echo "Version is already ${{ steps.version.outputs.value }}, skipping pak.json update"
           fi
@@ -78,41 +78,49 @@ jobs:
           version: 3.x
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
       - name: Build and Package
-        run: task build extract package-next package-muos package-knulli package-spruce package-rocknix package-trimui
+        run: task build extract package-next package-muos package-knulli package-spruce package-rocknix package-trimui package-batocera
 
       - name: Create NextUI distribution
         run: |
-          cd build/Grout.pak
+          cd build64/Grout.pak
           zip -r ../Grout.pak.zip .
 
       - name: Create muOS distribution
         run: |
-          cd build/muOS
+          cd build64/muOS
           zip -r Grout.muxapp Grout
           mv Grout.muxapp ../Grout.muxapp
 
       - name: Create Knulli distribution
         run: |
-          cd build/Knulli
+          cd build64/Knulli
           zip -r ../Grout-Knulli.zip Grout
 
       - name: Create spruce distribution
         run: |
-          cd build/Spruce
+          cd build64/Spruce
           zip -r Grout.spruce.zip Grout
           mv Grout.spruce.zip ../Grout.spruce.zip
 
       - name: Create ROCKNIX distribution
         run: |
-          cd build/ROCKNIX
+          cd build64/ROCKNIX
           zip -r ../Grout-ROCKNIX.zip Grout.sh Grout
 
       - name: Create Trimui distribution
         run: |
-          cd build/Trimui
+          cd build64/Trimui
           zip -r ../Grout-Trimui.zip Grout
 
+      - name: Create Batocera distribution
+        run: |
+          cd build/Batocera
+          zip -r ../Grout-Batocera.zip Grout.sh Grout
+
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
@@ -125,12 +133,13 @@ jobs:
 
             ${{ inputs.beta && format('Built from branch: `{0}`', github.ref_name) || '' }}
           files: |
-            build/Grout.pak.zip
-            build/Grout.muxapp
-            build/Grout.spruce.zip
-            build/Grout-Knulli.zip
-            build/Grout-ROCKNIX.zip
-            build/Grout-Trimui.zip
-            build/grout
+            build64/Grout.pak.zip
+            build64/Grout.muxapp
+            build64/Grout.spruce.zip
+            build64/Grout-Knulli.zip
+            build64/Grout-ROCKNIX.zip
+            build64/Grout-Trimui.zip
+            build64/Grout-Batocera.zip
+            build64/grout
           draft: false
           prerelease: ${{ inputs.beta }}

.gitignore

@@ -6,12 +6,13 @@
 *.iml
 
 # Build
-build/
+build64/
 build32/
 build-miyoo/
 grout
 app/app
 es_restart_request
+/save-sync-preview
 
 # Local config
 .env
@@ -36,3 +37,6 @@ __pycache__/
 
 # MkDocs build output
 site/
+
+/save_slots.json
+/create-conflict

app/grout.go

@@ -6,8 +6,6 @@ import (
 
 	_ "github.com/BrandonKowalski/certifiable"
 	gaba "github.com/BrandonKowalski/gabagool/v2/pkg/gabagool"
-	"github.com/BrandonKowalski/gabagool/v2/pkg/gabagool/i18n"
-	goi18n "github.com/nicksnyder/go-i18n/v2/i18n"
 )
 
 func main() {
@@ -30,18 +28,6 @@ func main() {
 }
 
 func cleanup() {
-	if currentAppState != nil && currentAppState.AutoSync != nil && currentAppState.AutoSync.IsRunning() {
-		gaba.GetLogger().Info("Waiting for auto-sync to complete before exiting...")
-		gaba.ProcessMessage(
-			i18n.Localize(&goi18n.Message{ID: "auto_sync_waiting", Other: "Waiting for save sync to complete..."}, nil),
-			gaba.ProcessMessageOptions{},
-			func() (interface{}, error) {
-				currentAppState.AutoSync.Wait()
-				return nil, nil
-			},
-		)
-	}
-
 	if err := os.RemoveAll(".tmp"); err != nil {
 		gaba.GetLogger().Error("Failed to clean .tmp directory", "error", err)
 	}

app/helpers.go

@@ -34,12 +34,6 @@ func savePlatformOrder(state *AppState, platforms []romm.Platform) {
 	internal.SaveConfig(state.Config)
 }
 
-func triggerAutoSyncRouter(state *AppState) {
-	if state.AutoSync != nil {
-		state.AutoSync.Trigger()
-	}
-}
-
 func executeDownloadUI(state *AppState, r ui.GameDetailsOutput, stack *router.Stack) {
 	entry := stack.Peek()
 	var allGames []romm.Rom

app/router.go

@@ -5,7 +5,6 @@ import (
 	"grout/cfw"
 	"grout/internal"
 	"grout/romm"
-	"grout/sync"
 	"grout/ui"
 	"grout/update"
 
@@ -38,7 +37,7 @@ func runWithRouter(config *internal.Config, currentCFW cfw.CFW, platforms []romm
 		Platforms:       &state.Platforms,
 		QuitOnBack:      quitOnBack,
 		ShowCollections: showCollections,
-		ShowSaveSync:    computeShowSaveSync(state),
+		ShowSaveSync:    state.Host.DeviceID != "",
 	}
 
 	return r.Run(ScreenPlatformSelection, initialInput)
@@ -81,24 +80,12 @@ func registerScreens(r *router.Router, state *AppState) {
 	r.Register(ScreenPlatformSelection, func(input any) (any, error) {
 		in := input.(ui.PlatformSelectionInput)
 
-		if state.Config.SaveSyncMode == internal.SaveSyncModeAutomatic {
-			state.autoSyncOnce.Do(func() {
-				state.AutoSync = sync.NewAutoSync(state.Host, state.Config)
-				ui.AddStatusBarIcon(state.AutoSync.Icon())
-				state.AutoSync.Start()
-			})
-		}
-
 		state.autoUpdateOnce.Do(func() {
 			state.AutoUpdate = update.NewAutoUpdate(state.CFW, state.Config.ReleaseChannel, &state.Host)
 			ui.AddStatusBarIcon(state.AutoUpdate.Icon())
 			state.AutoUpdate.Start()
 		})
 
-		if in.ShowSaveSync == nil {
-			in.ShowSaveSync = computeShowSaveSync(state)
-		}
-
 		screen := ui.NewPlatformSelectionScreen()
 		return screen.Draw(in)
 	})
@@ -163,11 +150,6 @@ func registerScreens(r *router.Router, state *AppState) {
 		return screen.Draw(input.(ui.PlatformMappingInput))
 	})
 
-	r.Register(ScreenSaveSyncSettings, func(input any) (any, error) {
-		screen := ui.NewSaveSyncSettingsScreen()
-		return screen.Draw(input.(ui.SaveSyncSettingsInput))
-	})
-
 	r.Register(ScreenInfo, func(input any) (any, error) {
 		screen := ui.NewInfoScreen()
 		return screen.Draw(input.(ui.InfoInput))
@@ -185,11 +167,6 @@ func registerScreens(r *router.Router, state *AppState) {
 		return screen.Draw(in)
 	})
 
-	r.Register(ScreenSaveSync, func(input any) (any, error) {
-		screen := ui.NewSaveSyncScreen()
-		return screen.Draw(input.(ui.SaveSyncInput))
-	})
-
 	r.Register(ScreenBIOSDownload, func(input any) (any, error) {
 		in := input.(ui.BIOSDownloadInput)
 		screen := ui.NewBIOSDownloadScreen()
@@ -213,4 +190,47 @@ func registerScreens(r *router.Router, state *AppState) {
 		screen := ui.NewGameFiltersScreen()
 		return screen.Draw(input.(ui.GameFiltersInput))
 	})
+
+	r.Register(ScreenSaveSync, func(input any) (any, error) {
+		in := input.(ui.SaveSyncInput)
+		screen := ui.NewSaveSyncScreen()
+		return screen.Execute(in), nil
+	})
+
+	r.Register(ScreenSaveConflict, func(input any) (any, error) {
+		screen := ui.NewSaveConflictScreen()
+		return screen.Draw(input.(ui.SaveConflictInput))
+	})
+
+	r.Register(ScreenSaveSyncSettings, func(input any) (any, error) {
+		in := input.(ui.SaveSyncSettingsInput)
+		screen := ui.NewSaveSyncSettingsScreen()
+		return screen.Draw(in)
+	})
+
+	r.Register(ScreenSyncMenu, func(input any) (any, error) {
+		screen := ui.NewSyncMenuScreen()
+		return screen.Draw(input.(ui.SyncMenuInput))
+	})
+
+	r.Register(ScreenSyncedGames, func(input any) (any, error) {
+		screen := ui.NewSyncedGamesScreen()
+		return screen.Draw(input.(ui.SyncedGamesInput))
+	})
+
+	r.Register(ScreenSyncHistory, func(input any) (any, error) {
+		screen := ui.NewSyncHistoryScreen()
+		return screen.Draw(input.(ui.SyncHistoryInput))
+	})
+
+	r.Register(ScreenSaveMapping, func(input any) (any, error) {
+		screen := ui.NewSaveMappingScreen()
+		return screen.Draw(input.(ui.SaveMappingInput))
+	})
+
+	r.Register(ScreenServerAddress, func(input any) (any, error) {
+		screen := ui.NewServerAddressScreen()
+		return screen.Draw(input.(ui.ServerAddressInput))
+	})
+
 }

app/screens.go

@@ -21,13 +21,19 @@ const (
 	ScreenCollectionsSettings
 	ScreenAdvancedSettings
 	ScreenPlatformMapping
-	ScreenSaveSyncSettings
 	ScreenInfo
 	ScreenLogoutConfirmation
 	ScreenRebuildCache
-	ScreenSaveSync
 	ScreenBIOSDownload
 	ScreenArtworkSync
 	ScreenUpdateCheck
 	ScreenGameFilters
+	ScreenSaveSync
+	ScreenSaveSyncSettings
+	ScreenSaveConflict
+	ScreenSyncMenu
+	ScreenSyncedGames
+	ScreenSyncHistory
+	ScreenSaveMapping
+	ScreenServerAddress
 )

app/setup.go

@@ -56,6 +56,11 @@ func setup() SetupResult {
 		}
 	}
 
+	// Pre-load config to apply settings that must be set before Init()
+	if preConfig, err := internal.LoadConfig(); err == nil {
+		gaba.SetFlipFaceButtons(preConfig.SwapFaceButtons)
+	}
+
 	gaba.Init(gaba.Options{
 		WindowTitle:          "Grout",
 		PrimaryThemeColorHex: 0x007C77,
@@ -145,6 +150,7 @@ func setup() SetupResult {
 	}
 
 	internal.InitKidMode(config)
+	gaba.SetFlipFaceButtons(config.SwapFaceButtons)
 
 	if internal.IsKidModeEnabled() {
 		splashBytes, _ := resources.GetSplashImageBytes()

app/state.go

@@ -5,7 +5,6 @@ import (
 	"grout/cfw"
 	"grout/internal"
 	"grout/romm"
-	"grout/sync"
 	"grout/update"
 	gosync "sync"
 	"sync/atomic"
@@ -21,24 +20,8 @@ type AppState struct {
 
 	RommVersion atomic.Value // string
 
-	AutoSync   *sync.AutoSync
 	AutoUpdate *update.AutoUpdate
 	CacheSync  *cache.BackgroundSync
 
-	autoSyncOnce   gosync.Once
 	autoUpdateOnce gosync.Once
 }
-
-func computeShowSaveSync(state *AppState) *atomic.Bool {
-	switch state.Config.SaveSyncMode {
-	case internal.SaveSyncModeManual:
-		showSaveSync := &atomic.Bool{}
-		showSaveSync.Store(true)
-		return showSaveSync
-	case internal.SaveSyncModeAutomatic:
-		if state.AutoSync != nil {
-			return state.AutoSync.ShowButton()
-		}
-	}
-	return nil
-}