diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt b/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt index 15486c2bdb..b3bdeb9684 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt @@ -22,7 +22,7 @@ object AddedGameArt { } enum class Slot(val key: String, val cacheName: String, val assetType: Int?) { - COVER("p", "p.jpg", 0), BACKGROUND("hero", "hero.jpg", 1), LOGO("logo", "logo.png", 2), ICON("icon", "icon.png", null), + COVER("p", "p.jpg", 0), WIDE("header", "header.jpg", 3), BACKGROUND("hero", "hero.jpg", 1), LOGO("logo", "logo.png", 2), ICON("icon", "icon.png", null), } const val FOLDER = "folder" @@ -40,7 +40,7 @@ object AddedGameArt { class Found(val items: List, val status: SteamGridDb.Status) - private val CHOSEN = Regex("""chosen-(p|hero|logo|icon)(?:-\d+)?\.(\w+)""") + private val CHOSEN = Regex("""chosen-(p|header|hero|logo|icon)(?:-\d+)?\.(\w+)""") internal fun chosen(cache: File, slot: Slot): File? = cache.listFiles { f -> CHOSEN.matchEntire(f.name)?.groupValues?.get(1) == slot.key }?.maxWithOrNull(compareBy({ it.lastModified() }, { it.name })) @@ -79,7 +79,7 @@ object AddedGameArt { fun cached(name: String) = File(cache, name).takeIf { it.isFile } return Art( portrait = chosen(cache, Slot.COVER) ?: own.portrait ?: cached("p.jpg") ?: exeArt(context, game, cover = true), - header = own.header ?: cached("header.jpg") ?: exeArt(context, game, cover = false), + header = chosen(cache, Slot.WIDE) ?: own.header ?: cached("header.jpg") ?: exeArt(context, game, cover = false), hero = chosen(cache, Slot.BACKGROUND) ?: own.hero ?: cached("hero.jpg"), logo = chosen(cache, Slot.LOGO) ?: own.logo ?: cached("logo.png"), icon = chosen(cache, Slot.ICON) ?: own.icon ?: cached("icon-sgdb.png") ?: exeIcon(context, game), @@ -96,6 +96,7 @@ object AddedGameArt { chosen(cache, slot)?.let { return@map SlotState(slot, it, chosenSource(context, game, slot).first.ifEmpty { FILE }, true) } val auto: Pair? = when (slot) { Slot.COVER -> own.portrait?.let { it to FOLDER } ?: cached("p.jpg") ?: exeArt(context, game, cover = true)?.let { it to EXE } + Slot.WIDE -> own.header?.let { it to FOLDER } ?: cached("header.jpg") ?: exeArt(context, game, cover = false)?.let { it to EXE } Slot.BACKGROUND -> own.hero?.let { it to FOLDER } ?: cached("hero.jpg") Slot.LOGO -> own.logo?.let { it to FOLDER } ?: cached("logo.png") Slot.ICON -> own.icon?.let { it to FOLDER } ?: File(cache, "icon-sgdb.png").takeIf { it.isFile }?.let { it to SGDB } @@ -124,7 +125,7 @@ object AddedGameArt { } internal fun steamOption(steamId: String, slot: Slot): Option? { - val remote = when (slot) { Slot.COVER -> "library_600x900.jpg"; Slot.BACKGROUND -> "library_hero.jpg"; Slot.LOGO -> "logo.png"; Slot.ICON -> null } ?: return null + val remote = when (slot) { Slot.COVER -> "library_600x900.jpg"; Slot.WIDE -> "header.jpg"; Slot.BACKGROUND -> "library_hero.jpg"; Slot.LOGO -> "logo.png"; Slot.ICON -> null } ?: return null val url = "$CDN$steamId/$remote".takeIf { exists(it) } ?: steamAssetUrl(steamId, remote) ?: return null return Option(STEAM, url, url) } diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt index cc4fa50c57..026435799f 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt @@ -43,6 +43,7 @@ object SteamGameArt { } val auto = when (slot) { AddedGameArt.Slot.COVER -> own.art + AddedGameArt.Slot.WIDE -> Library.steamCacheImage(cache, game.appId, listOf("library_header.jpg", "header.jpg")) AddedGameArt.Slot.BACKGROUND -> own.hero AddedGameArt.Slot.ICON -> own.icon AddedGameArt.Slot.LOGO -> Library.steamCacheImage(cache, game.appId, listOf("logo.png")) diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGrid.kt b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGrid.kt index 65391a0750..f3d44659aa 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGrid.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGrid.kt @@ -14,7 +14,7 @@ object SteamGrid { /** Every change to a game's art, here or in a scan, takes this first so two of them never interleave. */ internal val lock = Any() private const val MANIFEST = ".droiddeck-art.json" - private val SUFFIX = mapOf(AddedGameArt.Slot.COVER to "p", AddedGameArt.Slot.BACKGROUND to "_hero", AddedGameArt.Slot.LOGO to "_logo") + private val SUFFIX = mapOf(AddedGameArt.Slot.COVER to "p", AddedGameArt.Slot.WIDE to "", AddedGameArt.Slot.BACKGROUND to "_hero", AddedGameArt.Slot.LOGO to "_logo") private val EXTS = listOf("png", "jpg", "jpeg", "webp") class Target(val artDir: File, val id: Long, val setSource: (AddedGameArt.Slot, String) -> Unit) diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt index 7fd9ad2a29..dec6c24cfb 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt @@ -121,6 +121,7 @@ object SteamGridDb { internal fun path(id: Int, slot: AddedGameArt.Slot): String = when (slot) { AddedGameArt.Slot.COVER -> "grids/game/$id?dimensions=600x900&$QUERY" + AddedGameArt.Slot.WIDE -> "grids/game/$id?dimensions=460x215,920x430&$QUERY" AddedGameArt.Slot.BACKGROUND -> "heroes/game/$id?$QUERY" AddedGameArt.Slot.LOGO -> "logos/game/$id?$QUERY" AddedGameArt.Slot.ICON -> "icons/game/$id?$QUERY" diff --git a/app/src/main/java/com/droiddeck/launcher/ui/AddedGameEditor.kt b/app/src/main/java/com/droiddeck/launcher/ui/AddedGameEditor.kt index bd62536710..1e44f24a51 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/AddedGameEditor.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/AddedGameEditor.kt @@ -68,6 +68,7 @@ import java.io.File private fun AddedGameArt.Slot.shape(): Triple = when (this) { AddedGameArt.Slot.COVER -> Triple(28.dp, 41.dp, 5.dp) + AddedGameArt.Slot.WIDE -> Triple(60.dp, 28.dp, 5.dp) AddedGameArt.Slot.BACKGROUND -> Triple(60.dp, 34.dp, 5.dp) AddedGameArt.Slot.LOGO -> Triple(60.dp, 26.dp, 5.dp) AddedGameArt.Slot.ICON -> Triple(30.dp, 30.dp, 7.dp) @@ -77,6 +78,7 @@ private fun AddedGameArt.Slot.shape(): Triple = when (this) { private fun AddedGameArt.Slot.label(): String = stringResource( when (this) { AddedGameArt.Slot.COVER -> R.string.art_cover + AddedGameArt.Slot.WIDE -> R.string.art_wide_cover AddedGameArt.Slot.BACKGROUND -> R.string.art_background AddedGameArt.Slot.LOGO -> R.string.art_logo AddedGameArt.Slot.ICON -> R.string.art_icon @@ -173,6 +175,25 @@ internal class ArtTarget( @Composable internal fun SteamGameArtEditor( game: com.droiddeck.launcher.frontend.Library.SteamGame, onClose: () -> Unit, onChanged: () -> Unit, +) { + val target = remember(game.appId) { ArtTarget.of(game) } + ArtOnlyEditor(game.name, target, game, { SteamGameArt.describe(it, game) }, onClose, onChanged) +} + +@Composable +internal fun StoreGameArtEditor(folder: String, name: String, onClose: () -> Unit, onChanged: () -> Unit) { + val app = LocalContext.current.applicationContext + var game by remember(folder) { mutableStateOf(null) } + LaunchedEffect(folder) { game = withContext(Dispatchers.IO) { AddedGameEdits.game(app, folder) } } + val g = game + val target = remember(g?.appId) { g?.let { ArtTarget.of(it) } } + ArtOnlyEditor(name, target, g, { c -> g?.let { AddedGameArt.describe(c, it) }.orEmpty() }, onClose, onChanged) +} + +@Composable +private fun ArtOnlyEditor( + name: String, target: ArtTarget?, refresh: Any?, describe: (Context) -> List, + onClose: () -> Unit, onChanged: () -> Unit, ) { val app = LocalContext.current.applicationContext val colors = MaterialTheme.colorScheme @@ -181,12 +202,11 @@ internal fun SteamGameArtEditor( var version by remember { mutableIntStateOf(0) } var arts by remember { mutableStateOf>(emptyList()) } var artSlot by remember { mutableStateOf(null) } - val target = remember(game.appId) { ArtTarget.of(game) } - LaunchedEffect(version, game) { arts = withContext(Dispatchers.IO) { SteamGameArt.describe(app, game) } } + LaunchedEffect(version, refresh) { if (target != null) arts = withContext(Dispatchers.IO) { describe(app) } } val first = remember { FocusRequester() } LaunchedEffect(Unit) { focusWithinFrames({ false }) { first } } - AppDialog(shown, close, "steamArtEditor", wide = false, maxWidth = 460.dp) { - DialogTitleRow(game.name, onClose = close) + AppDialog(shown, close, "artEditor", wide = false, maxWidth = 460.dp) { + DialogTitleRow(name, onClose = close) val maxHeight = (LocalConfiguration.current.screenHeightDp * 0.72f).dp Column( verticalArrangement = Arrangement.spacedBy(6.dp), @@ -195,7 +215,7 @@ internal fun SteamGameArtEditor( Text(stringResource(R.string.edit_artwork), fontSize = 12.sp, color = colors.onSurfaceVariant, modifier = Modifier.padding(start = 4.dp, top = 2.dp)) for (slot in AddedGameArt.Slot.values()) key(slot) { val state = arts.firstOrNull { it.slot == slot } - FieldRow(slot.label(), focus = if (slot == AddedGameArt.Slot.COVER) first else null, onClick = { artSlot = slot }) { + FieldRow(slot.label(), focus = if (slot == AddedGameArt.Slot.COVER) first else null, onClick = { if (target != null) artSlot = slot }) { Row(verticalAlignment = Alignment.CenterVertically, horizontalArrangement = Arrangement.spacedBy(10.dp)) { SlotThumb(slot, state?.file) if (state != null) ValueText(artSourceLabel(state.source), muted = true) else Loading() @@ -204,8 +224,9 @@ internal fun SteamGameArtEditor( } } } + val chosen = target ?: return artSlot?.let { slot -> - ArtChooserDialog(target, slot, arts.firstOrNull { it.slot == slot }, onBack = { artSlot = null }, onCloseAll = { artSlot = null; close() }) { version++; onChanged() } + ArtChooserDialog(chosen, slot, arts.firstOrNull { it.slot == slot }, onBack = { artSlot = null }, onCloseAll = { artSlot = null; close() }) { version++; onChanged() } } } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt b/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt index f9fffcc2c7..bd5af3d08c 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt @@ -155,6 +155,7 @@ private fun GameActions(g: Library.SteamGame, s: FrontEndState, a: FrontEndActio if (!s.shortcutPicker) GameShortcutMenu(g, a) if (!s.shortcutPicker && g.library == Library.ADDED && g.source == Library.ADDED && g.gameFiles != null) EditGameButton { onEdit(g) } else if (!s.shortcutPicker && g.library != Library.ADDED && g.source == Library.SOURCE_STEAM) EditGameButton { GamesDialogState.steamArt = g } + else if (!s.shortcutPicker && g.library == Library.ADDED && g.source != Library.ADDED && g.gameFiles != null) EditGameButton { GamesDialogState.storeArt = g } BusyChip(s) } } @@ -330,6 +331,7 @@ internal object GamesDialogState { var editing by androidx.compose.runtime.mutableStateOf(null) var checking by androidx.compose.runtime.mutableStateOf(null) var steamArt by androidx.compose.runtime.mutableStateOf(null) + var storeArt by androidx.compose.runtime.mutableStateOf(null) var behindEditor: Pair, Int>? = null } @@ -371,6 +373,10 @@ private fun GamesDialogs(a: FrontEndActions, games: List) { st.steamArt?.let { game -> SteamGameArtEditor(games.firstOrNull { it.appId == game.appId && it.library != Library.ADDED } ?: game, onClose = { st.steamArt = null }, onChanged = { a.onSteamGameArtChanged(game.appId) }) } + st.storeArt?.let { game -> + val folder = game.gameFiles?.path + if (folder != null) StoreGameArtEditor(folder, game.name, onClose = { st.storeArt = null }, onChanged = { a.onAddedGamesChanged(listOf(folder)) }) + } st.editing?.let { request -> AddedGameEditor( request, @@ -391,8 +397,8 @@ private fun EditGameButton(onClick: () -> Unit) { val label = stringResource(R.string.common_edit) Box( contentAlignment = Alignment.Center, - modifier = Modifier.paneItem("game:edit").size(40.dp).clip(Shape12) - .background(if (hot) pal.signal.copy(alpha = 0.18f) else colors.surface.copy(alpha = 0.55f)) + modifier = Modifier.paneItem("game:edit").downToFirstTile().size(44.dp).clip(Shape12) + .background(if (hot) pal.signal.copy(alpha = 0.14f) else Color.White.copy(alpha = 0.03f)) .glideBorder(hot, Shape12, pal.signal, pal.line2) .hoverable(src).clickable(interactionSource = src, indication = LocalIndication.current, role = androidx.compose.ui.semantics.Role.Button, onClick = onClick) .controllerConfirm(onClick = onClick) diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index b9932ad223..443ee14ef0 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -2143,6 +2143,7 @@ Other exe… Remove Cover + Wide cover Background Logo Icon diff --git a/app/src/test/java/com/droiddeck/launcher/frontend/AddedGameArtLookupTest.kt b/app/src/test/java/com/droiddeck/launcher/frontend/AddedGameArtLookupTest.kt index 84ec9106d3..1f1e30c816 100644 --- a/app/src/test/java/com/droiddeck/launcher/frontend/AddedGameArtLookupTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/frontend/AddedGameArtLookupTest.kt @@ -168,5 +168,6 @@ class AddedGameArtLookupTest { @Test fun eachSlotAsksItsOwnEndpoint() { assertEquals("heroes/game/5?nsfw=false&humor=false", SteamGridDb.path(5, AddedGameArt.Slot.BACKGROUND)) assertEquals("grids/game/5?dimensions=600x900&nsfw=false&humor=false", SteamGridDb.path(5, AddedGameArt.Slot.COVER)) + assertEquals("grids/game/5?dimensions=460x215,920x430&nsfw=false&humor=false", SteamGridDb.path(5, AddedGameArt.Slot.WIDE)) } } diff --git a/app/src/test/java/com/droiddeck/launcher/frontend/SteamGridTest.kt b/app/src/test/java/com/droiddeck/launcher/frontend/SteamGridTest.kt index ab605d3af6..ce71607ce4 100644 --- a/app/src/test/java/com/droiddeck/launcher/frontend/SteamGridTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/frontend/SteamGridTest.kt @@ -44,6 +44,20 @@ class SteamGridTest { assertFalse(File(grid, "620p.png").exists()) } + @Test fun aWideCoverGoesToTheUnsuffixedGridFileAndComesBackFromSteam() { + File(LinuxRuntime.rootDir(app), "root/.local/share/Steam/userdata/123/config").mkdirs() + val picked = image("wide.png", 14) + assertTrue(SteamGameArt.choose(app, game(), AddedGameArt.Slot.WIDE, AddedGameArt.Option(AddedGameArt.FILE, picked.path, picked.path))) + assertEquals(14L, File(grid, "620.png").length()) + assertFalse(File(grid, "620p.png").exists()) + assertTrue(SteamGameArt.chosenFile(app, 620, AddedGameArt.Slot.WIDE)!!.name.matches(Regex("chosen-header-\\d+\\.png"))) + assertNull(SteamGameArt.chosenFile(app, 620, AddedGameArt.Slot.COVER)) + + File(grid, "620.png").delete() + assertTrue(SteamGrid.sync(app, listOf(target()))) + assertNull(SteamGameArt.chosenFile(app, 620, AddedGameArt.Slot.WIDE)) + } + @Test fun artSetInSteamIsTakenOverAndRemovingItInSteamDropsIt() { File(LinuxRuntime.rootDir(app), "root/.local/share/Steam/userdata/123/config").mkdirs() grid.mkdirs() diff --git a/app/src/test/java/com/droiddeck/launcher/frontend/StoreGameArtTest.kt b/app/src/test/java/com/droiddeck/launcher/frontend/StoreGameArtTest.kt new file mode 100644 index 0000000000..a0e84775d8 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/frontend/StoreGameArtTest.kt @@ -0,0 +1,56 @@ +package com.droiddeck.launcher.frontend + +import com.droiddeck.launcher.session.SessionPrefs +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreGameSidecar +import com.droiddeck.launcher.stores.StoreInstallRoot +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue +import org.junit.Before +import org.junit.Rule +import org.junit.Test +import org.junit.rules.TemporaryFolder +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.annotation.Config +import java.io.File + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [33]) +class StoreGameArtTest { + private val app get() = RuntimeEnvironment.getApplication() + @get:Rule val tmp = TemporaryFolder() + + @Before fun setUp() { + AddedGamesPublisher.now = true + SessionPrefs.setGameStorage(app, SessionPrefs.GAME_STORAGE_OFF, "") + } + + private fun install(store: Store, id: String, title: String): File { + val folder = File(StoreInstallRoot.storeDir(StoreInstallRoot.installRoot(app), store), StoreInstallRoot.folderName(title, id)) + File(folder, "Game.exe").apply { parentFile!!.mkdirs(); writeText("game") } + StoreGameSidecar(store, id, title, "Game.exe").write(folder) + return folder + } + + @Test fun anArtChoiceOnAStoreGameIsKeptShownAndResetsWithoutTouchingItsTitle() { + for ((store, id, title) in listOf(Triple(Store.GOG, "1207658924", "Heroes III"), Triple(Store.EPIC, "abc", "Celeste"), Triple(Store.AMAZON, "amzn1.x", "Yakuza 0"))) { + val folder = install(store, id, title) + val image = File(tmp.root, "$id.png").apply { writeBytes(ByteArray(9) { 1 }) } + val option = AddedGameArt.Option(AddedGameArt.FILE, image.path, image.path) + + assertTrue(AddedGameEdits.setArt(app, folder.path, AddedGameArt.Slot.COVER, option)) + val game = AddedGames.single(app, folder.path)!! + assertEquals(title, game.name) + assertEquals(store.id, game.source) + val shown = Library.addedGame(app, game) + assertEquals(AddedGameArt.chosen(AddedGameArt.cacheDir(app, game), AddedGameArt.Slot.COVER), shown.art) + assertEquals(9L, shown.art?.length()) + + AddedGameEdits.resetArt(app, folder.path, AddedGameArt.Slot.COVER) + assertNull(AddedGameArt.chosen(AddedGameArt.cacheDir(app, game), AddedGameArt.Slot.COVER)) + } + } +} diff --git a/docs/development/added-games.md b/docs/development/added-games.md index 73515e91d1..f577179578 100644 --- a/docs/development/added-games.md +++ b/docs/development/added-games.md @@ -47,7 +47,7 @@ shortcut appid is stored per folder at the first scan and never changes after. The ✎ on a Custom game's page (`AddedGameEditor`) mirrors Steam's Properties for a non-Steam game: Name, Target (ranked exes, "?", Other exe… opening the picker in the -game's folder), Start in (automatic = the exe's folder), Launch options, Artwork (Cover, +game's folder), Start in (automatic = the exe's folder), Launch options, Artwork (Cover, Wide cover, Background, Logo, Icon, each with its thumbnail and source), and Remove (two presses; the files stay; adding it again brings it back). `AddedGameEdits` writes each change through the same shortcut: the listing (`name`, `exe`, `dir`, `launch`, `art`, the stored `appid`) @@ -85,17 +85,17 @@ editor (`SteamGameArtEditor`) with the same rows and the same chooser (Steam's o SteamGridDB's best few, "Search SteamGridDB…", "Pick image…", "Reset to automatic"), shared through `ArtTarget`. A choice is a copy in `files/steam-art//chosen-.` (`SteamGameArt`); `Library.steamGames` shows it in place of the librarycache image, and with a -client running the Cover / Background / Logo is also set in Steam +client running the Cover / Wide cover / Background / Logo is also set in Steam (`SetCustomArtworkForApp` / `ClearCustomArtworkForApp`). Icon is launcher-only. `SteamGrid` keeps both sides in step through the client's grid folder -(`userdata//config/grid`, `p`, `_hero`, `_logo`), for Steam and Custom games alike. +(`userdata//config/grid`, `p`, `` for the wide cover, `_hero`, `_logo`), for Steam and Custom games alike. A choice is written there at once, so it reaches Steam while the client is closed. Every library scan (`Library.launchableGames`) compares the folder with what was last written or read (`grid-` in the game's art folder): a file Steam changed becomes the choice (source Steam), a file removed in Steam drops it, and files the shortcuts writer placed itself (`.droiddeck-art.json`) are not mistaken for choices. A chosen image is stored as -`chosen--