Refactor assets loading (#24)

Author: applejag

assets/assets.go

@@ -9,112 +9,135 @@ import (
 )
 
 var (
-	fieldBuf            [19213]byte
-	Field               firefly.Image
-	fireflyHighlightBuf [262]byte
-	FireflyHighlight    util.SpriteSheet
-	scrollBuf           [16375]byte
-	ScrollClose         util.SpriteSheet
-	ScrollOpen          util.SpriteSheet
-	tournamentButtonBuf [3037]byte
-	TournamentButton    util.SpriteSheet
-	trainButtonBuf      [909]byte
-	TrainButton         util.SpriteSheet
-	shopButtonBuf       [629]byte
-	ShopButton          util.SpriteSheet
-
-	racingMapBuf         [192013]byte
-	RacingMap            firefly.Image
-	racingMapTreesBuf    [192013]byte
-	RacingMapTrees       firefly.Image
-	racingMapTreetopsBuf [192013]byte
-	RacingMapTreetops    firefly.Image
-	racingMapCloudsBuf   [32207]byte
-	RacingMapClouds      util.SpriteSheet
-	racingMapMaskBuf     [96007]byte
-	RacingMapMask        util.ExtImage
-	racingPlaceBuf       [1465]byte
-	RacingPlace          util.SpriteSheet
-	victorySplashBuf     [86407]byte
-	VictorySplash        util.SpriteSheet
-	defeatSplashBuf      [86407]byte
-	DefeatSplash         util.SpriteSheet
-	fireflySheetBuf      [213]byte
-	FireflySheet         util.SpriteSheet
-	FireflySheetRev      util.SpriteSheet
-
-	fireflyHatsBuf [1933]byte
+	buf [1036376]byte
+
+	Field            firefly.Image
+	FireflyHighlight util.SpriteSheet
+	ScrollClose      util.SpriteSheet
+	ScrollOpen       util.SpriteSheet
+	TournamentButton util.SpriteSheet
+	TrainButton      util.SpriteSheet
+	ShopButton       util.SpriteSheet
+
+	RacingMap         firefly.Image
+	RacingMapTrees    firefly.Image
+	RacingMapTreetops firefly.Image
+	RacingMapClouds   util.SpriteSheet
+	RacingMapMask     util.ExtImage
+	RacingPlace       util.SpriteSheet
+	VictorySplash     util.SpriteSheet
+	DefeatSplash      util.SpriteSheet
+	FireflySheet      util.SpriteSheet
+	FireflySheetRev   util.SpriteSheet
+
 	FireflyHats    util.SpriteSheet
 	FireflyHatsRev util.SpriteSheet
 
-	titleScreenBuf          [38413]byte
-	TitleScreen             util.SpriteSheet
-	titleButtonHighlightBuf [702]byte
-	TitleButtonHighlight    util.SpriteSheet
-	titleNoContinueBuf      [423]byte
-	TitleNoContinue         firefly.Image
-
-	shopBGBuf      [9607]byte
-	ShopBG         firefly.Image
-	shopFrogBuf    [31693]byte
-	ShopFrog       util.SpriteSheet
-	shopPropsBuf   [23533]byte
-	ShopProps      util.SpriteSheet
-	shopChatboxBuf [3073]byte
-	ShopChatbox    firefly.Image
-	shopItemBuf    [6061]byte
-	ShopItem       util.SpriteSheet
-
-	exitBuf [95]byte
-	Exit    firefly.Image
-
-	transitionSheetBuf [134]byte
-	TransitionSheet    util.SpriteSheet
-
-	cashBannerBuf [589]byte
-	CashBanner    firefly.Image
-
-	fontEG_6x9Buf    [655]byte
-	FontEG_6x9       firefly.Font
-	fontPico8_4x6Buf [295]byte
-	FontPico8_4x6    firefly.Font
+	TitleScreen          util.SpriteSheet
+	TitleButtonHighlight util.SpriteSheet
+	TitleNoContinue      firefly.Image
+
+	ShopBG      firefly.Image
+	ShopFrog    util.SpriteSheet
+	ShopProps   util.SpriteSheet
+	ShopChatbox firefly.Image
+	ShopItem    util.SpriteSheet
+
+	Exit firefly.Image
+
+	TransitionSheet util.SpriteSheet
+
+	CashBanner firefly.Image
+
+	FontEG_6x9    firefly.Font
+	FontPico8_4x6 firefly.Font
 )
 
 func Load() {
-	// firefly.LogDebug(strconv.Itoa(firefly.GetFileSize("firefly-hats")))
-	Field = firefly.LoadImage("field", fieldBuf[:])
-	FireflyHighlight = util.SplitImageBySize(firefly.LoadImage("firefly-hi", fireflyHighlightBuf[:]), firefly.S(32, 32))
-	allHats := util.SplitImageBySize(firefly.LoadImage("firefly-hats", fireflyHatsBuf[:]), firefly.S(10, 8))
+	loader := Loader{buf: buf[:]}
+
+	Field = loader.LoadImage("field")
+	FireflyHighlight = util.SplitImageBySize(loader.LoadImage("firefly-hi"), firefly.S(32, 32))
+	allHats := util.SplitImageBySize(loader.LoadImage("firefly-hats"), firefly.S(10, 8))
 	FireflyHats = allHats[:22]
 	FireflyHatsRev = allHats[22:]
-	ScrollClose = util.SplitImageByCount(firefly.LoadImage("scroll", scrollBuf[:]), firefly.S(4, 1))
+	ScrollClose = util.SplitImageByCount(loader.LoadImage("scroll"), firefly.S(4, 1))
 	ScrollOpen = slices.Clone(ScrollClose)
 	slices.Reverse(ScrollOpen)
-	TournamentButton = util.SplitImageByCount(firefly.LoadImage("tournament-btn", tournamentButtonBuf[:]), firefly.S(7, 1))
-	TrainButton = util.SplitImageBySize(firefly.LoadImage("train-btn", trainButtonBuf[:]), firefly.S(61, 14))
-	ShopButton = util.SplitImageBySize(firefly.LoadImage("shop-btn", shopButtonBuf[:]), firefly.S(42, 14))
-	RacingMap = firefly.LoadImage("racing-map", racingMapBuf[:])
-	RacingMapTrees = firefly.LoadImage("racing-map-trees", racingMapTreesBuf[:])
-	RacingMapTreetops = firefly.LoadImage("racing-map-treetops", racingMapTreetopsBuf[:])
-	RacingMapClouds = util.SplitImageByCount(firefly.LoadImage("racing-map-clouds", racingMapCloudsBuf[:]), firefly.S(2, 1))
-	RacingMapMask = util.NewExtImage(firefly.LoadFile("racing-map-mask", racingMapMaskBuf[:]))
-	RacingPlace = util.SplitImageBySize(firefly.LoadImage("racing-place", racingPlaceBuf[:]), firefly.S(28, 33))
-	VictorySplash = util.SplitImageByCount(firefly.LoadImage("victory-splash", victorySplashBuf[:]), firefly.S(3, 3))
-	DefeatSplash = util.SplitImageByCount(firefly.LoadImage("defeat-splash", defeatSplashBuf[:]), firefly.S(3, 3))
-	fireflyCombinedSheet := util.SplitImageBySize(firefly.LoadImage("firefly", fireflySheetBuf[:]), firefly.S(9, 10))
+	TournamentButton = util.SplitImageByCount(loader.LoadImage("tournament-btn"), firefly.S(7, 1))
+	TrainButton = util.SplitImageBySize(loader.LoadImage("train-btn"), firefly.S(61, 14))
+	ShopButton = util.SplitImageBySize(loader.LoadImage("shop-btn"), firefly.S(42, 14))
+	RacingMap = loader.LoadImage("racing-map")
+	RacingMapTrees = loader.LoadImage("racing-map-trees")
+	RacingMapTreetops = loader.LoadImage("racing-map-treetops")
+	RacingMapClouds = util.SplitImageByCount(loader.LoadImage("racing-map-clouds"), firefly.S(2, 1))
+	RacingMapMask = loader.LoadExtImage("racing-map-mask")
+	RacingPlace = util.SplitImageBySize(loader.LoadImage("racing-place"), firefly.S(28, 33))
+	VictorySplash = util.SplitImageByCount(loader.LoadImage("victory-splash"), firefly.S(3, 3))
+	DefeatSplash = util.SplitImageByCount(loader.LoadImage("defeat-splash"), firefly.S(3, 3))
+	fireflyCombinedSheet := util.SplitImageBySize(loader.LoadImage("firefly"), firefly.S(9, 10))
 	FireflySheet = fireflyCombinedSheet[0:2]
 	FireflySheetRev = fireflyCombinedSheet[2:4]
-	TitleScreen = util.SplitImageByCount(firefly.LoadImage("title-screen", titleScreenBuf[:]), firefly.S(2, 1))
-	TitleButtonHighlight = util.SplitImageByCount(firefly.LoadImage("title-button-hi", titleButtonHighlightBuf[:]), firefly.S(2, 1))
-	TitleNoContinue = firefly.LoadImage("title-no-continue", titleNoContinueBuf[:])
-	ShopBG = firefly.LoadImage("shop-bg", shopBGBuf[:])
-	ShopFrog = util.SplitImageByCount(firefly.LoadImage("shop-frog", shopFrogBuf[:]), firefly.S(3, 2))
-	ShopProps = util.SplitImageByCount(firefly.LoadImage("shop-props", shopPropsBuf[:]), firefly.S(3, 2))
-	ShopChatbox = firefly.LoadImage("shop-chatbox", shopChatboxBuf[:])
-	ShopItem = util.SplitImageByCount(firefly.LoadImage("shop-item", shopItemBuf[:]), firefly.S(4, 3))
-	TransitionSheet = util.SplitImageByCount(firefly.LoadImage("transition", transitionSheetBuf[:]), firefly.S(4, 4))
-	Exit = firefly.LoadImage("exit", exitBuf[:])
-	CashBanner = firefly.LoadImage("cash-banner", cashBannerBuf[:])
-	FontEG_6x9 = firefly.LoadFont("eg_6x9", fontEG_6x9Buf[:])
-	FontPico8_4x6 = firefly.LoadFont("pico8_4x6", fontPico8_4x6Buf[:])
+	TitleScreen = util.SplitImageByCount(loader.LoadImage("title-screen"), firefly.S(2, 1))
+	TitleButtonHighlight = util.SplitImageByCount(loader.LoadImage("title-button-hi"), firefly.S(2, 1))
+	TitleNoContinue = loader.LoadImage("title-no-continue")
+	ShopBG = loader.LoadImage("shop-bg")
+	ShopFrog = util.SplitImageByCount(loader.LoadImage("shop-frog"), firefly.S(3, 2))
+	ShopProps = util.SplitImageByCount(loader.LoadImage("shop-props"), firefly.S(3, 2))
+	ShopChatbox = loader.LoadImage("shop-chatbox")
+	ShopItem = util.SplitImageByCount(loader.LoadImage("shop-item"), firefly.S(4, 3))
+	TransitionSheet = util.SplitImageByCount(loader.LoadImage("transition"), firefly.S(4, 4))
+	Exit = loader.LoadImage("exit")
+	CashBanner = loader.LoadImage("cash-banner")
+	FontEG_6x9 = loader.LoadFont("eg_6x9")
+	FontPico8_4x6 = loader.LoadFont("pico8_4x6")
+
+	loader.AssertBufferFullyUtilized()
+}
+
+type Loader struct {
+	buf  []byte
+	used int
+}
+
+func (loader *Loader) LoadFile(path string) firefly.File {
+	// Have to get the file size separately, even though LoadFile returns the size
+	// https://github.com/firefly-zero/firefly-runtime/issues/7
+	fileSize := firefly.GetFileSize(path)
+	file := firefly.LoadFile(path, loader.buf[:fileSize])
+	written := len(file.Raw)
+	loader.used += written
+	loader.buf = loader.buf[written:]
+	return file
+}
+
+func (loader *Loader) LoadImage(path string) firefly.Image {
+	return loader.LoadFile(path).Image()
+}
+
+func (loader *Loader) LoadExtImage(path string) util.ExtImage {
+	return util.NewExtImage(loader.LoadFile(path))
+}
+
+func (loader *Loader) LoadFont(path string) firefly.Font {
+	return loader.LoadFile(path).Font()
+}
+
+func (loader *Loader) AssertBufferFullyUtilized() {
+	var buf [100]byte
+	n := copy(buf[:], "All assets loaded. Total size: ")
+	n += util.FormatIntInto(buf[n:], loader.used)
+	firefly.LogDebug(string(buf[:n]))
+
+	if len(loader.buf) > 0 {
+		var buf [100]byte
+		n := copy(buf[:], "Assets buffer should be smaller. Want: [")
+		n += util.FormatIntInto(buf[n:], loader.used)
+		n += copy(buf[n:], "]byte, but got [")
+		n += util.FormatIntInto(buf[n:], loader.used+len(loader.buf))
+		n += copy(buf[n:], "]byte")
+		err := string(buf[:n])
+		firefly.LogError(err)
+		panic("assets.Loader: buffer was not fully utilized")
+	}
 }

pkg/util/text.go

@@ -102,6 +102,14 @@ func numberOfDigits(num int) int {
 		return 4
 	case num < 1e5:
 		return 5
+	case num < 1e6:
+		return 6
+	case num < 1e7:
+		return 7
+	case num < 1e8:
+		return 8
+	case num < 1e9:
+		return 9
 	default:
 		panic("number is too big")
 	}