Range Highlight

Range Highlight

Mods
5.2k Downloads

This mod adds highlighting for the range of scarecrows, sprinklers, bombs, bee houses, mushroom logs,, and Junimo huts. Highlights are visible when the corresponding item is equipped or when a hotkey is held down. Each item uses a different highlight color.

Supports Prismatic Sprinklers (from the Prismatic Tools mod) and Deluxe Scarecrows.

Install




How to use

Ranges are shown automatically when the corresponding item is equipped or when the cursor is over a Junimo hut. Hold down one of the following hotkeys to show ranges without needing to have an item equipped: 

LeftShift

All Range Highlights 

J

Junimo huts 

H

Bee Houses 

R

Sprinklers 

O

Scarecrows


The hotkeys and highlight colors are configurable.  If Generic Mod Config Menu and GMCM Options are installed then these settings can be configured on the title screen.  Otherwise you'll have to edit the <font style="font-family:Courier New;">config.json</font> file:

When SMAPI runs the mod for the first time, it will create a <font style="font-family:Courier New;">config.json</font> file in the mod directory.  Edit the file to change hotkeys or highlight colors.  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.

Starting in version 1.3, you can configure the hotkeys to act like toggle switches rather than having to be held down.

Starting in version 1.4, 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.)

Version 1.5 added configuration options that control whether other (already placed) sprinklers, scarecrows, and beehouses have their ranges highlighted if the currently held item is a sprinkler, scarecrow, or beehouse.  By default, this is on for sprinklers and scarecrows, and off for beehouses.  Version 2.1 added support for mushroom logs, which have default configuration like beehouses.

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 Stardew Valley 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.)


For mod developers

This mod provides an API that other mods can use.  See the GitHub repo for more information.

See also