BaitIndex [v1.0.2]

BaitIndex is an in-game fishing compendium and bait encyclopedia for How to Fish. Seamlessly hooked into the native Journal (Tab), it displays exact 100% verified lure types, bait requirements, and boss summon methods for every creature in the game, alongside an interactive Regular Fish ⇄ Super Creatures mode switcher (Q).

Fully Tested & Compatible with the latest Steam game update (including dropped item world saving, cooked meat washing mechanics, and roulette physics).

⚙️ How It Works & Architecture

BaitIndex integrates directly into the game's native UI hierarchy via HarmonyLib:

• Native Journal Canvas Hook: Hooks JournalSlot.SetCreature to inject a dedicated BaitIndexText TextMeshProUGUI component into each slot's canvas container.
• Synchronized Slot Animations: The injected text is parented to the slot's floating transform, bobbing and rotating in perfect sync with the fish 3D models.
• Interactive Mode Switcher: Hooks ThinkingUI.Update and ThinkingUI.SetProgressTexts to detect Q / Space keypresses, triggering ThinkingUI.UpdateJournal to toggle between standard and Super/Drip views.
• Real-Time 3D Mesh Swapping: Updates MeshFilter.mesh dynamically between Creature.Mesh and Creature.DripMesh, and toggles DripText.SetDrip on the fly.
• Centered Layout Positioning: The footer status bar is anchored at anchoredPosition.x = 245f, perfectly centering it under the page navigation arrows with zero UI overlap.
• 100% Verified In-Game Database: Maps all creatures strictly to real in-game baits, lures, and NPC quests with zero developer test artifacts.

✨ Key Features

• 📖 Native Tab Journal Display: High-contrast gold & cyan tags displaying required baits directly under fish prices.
• 🔀 Interactive Mode Switcher (Q / Space): Seamlessly toggle between [▶ REGULAR FISH] and [▶ SUPER CREATURES] views with live 3D preview model swapping.
• 🎯 100% Verified In-Game Bait Database:
  • Free Lure (Crab Fishing Rod): Brown Crab, Shrimp, Mackerel, Gar, Pike.
  • Hotdog: Rock Crab, Lobster, Piranha.
  • Beginner Lure: Salmon, Perch, Triggerfish, Goldfish, Cod, Goby, Piranha.
  • Standard Lure: Catfish, Clownfish, Sea Urchin, Yellow Boxfish, Needlefish, Angelfish, Bluegill, Bowlfish, Seahorse.
  • Professional Lure: Bass, Eel, Red Snapper, Sengarat, Halibut, Flying Fish, Voxelfish, Parrotfish, Dripper, Tigerfish.
• 👑 Boss & Quest Bait Guidance:
  • Beginner Boss Lure: Sunfish, The Old Pike.
  • Standard Boss Lure: Blue Shark.
  • Professional Boss Lure: Tuna.
  • Carrot: Pufferfish (NPC quest near coconut tree).
  • Empty Beer Can: Spider Crab (Island 1 NPC).
  • Modified Leech: Giant Piranha (Island 2 female NPC).
  • Tuna Meat: Albatross (Post-Tuna boss reward).

🎮 Controls

⚙️ Configuration

The configuration file is located at BepInEx/config/com.howToFish.baitindex.cfg:

[1. General]
Enabled = true                  # Enable or disable the BaitIndex Journal hook

[2. Display]
RevealUndiscovered = true       # Reveal required bait even for undiscovered fish

📥 Installation

1. Install BepInEx 5.4+ for How to Fish.
2. Extract BaitIndex.zip into your game directory or place BaitIndex.dll into How to Fish/BepInEx/plugins/BaitIndex/.
3. Launch the game and press Tab to inspect your enhanced Journal!

📄 License

Distributed under the MIT License. See LICENSE for more information.