Stardew Valley Range Highlight

A Stardew Valley SMAPI mod for adding range highlighting.

You can find this mod on Nexus Mods if you prefer.

For mod users

This mod adds highlighting for the range of the following items and buildings:

• Sprinklers (including the Prismatic Sprinkler from the Prismatic Tools mod)
• Scarecrows (including the Deluxe Scarecrow)
• Bee Houses
• Mushroom Logs
• Junimo Huts
• Bombs (see note below)

Ranges are shown automatically when the corresponding item is equipped, or when the cursor is over a building of the appropriate type. Hold down one of the configured hotkeys (see Configuration below) to show ranges regardless of cursor position or what item is equipped. Each range type has a different highlight color, which is also configurable (see Configuration below).

See the Screenshots directory for some examples.

A note on bombs

Bombs are weird. They don't have a single range of effect, they have three different ranges.

• The innermost area is where the bomb can cause dirt to turn into hoed ground. The default configuration is to not show this area, but it can be enabled.
• The "normal" range is the area where rocks and many items are destroyed. This is was the only range shown version 1.1.
• The outermost area is where crops are destroyed, flooring is disrupted, and the player takes damage. (Note that prior to SDV 1.5.5 this area was not centered on the bomb.) The default configuration does show this range, but it can be disabled.

Version 1.1 shows only the "normal" range, and only around the cursor location when a bomb is equipped. Starting in version 1.2, multiple ranges are shown (if configured), and each bomb placed on the ground and not yet exploded shows its ranges (unless disabled in configuration).

Compatibility

• Works with Stardew Valley 1.6 on Linux/Mac/Windows. Might work on Android in the release corresponding to the Stardew Valley version on Android.
• Works in single player and multiplayer.
• No known incompatibilities, but if you have another mod that also shows ranges (such as UI Info Suite) then each mod will apply its own highlighting. The result is not horrible, but you probably want to disable the range highlighting in the other mod if possible. (You can do this from the in-game menu in UI Info Suite.)
• If Prismatic Tools is installed then the range of the prismatic sprinkler will be the value read from its config.
• If Better Junimos is installed then the range of Junimo Huts will be its configured value.
• If Better Sprinklers is installed then the range of Sprinklers will use its configured ranges. (Note that Better Sprinklers will still draw its own highlights in addition to the Range Highlight highlights.)
• If Simple Sprinklers is installed then the range of Sprinklers will use its configured ranges. (Range shown may be incorrect if the Simple Sprinkler configuration is /smaller/ than the base sprinkler range.)
• If Line Sprinklers is installed then the ranges of the line sprinklers will be shown. (Correctly, as of 2.4.0, rather than as if they were the non-line versions.)
• If Radioactive Tools is installed then the range of the radioactive sprinkler will be highlighted.
• If Better Beehouses is installed then the range of beehouses will use the value it has configured for Flower Search radius.
• May have issues in split-screen. (I think it's working as of v2.2.1, but this is not regularly tested, so problems may creep back into later versions even if everything is working in v2.2.1.)

Installation

Follow the usual installation proceedure for SMAPI mods:

1. Install SMAPI
2. Download the latest realease of this mod and unzip it into the Mods directory
3. Run the game using SMAPI

Configuration

Starting in version 3.1, the configuration setting described below are also available via in-game via the Generic Mod Config Menu and GMCM Options mods.

When SMAPI runs the mod for the first time it will create a config.json in the mod directory. You can edit this file to configure the hotkeys and highlight colors. The default configuration is summarized in the table below.

	hotkey	highlight tint
All Range Highlights	LeftShift	as listed below
Sprinklers	R	blue
Scarecrows	O	green
Bee Houses	H	yellow
Mushroom Logs	(none)	brown
Junimo Huts	J	white
Bombs	(none)	red/orange

If the hotkeysToggle configuration property is set to true then the hotkeys will behave as a toggle switch rather than needing to be held down.

You can also configure whether to show the inner and outer ranges of bombs, and whether to show the ranges of "ticking" bombs placed on the ground.

There are also settings that control whether other (already placed) sprinklers, scarecrows, beehouses, and mushroom logs have their ranges highlighted if the currently held item is a sprinkler, scarecrow, beehouse, or mushroom log. By default, this is on for sprinklers and scarecrows, and off for beehouses and mushroom logs.

Finally, the ShowTHINGRange options allow you to turn off highlighting of thing completely. (Maybe you don't want to see it. Maybe some other mod is already provides highlighting. In any case, it's not going to hurt my feelings if you want to disable some features.)

For mod developers

This mod provides an API for adding highlighting to items and buildings. It then uses this API to add highlights as described above. The API includes functions to:

• Describe common highlight shapes
• Get the tint colors configured for this mod
• Add highlighters for Buildings, Items, and TemporaryAnimatedSprites

For the full API, see IRangeHighlightAPI.cs.

For general information on how to use another mod's API in your mod, see the Mod Integration page on the Stardew Valley Wiki.