Merge branch 'hints'

Author: L-P

README.md

@@ -14,6 +14,22 @@ gotta go fast.
 - `Home` resets the tracker and reloads its configuration from file, only works
   when the timer is stopped (not paused).
 
+## Hint tracker
+1. Press the key corresponding to your hint type (WotH, Barren, Sometimes,
+   Always)
+2. Type your text.
+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)
+
+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`.
+
 ## Item tracker
 ### Keyboard
 **Ivan must be focused for keyboard input to work.**

app.go

@@ -2,40 +2,53 @@ package main
 
 import (
 	"errors"
-	"image"
 	"ivan/timer"
 	"ivan/tracker"
 
 	"github.com/hajimehoshi/ebiten"
 	"github.com/hajimehoshi/ebiten/inpututil"
 )
 
-const (
-	width  = tracker.Width
-	height = tracker.Height + timer.Height
-)
+const configPath = "assets/config.json"
 
 var errCloseApp = errors.New("user requested app close")
 
 type App struct {
 	tracker *tracker.Tracker
 	timer   *timer.Timer
+	config  config
 }
 
 func NewApp() (*App, error) {
-	timer, err := timer.New(image.Point{0, tracker.Height})
+	config, err := loadConfig(configPath)
 	if err != nil {
 		return nil, err
 	}
 
-	tracker, err := tracker.New("assets/config.json")
+	size := config.windowSize()
+	ebiten.SetWindowSize(size.X, size.Y)
+	ebiten.SetWindowPosition(1920-size.X, 0)
+
+	timer, err := timer.New(config.Dimensions.Timer)
+	if err != nil {
+		return nil, err
+	}
+
+	tracker, err := tracker.New(
+		config.Dimensions.ItemTracker,
+		config.Dimensions.HintTracker,
+		config.Items,
+		config.ZoneItemMap,
+		config.Locations,
+	)
 	if err != nil {
 		return nil, err
 	}
 
 	return &App{
 		tracker: tracker,
 		timer:   timer,
+		config:  config,
 	}, nil
 }
 
@@ -44,24 +57,47 @@ func (app *App) Update(screen *ebiten.Image) error {
 
 	switch {
 	case inpututil.IsKeyJustPressed(ebiten.KeyEscape):
-		if !app.timer.IsRunning() {
+		if !app.timer.IsRunning() && !app.tracker.EatInput() {
 			return errCloseApp
 		}
+		app.tracker.Cancel()
+
 	case inpututil.IsKeyJustPressed(ebiten.KeyHome):
 		if !app.timer.IsRunning() {
-			app.tracker.Reset()
+			config, err := loadConfig(configPath)
+			if err != nil {
+				return err
+			}
+			app.config = config
+			app.tracker.Reset(app.config.Items, app.config.ZoneItemMap)
 		}
+
+	case inpututil.IsKeyJustPressed(ebiten.KeyEnter):
+		app.tracker.Submit()
+
 	case inpututil.IsKeyJustPressed(ebiten.KeySpace):
-		app.timer.Toggle()
+		if app.tracker.EatInput() {
+			app.tracker.Input([]rune(" "))
+		} else {
+			app.timer.Toggle()
+		}
+
 	case inpututil.IsKeyJustPressed(ebiten.KeyDelete):
 		app.timer.Reset()
+
+	case inpututil.IsKeyJustPressed(ebiten.KeyBackspace):
+		app.tracker.Backspace()
+
 	case inpututil.IsMouseButtonJustPressed(ebiten.MouseButtonLeft):
 		app.tracker.ClickLeft(ebiten.CursorPosition())
+
 	case inpututil.IsMouseButtonJustPressed(ebiten.MouseButtonRight):
 		app.tracker.ClickRight(ebiten.CursorPosition())
+
 	case wheel != 0:
 		x, y := ebiten.CursorPosition()
 		app.tracker.Wheel(x, y, wheel > 0)
+
 	default:
 		app.tracker.Input(ebiten.InputChars())
 	}

assets/background-help.png

@@ -1,5 +1,19 @@
 {
-    "ZoneItems": [
+    "Dimensions": {
+        "ItemTracker": {
+            "Min": {"X": 0, "Y": 0},
+            "Max": {"X": 294, "Y": 378}
+        },
+        "Timer": {
+            "Min": {"X": 0, "Y": 378},
+            "Max": {"X": 294, "Y": 462}
+        },
+        "HintTracker": {
+            "Min": {"X": 0, "Y": 462},
+            "Max": {"X": 294, "Y": 672}
+        }
+    },
+    "ZoneItemMap": [
         [
             "Kokiri Boots", "Iron Boots", "Hover Boots",
             "Kokiri Tunic", "Goron Tunic", "Zora Tunic",
@@ -44,6 +58,43 @@
             "Song of Storms"
         ]
     ],
+    "Locations": [
+        "Bottom of the Well",
+        "Death Mountain Crater",
+        "Death Mountain Trail",
+        "Deku Tree",
+        "Desert Colossus",
+        "Dodongo's Cavern",
+        "Fire Temple",
+        "Forest Temple",
+        "Ganon's Castle",
+        "Gerudo Training Grounds",
+        "Gerudo Valley",
+        "Gerudo's Fortress",
+        "Goron City",
+        "Graveyard",
+        "Haunted Wasteland",
+        "Hyrule Castle",
+        "Hyrule Field",
+        "Ice Cavern",
+        "Jabu Jabu's Belly",
+        "Kakariko Village",
+        "Kokiri Forest",
+        "Lake Hylia",
+        "Links House",
+        "Lon Lon Ranch",
+        "Lost Woods",
+        "Market",
+        "Outside Ganon's Castle",
+        "Sacred Forest Meadow",
+        "Shadow Temple",
+        "Spirit Temple",
+        "Temple of Time",
+        "Water Temple",
+        "Zora's Domain",
+        "Zora's Fountain",
+        "Zora's River"
+    ],
     "Items": [
         {
             "Name": "Deku Stick",
@@ -600,8 +651,7 @@
             "X": 0,
             "Y": 294,
             "SheetX": 70,
-            "SheetY": 175,
-            "Enabled": true
+            "SheetY": 175
         },
         {
             "Name": "Goron Tunic",
@@ -622,8 +672,7 @@
             "X": 0,
             "Y": 336,
             "SheetX": 175,
-            "SheetY": 175,
-            "Enabled": true
+            "SheetY": 175
         },
         {
             "Name": "Iron Boots",
@@ -645,7 +694,6 @@
             "Y": 168,
             "SheetX": 35,
             "SheetY": 245,
-            "Enabled": true,
             "CountMax": 100,
             "CountStep": 5
         },

assets/background-help.xcf

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"encoding/json"
+	"image"
+	"ivan/tracker"
+	"os"
+)
+
+type config struct {
+	Items       []tracker.Item
+	ZoneItemMap [9][9]string
+	Locations   []string // woth/barren "simple" locations
+	Dimensions  struct {
+		ItemTracker image.Rectangle
+		Timer       image.Rectangle
+		HintTracker image.Rectangle
+	}
+}
+
+func (c config) windowSize() image.Point {
+	var ret image.Rectangle
+	for _, v := range []image.Rectangle{
+		c.Dimensions.ItemTracker,
+		c.Dimensions.Timer,
+		c.Dimensions.HintTracker,
+	} {
+		ret = ret.Union(v)
+	}
+
+	return ret.Size()
+}
+
+func loadConfig(path string) (config, error) {
+	f, err := os.Open(path)
+	if err != nil {
+		return config{}, err
+	}
+	defer f.Close()
+
+	var ret config
+	dec := json.NewDecoder(f)
+	if err := dec.Decode(&ret); err != nil {
+		return config{}, err
+	}
+
+	return ret, nil
+}