feat: Adjust a game’s logo position and size in the artwork editors (#1004)

* Add an Adjust logo screen to move and resize a game's logo in Steam

* Report a failed write of the local logo position instead of throwing

* Record a Steam-side logo position change only once it has been taken over here
This commit is contained in:
FX1922 authored and GitHub committed 2026-10-17 10:02:22 -04:00
1 parent dc7ed61d38
commit 77c3fd323e
11 files changed
+529

No files matched your search

@@ -0,0 +1,51 @@
package com.droiddeck.launcher.frontend
import org.json.JSONObject
import org.junit.Assert.assertEquals
import org.junit.Assert.assertNotNull
import org.junit.Assert.assertNull
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.RobolectricTestRunner
import org.robolectric.annotation.Config
@RunWith(RobolectricTestRunner::class)
@Config(sdk = [33])
class LogoPositionTest {
@Test fun steamsOwnJsonIsReadAndWrittenBack() {
val steam = """{"nVersion":1,"logoPosition":{"pinnedPosition":"BottomLeft","nWidthPct":50,"nHeightPct":50}}"""
assertEquals(LogoPosition.DEFAULT, LogoPosition.parse(steam))
assertEquals(LogoPosition.DEFAULT, LogoPosition.parse(LogoPosition.toJson(LogoPosition.DEFAULT).toString()))
}
@Test fun everyPinKeepsItsSteamName() {
for (pin in LogoPosition.Pin.values()) {
val json = LogoPosition.toJson(LogoPosition.sized(pin, 40))
assertEquals(pin.steam, json.getJSONObject("logoPosition").getString("pinnedPosition"))
assertEquals(pin, LogoPosition.parse(json)?.pin)
}
assertEquals(setOf("BottomLeft", "UpperLeft", "CenterCenter", "UpperCenter", "BottomCenter"), LogoPosition.Pin.values().map { it.steam }.toSet())
}
@Test fun sizesAreKeptInsideTheRange() {
assertEquals(LogoPosition.MAX_PCT, LogoPosition.sized(LogoPosition.Pin.CENTER, 400).widthPct)
assertEquals(LogoPosition.MIN_PCT, LogoPosition.sized(LogoPosition.Pin.CENTER, 0).heightPct)
val wild = """{"logoPosition":{"pinnedPosition":"CenterCenter","nWidthPct":900,"nHeightPct":-4}}"""
assertEquals(LogoPosition.Value(LogoPosition.Pin.CENTER, LogoPosition.MAX_PCT, LogoPosition.MIN_PCT), LogoPosition.parse(wild))
}
@Test fun somethingThatIsNotAPositionIsNotOne() {
assertNull(LogoPosition.parse("not json"))
assertNull(LogoPosition.parse("{}"))
assertNull(LogoPosition.parse("""{"logoPosition":{"pinnedPosition":"Nowhere","nWidthPct":5,"nHeightPct":5}}"""))
assertNull(LogoPosition.parse("""{"logoPosition":{"pinnedPosition":"CenterCenter"}}"""))
}
@Test fun clearingKeepsForeignKeysAndEmptiesAJsonThatHeldNothingElse() {
val mixed = LogoPosition.toJson(LogoPosition.DEFAULT, JSONObject().put("other", 1))
val kept = LogoPosition.without(mixed)
assertNotNull(kept)
assertEquals(1, kept!!.getInt("other"))
assertNull(LogoPosition.without(LogoPosition.toJson(LogoPosition.DEFAULT)))
}
}
@@ -58,6 +58,63 @@ class SteamGridTest {
assertNull(SteamGameArt.chosenFile(app, 620, AddedGameArt.Slot.WIDE))
}
private val corner = LogoPosition.Value(LogoPosition.Pin.UPPER_CENTER, 35, 35)
@Test fun aLogoPositionIsWrittenToSteamsJsonKeepingWhatElseIsInIt() {
File(LinuxRuntime.rootDir(app), "root/.local/share/Steam/userdata/123/config").mkdirs()
grid.mkdirs()
File(grid, "620.json").writeText("""{"nVersion":1,"other":"kept"}""")
assertTrue(SteamGameArt.setPosition(app, game(), corner))
val written = org.json.JSONObject(File(grid, "620.json").readText())
assertEquals("kept", written.getString("other"))
assertEquals(corner, LogoPosition.parse(written))
assertEquals(corner, SteamGameArt.position(app, game()))
assertTrue(SteamGameArt.setPosition(app, game(), null))
val left = org.json.JSONObject(File(grid, "620.json").readText())
assertFalse(left.has("logoPosition"))
assertEquals("kept", left.getString("other"))
assertNull(SteamGameArt.position(app, game()))
}
@Test fun aLogoPositionAloneLeavesNoFileBehindWhenCleared() {
File(LinuxRuntime.rootDir(app), "root/.local/share/Steam/userdata/123/config").mkdirs()
assertTrue(SteamGameArt.setPosition(app, game(), corner))
assertEquals(corner, LogoPosition.parse(File(grid, "620.json").readText()))
assertTrue(SteamGameArt.setPosition(app, game(), null))
assertFalse(File(grid, "620.json").exists())
}
@Test fun aLogoPositionSetInSteamIsTakenOverAndRemovingItDropsIt() {
File(LinuxRuntime.rootDir(app), "root/.local/share/Steam/userdata/123/config").mkdirs()
grid.mkdirs()
val theirs = File(grid, "620.json").apply { writeText(LogoPosition.toJson(corner).toString()) }
SteamGrid.sync(app, listOf(target()))
assertEquals(corner, SteamGameArt.position(app, game()))
theirs.writeText(LogoPosition.toJson(LogoPosition.Value(LogoPosition.Pin.CENTER, 80, 80)).toString())
theirs.setLastModified(theirs.lastModified() + 5000)
SteamGrid.sync(app, listOf(target()))
assertEquals(LogoPosition.Pin.CENTER, SteamGameArt.position(app, game())?.pin)
theirs.delete()
SteamGrid.sync(app, listOf(target()))
assertNull(SteamGameArt.position(app, game()))
}
@Test fun aLogoPositionChosenHereIsNotTakenBackAsASteamChange() {
File(LinuxRuntime.rootDir(app), "root/.local/share/Steam/userdata/123/config").mkdirs()
assertTrue(SteamGameArt.setPosition(app, game(), corner))
SteamGrid.sync(app, listOf(target()))
assertEquals(corner, SteamGameArt.position(app, game()))
assertEquals(corner, LogoPosition.parse(File(grid, "620.json").readText()))
}
@Test fun aLogoPositionWithoutSteamAccountIsStillKeptHere() {
assertTrue(SteamGameArt.setPosition(app, game(), corner))
assertEquals(corner, SteamGameArt.position(app, game()))
}
@Test fun artSetInSteamIsTakenOverAndRemovingItInSteamDropsIt() {
File(LinuxRuntime.rootDir(app), "root/.local/share/Steam/userdata/123/config").mkdirs()
grid.mkdirs()