Merge branch 'feature/medallions'

Author: L-P

.gitignore

@@ -1,3 +1,4 @@
 /ivan
 /ivan.exe
 /ivan_release_*
+/tags

README.md

@@ -54,23 +54,38 @@ Other keys:
   runs in the background).
 
 ## Hint tracker
-1. Press the key corresponding to your hint type (WotH, Barren, Sometimes,
-   Always)
+1. Press the key corresponding to your hint type (**W**otH, **B**arren, **S**ometimes,
+   **A**lways).
 2. Type your text.
-3. Press `Enter`
+3. Press `Enter`.
 
-- `w` to enter a _WotH_ Hint (green background, fuzzy location search)
-- `b` to enter a _Barren_ Hint (red background, fuzzy location search)
-- `s` to enter a _Sometimes_ Hint (blue background, freeform text)
-- `a` to enter a _Always_ Hint (yellow background)
-- `Esc` to cancel your input
-- `Enter` to submit your input
+- `w` to enter a _WotH_ Hint (green background, fuzzy location search).
+- `b` to enter a _Barren_ Hint (red background, fuzzy location search).
+- `s` to enter a _Sometimes_ Hint (blue background, freeform text).
+- `a` to enter a _Always_ Hint (yellow background).
+- `Esc` to cancel your input.
+- `Enter` to submit your input.
 
 As _Always Hints_ have a fixed slot, they get special treatment. The text you input
 is parsed as the slot name until the first space, then your text. eg. If you
 get _Nocturne of Shadows_ on _Ocarina of Time_ you might press `a` to start the
 prompt then `oot = nocturne` then `Enter`.
 
+## Dungeon input
+Dungeon input allows you to quickly set which dungeons holds what medallions
+when reading the altar at the _Temple of Time_.
+
+1. Press `d` to enter dungeon input mode.
+2. Dungeon mode always starts with the _Light Medallion_ and goes in the same
+   order as the altar.
+3. Press the KP of the medallion that originally holds the dungeon. eg. if
+   _Fire Temple_ holds the _Light Medallion_, press the key for _Fire
+   Medallion_, ie. `5`.
+4. Dungeon mode will advance to the next medallion and you can go back to 3.
+5. When the last medallion is entered, dungeon mode is exited automatically.
+
+You can also use `+` and `-` to cycle through medallions and `0` to exit.
+
 ## Customization
 The images in the [`assets`](./assets) folder can be changed if you wish to
 customize your background or your icons.  

app.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"errors"
+	"fmt"
 	"ivan/timer"
 	"ivan/tracker"
 	"log"
@@ -27,7 +28,7 @@ type App struct {
 func NewApp() (*App, error) {
 	config, err := loadConfig(configPath)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to load initial config: %w", err)
 	}
 
 	size := config.windowSize()
@@ -46,6 +47,8 @@ func NewApp() (*App, error) {
 		config.ZoneItemMap,
 		config.Locations,
 		config.Binds,
+		config.DungeonInputMedallionOrder,
+		config.DungeonInputDungeonKP,
 	)
 	if err != nil {
 		return nil, err
@@ -79,7 +82,7 @@ func (app *App) Update(screen *ebiten.Image) error {
 		if !app.timer.IsRunning() {
 			config, err := loadConfig(configPath)
 			if err != nil {
-				return err
+				return fmt.Errorf("unable to load config: %w", err)
 			}
 			app.config = config
 		}

assets/config.json

@@ -6,6 +6,7 @@
         "+": "Redo",
         "w": "StartWOTHInput",
         "b": "StartBarrenInput",
+        "d": "StartDungeonInput",
         "a": "StartAlwaysHintInput",
         "s": "StartSometimesHintInput",
         "7": "TopLeft",
@@ -18,6 +19,22 @@
         "2": "Bottom",
         "3": "BottomRight"
     },
+
+    "DungeonInputMedallionOrder": [
+        "Light Medallion",
+        "Forest Medallion",
+        "Fire Medallion",
+        "Water Medallion",
+        "Shadow Medallion",
+        "Spirit Medallion"
+    ],
+
+    "DungeonInputDungeonKP": [
+        "Spirit Temple", "Shadow Temple", "Free",
+        "Forest Temple", "Fire Temple", "Water Temple",
+        "Deku Tree", "Dodongo's Cavern", "Jabu Jabu"
+    ],
+
     "Dimensions": {
         "ItemTracker": {
             "Min": {"X": 0, "Y": 0},

config.go

@@ -12,7 +12,10 @@ type config struct {
 	Items       []tracker.Item
 	ZoneItemMap [9][9]string
 	Locations   []string // woth/barren "simple" locations
-	Dimensions  struct {
+
+	DungeonInputMedallionOrder, DungeonInputDungeonKP []string
+
+	Dimensions struct {
 		ItemTracker image.Rectangle
 		Timer       image.Rectangle
 		HintTracker image.Rectangle

tracker/draw.go

@@ -0,0 +1,133 @@
+package tracker
+
+import (
+	"image"
+	"image/color"
+	"log"
+	"strconv"
+
+	"github.com/hajimehoshi/ebiten"
+	"github.com/hajimehoshi/ebiten/ebitenutil"
+	"github.com/hajimehoshi/ebiten/text"
+)
+
+func (tracker *Tracker) Draw(screen *ebiten.Image) {
+	op := ebiten.DrawImageOptions{}
+	drawState := func(state bool, sheet *ebiten.Image) {
+		for k := range tracker.items {
+			if tracker.items[k].Enabled != state {
+				continue
+			}
+
+			pos := tracker.items[k].Rect().Min.Add(tracker.pos)
+			op.GeoM.Reset()
+			op.GeoM.Translate(float64(pos.X), float64(pos.Y))
+
+			if err := screen.DrawImage(
+				sheet.SubImage(tracker.items[k].SheetRect()).(*ebiten.Image),
+				&op,
+			); err != nil {
+				log.Fatal(err)
+			}
+		}
+	}
+
+	_ = screen.DrawImage(tracker.background, nil)
+	if tracker.kbInputStateIsAny(inputStateItemKPZoneInput, inputStateItemInput) {
+		_ = screen.DrawImage(tracker.backgroundHelp, nil)
+		if tracker.input.activeKPZone > 0 {
+			tracker.drawActiveItemSlot(screen, tracker.input.activeKPZone)
+		}
+	}
+
+	// Do two loops to avoid texture switches.
+	drawState(false, tracker.sheetDisabled)
+	drawState(true, tracker.sheetEnabled)
+
+	tracker.drawDungeons(screen)
+	tracker.drawCapacities(screen)
+	tracker.drawInputState(screen)
+	tracker.drawHints(screen)
+}
+func (tracker *Tracker) drawActiveItemSlot(screen *ebiten.Image, slot int) {
+	if slot <= 0 || slot > 9 {
+		return
+	}
+
+	slot = []int{ // make maths ez
+		0,
+		6, 7, 8,
+		3, 4, 5,
+		0, 1, 2,
+	}[slot]
+
+	edge := gridSize * 3
+	pos := image.Point{
+		(slot % 3) * edge,
+		(slot / 3) * edge,
+	}
+	size := image.Point{126, 126}
+
+	if slot == 2 { // KP 9
+		pos.Y = 0
+		size.X = gridSize
+		size.Y = 4*gridSize + (gridSize / 2)
+	} else if slot == 8 { // KP 3
+		pos.Y = 4*gridSize + (gridSize / 2)
+		size.X = gridSize
+		size.Y = pos.Y
+	}
+
+	ebitenutil.DrawRect(
+		screen,
+		float64(pos.X), float64(pos.Y),
+		float64(size.X), float64(size.Y),
+		color.RGBA{0xFF, 0xFF, 0xFF, 0x50},
+	)
+}
+
+func (tracker *Tracker) drawDungeons(screen *ebiten.Image) {
+	for k := range tracker.items {
+		if !tracker.items[k].IsMedallion {
+			continue
+		}
+
+		rect := tracker.items[k].Rect()
+		x, y := rect.Min.X, rect.Max.Y
+		text.Draw(screen, tracker.items[k].DungeonText(), tracker.fontSmall, x, y, color.White)
+	}
+}
+
+func (tracker *Tracker) drawCapacities(screen *ebiten.Image) {
+	for k := range tracker.items {
+		var count int
+		switch {
+		case tracker.items[k].HasCapacity():
+			count = tracker.items[k].Capacity()
+		case tracker.items[k].IsCountable():
+			count = tracker.items[k].Count
+		default:
+			continue
+		}
+
+		if !tracker.items[k].Enabled {
+			continue
+		}
+
+		rect := tracker.items[k].Rect()
+		x, y := rect.Min.X, rect.Max.Y
+
+		// HACK, display skull count centered on the right slot
+		if tracker.items[k].Name == "Gold Skulltula Token" {
+			x, y = rect.Min.X+gridSize+marginLeft, rect.Min.Y+marginTop+(gridSize/2)
+			if count == 100 {
+				x -= 5
+			} else if count < 10 {
+				x += 5
+			}
+		}
+
+		str := strconv.Itoa(count)
+		text.Draw(screen, str, tracker.font, x, y, color.White)
+	}
+}