Fishing Info Overlays

Creator: barteke22

Updated:14/11/2025 16:39:56

65KB

Download

Authentification

Trusted by 200,000,000+ Users

Pre-required Mods

will be automatically installed when you use Fishing Info Overlays

SMAPI - Stardew Modding API

39.9MB

Generic Mod Config Menu

106KB

GMCM Options

42KB

About this Mod

Customizable overlays that show fish in the current area while holding a fishing rod (or crab pot), and provide a preview during the fishing minigame.

General info:
This mod shows information about fish (and fishable items) currently available in your area, along with a preview during the fishing minigame. It doesn't change any gameplay mechanics and is designed to be as compatible as possible with other fish-related mods. Highly customizable—check out the screenshots.

Uses Data\\Fish + Fishing Simulation combo for best mod compatibility. This method runs the fishing minigame at a configurable interval (per UI update) after retrieving the generic fish data. Higher intervals improve accuracy and reduce visual glitches, but increase performance cost. It should be nearly 100% accurate for anything (vanilla or modded) that uses the fishing minigame (getFish method).

**Project story:**

**Spoiler:**

Show

This little project started as an attempt to update Teh's Overhaul, since even the unofficial 1.5 update seems to completely block access to certain 1.5 items and requires tons of workarounds for some modded fish. As the name suggests, Teh's Overhaul is a complete overhaul — meaning it implements its own fishing minigame logic. I was mainly interested in its overlay part, as there are plenty of decent alternatives when it comes to minigame difficulty. That mod is quite massive, though — with data spread across many files, classes, and APIs. I quickly gave up trying to make sense of it, decided to start from scratch, and properly understand how the vanilla game works.

So is this actually based on Teh's Overhaul? Well, yes, but actually... who knows? The visual concept/initial idea maybe, but the code is purely SMAPI/Vanilla Stardew based.

Installation:

Download and Install the latest version of SMAPI. Designed for version 3.10 and above. Earlier versions may not be compatible.
[Optional] Download and install Generic Mod Config Menu (GMCM). If you want an easy way to customize overlays on the fly with in-depth explanations.
Download Mod by Files, and unzip the FishingInfoOverlays folder into your Mods folder.

Compatibility:

Tested with Stardew Valley Expanded (SVE), Ridgeside Village, Stardew Aquarium, Fishing Made Easy Suite, Fishing Minigames. Any mod that adds fish through proper mechanics should work, and mods that adjust difficulty in simple ways, such as those using Content Patcher, should be fine.
This mainly covers different features from the Fish Helper UI and should be fully compatible. You can disable various features of this mod if you prefer that UI.

Location bar:By default, it checks the Fish Data (with less accurate percentages). It can be configured to simulate the location's getFish (the fishing minigame's success method) X times per UI update instead. This means any fish obtainable through the location's getFish should be found. Either method should work, unless a mod completely overhauls the vanilla fishing system.

Mini-Game: Gets the active BobberBar's current fish and its position (plus some extra bits). Should work unless a mod completely overhauls vanilla fishing, though it might still work if said mod updates BobberBar's variables.
Singleplayer, Multiplayer, and Split Screen (Local Co-op).

Issues:

Some items and locations had to be hardcoded for preview functionality: Golden Walnuts, Spines, Skulls, CalderaPainting (furniture), Railroad, and IslandFarmCave (locations). No workaround is possible, as the game directly uses Game1.player there instead of the provided 'who'. As a side effect, the overlay is slightly predictive on Ginger Island—anticipating whether clicking a nearby water tile will yield certain items.
Minor flicker/jumping when using magic bait in some locations. This is due to certain items having less than a 1% drop chance.

Config (without GMCM)

**Spoiler:**

Show

From version 1.1.0, most variables are arrays of 4—one for each split-screen view. GMCM now supports this properly. Manual example:
"BarIconMode": [
    2,- This is screen 1: Split-screen host, or any non-split-screen player.
    0,- This is Screen 2: Split-screen (top) right. Non-split-screen players can disregard this and the next 2 values.
    1,- Screen 3
    0- Screen 4
]

Just like in GMCM, if you're holding a fishing rod near water in-game, you can preview any changes made to the config.json (after saving it) by pressing F5.
If you're using GMCM it has detailed in-game explanations of each position; otherwise, run the game once to generate the config.json for this mod.

BarSonarMode (0-3):Defines what doesn't function without Sonar Bobber: 0= Whole mod, 1= Minigame preview, 2= Shift Aim, 3= Nothing.
BarIcon Mode (0-3): Direction in which icons move before swapping rows/columns. 0 = Horizontal Icons, 1 = Vertical Icons, 2 = Vertical Icons + Text, 3 = Disabled (no location bar for rods/pots, only minigame preview).
BarTopLeftLocationX (0-X):Top left bar corner X coordinate.
BarTopLeftLocationY (0-X): Y coordinate of top left bar corner.
Bar Scale (0.1-10):The bar already scales along with the UI, this allows you to fine-tune it.
BarMaxIcons (4-500): Maximum number of icons displayed simultaneously.
BarMaxIconsPerRow (4-500):Maximum number of icons shown before switching rows/columns.
BarBackgroundMode (0-2): Dark transparent background(s). 0 = Circles behind each icon, 1 = Single rectangle behind all icons, 2 = Off.
Bar Background Color RGBA: Background color in integer RGBA format, with values ranging from 0–255 for each channel. Use a color picker tool; note that the alpha value is also 0–255 (not 0–1).
BarTextColorRGBA: Colour of text in Integer RGBA, so 0-255 x4, like [255, 255, 255, 255].
BarExtraIconsMaxSize: true= Show a Star icon if max size of fish hasn't been caught yet. false= Off.
BarExtraIconsBundles: true= Show a Bundle icon if the fish is needed for a Community Center bundle (if unlocked). false= Off.
BarExtraIconsAquarium: true= Show a Pufferfish icon if the fish is needed for Stardew Aquarium (if mod installed). false= off.
BarExtraIconsAlwaysShow: Show Extra Icons even if the fish hasn't been caught before.
BarUncaughtFishEffect (0-2): When uncaught: 0= Darken fish. 1= Show a Bronze Star extra icon (ignores BarExtraIconsAlwaysShow). 2= Same as caught.
Bar Show Bait and Tackle Info: true= Displays bait and tackle icons + counts in the bar (if equipped). false= off.
BarShowPercentMode (0-2):0/1= Shows the catch chance percentage under each fish icon. Accuracy depends on ExtraCheckFrequency. 2= off.
Bar Sort Mode (0-2): 0= Icons are sorted by name. 1= Icons are sorted by catch chance percentage (heavily based on ExtraCheckFrequency, will likely jump), 2= Off (Trash, then IDs, then extras).
Bar Extra Check Frequency (0-200): 0-22= Generic (when 0) OR Simulated, runs the fishing minigame value*10 times per UI Update (higher is more accurate, but can impact performance). Generic is less accurate percentage-wise, but performs better.
Bar Scan Radius (1-50):Scans X tiles around the player for water and displays fish info only for the nearest tile found (if any).
BarCrabPotEnabled:true= Enables the above preview for Crab Pots. false= Off.
BarNonFishMode (0-2):Whether the bar shows non-fish objects, like furniture and trash. 0 = Same as fish. 1 = Always caught. 2 = Don't show.
Minigame Preview Bar: true= When reeling a fish, it's highlighted on the Preview Bar. false= Off.
Mini Game Preview Rodtrue= When reeling a fish, its sprite is shown instead of the generic minigame sprite. false= Off.
Minigame Preview Water: true= When reeling a fish, it's visible in the water (nibbling bobber). Transparency depends on sonar setting & equipment. false= off.
MinigamePreviewSonar: When reeling in a fish, the base game sonar display is shown.
BarLegendary Mode (0-2) (pre 1.0.5): If BarExtraCheckFrequency is greater than 0, this is ignored. 0 = Vanilla Legendary Fish logic, 1 = Vanilla + Always Show (works with mods) Only makes them re-catchable), 2= Never Show (cool if you don't want to see them, or have a mod that alters them).
Minigame Mode (0-3) (pre 1.2.5):0= Copies multiple layers to look better. 1= Only overlays the fish, looks worse. but may work better. 2= Included in both above: Highlights fish in the normal location bar (if enabled). 3= Disabled.
BarShowPercent (pre 1.2.8): true= Displays percentage chance of catching a fish under its icon. Accuracy based on ExtraCheckFrequency, false= off.
BarExtraIconsUncaught (pre 1.2.8): true= Show extra icons even if the fish hasn't been caught before. false= Show only when caught.
OnlyFish (pre 1.3.1)true= Only show items from the official fish list (including trash), ignoring things like furniture or notes.

My other mod(s):

Fishing Minigames (Alternatives and Here Fishy)

Custom Spouse Location

Source and Translation:
Source code is available Here If I ever vanish from Nexus, I tried keeping it as simple as I could, so feel free to take over/reupload if it breaks and I'm gone for too long. Item names are already localized; you can find the GMCM translation base. here - Feel free to PM me your translations (or upload them yourself).