# Better Sprinklers Updated

Releases

On Nexus mods

A fork of Better Sprinklers by Maurício Gomes (Speeder).

Sprinklers, but better.

Originally by Maurício Gomes (Speeder), maintained by JamesCodesThings, updated for SDV 1.6 by gingajamie.

Contents

• Features
• Install
• Configuration
• Use
• Compatibility
• Roadmap
• Versions
• Motivation
• Found a bug?

Features

Edit Sprinkler Coverage

Pressing k (configurable) allows you to change the coverage of each type of sprinkler.

Activate Sprinklers Manually

Right clicking (configurable) or hitting the "Check" controller button will activate the highlighted sprinkler.

View Sprinkler/Scarecrow Coverage

Pressing F3 (configurable) allows you to show the coverage of the highlighted sprinkler.

Balanced Mode

In balanced mode, the sprinklers you have cost money every day. The amount is configurable, or you can turn it off.

The default, is 0.25G per tile covered per day, rounded to the nearest whole G.

Quality Sprinklers cost half the cost of Normal Sprinklers.

Iridium Sprinklers cost half the cost of Quality Sprinklers.

Pressure Nozzles half the cost of the sprinkler.

Q: What!? Did you implement bills in my cosy game?

A: Yeah, I did a little. Don't worry though, you can turn them off, change the amount, etc. It felt like the most immersive way to balance the mod. The previous balance increased the cost of sprinklers, but that's one-off.

Q: What if I run out of money?

A: Yeah, your sprinklers stop sprinkling. Same again, configurable.

Install

1. Install the latest version of SMAPI.
2. Unzip the mod files into your Mods folder.
3. Run the game using SMAPI.

Configuration

Balanced Mode

Off: Sprinklers do not have a daily cost.

Easy: Sprinklers cost 0.1g per tile watered, per day.

Normal: Sprinklers cost 0.25g per tile watered, per day.

Hard: Sprinklers cost 0.5g per tile watered, per day.

Very Hard: Sprinklers cost 1g per tile watered, per day.

Sprinkler Range

Change this to change the maximum range of a sprinkler type.

Can't Afford

If you can't afford to run the sprinklers:

Off: the sprinklers run, your wallet is emptied.

Don't Water: the sprinklers don't water your crops.

note: at the moment this does not affect the default spinkler tiles(see the roadmap).

Default Tiles

The tiles that would be watered by default

Cost Money: The tiles will cost the same as any other tile in balanced mode.

Are Free: The default tiles (in the same position) are free.

Same Number Are Free: The number of tiles that would be watered by default are free.

(x is sprinkler, 1 is tile watered, 0 is tile not watered)

00000
11x11
00000

Show Bills Message

On: Every morning you'll see a message for how much your sprinklers cost.

Off: Message is not shown.

Show Can't Afford Warning

On: If you can't afford to water all your crops one day, you'll get a warning.

Off: Message is not shown.

This one's just for if you want to be warned but don't want the bills message every day.

Show Placement Coverage

On: The coverage of a sprinkler/scarecrow is shown when placing it.

Off: No coverage is shown.

This is useful if you only want to use Data Layers.

Sprinkler Cooldown (seconds)

This is used to avoid sprinkler animation overlap when a sprinkler is activated multiple times within quick succesion. Default value of 30 seconds.

Show Config Key

Use: Changes the hotkey to change sprinkler configuration.

Show Overlay Key

Use: Changes the hotkey to show coverage overlay.

Use

Editing sprinkler coverage

1. Press K to show a sprinkler coverage editor
   • This is editable in config.json, or using Generic Mod Config Menu
2. Click the squares to change the area a sprinkler waters.
   • The default squares cannot be changed.

Highlighting coverage

When placing a sprinkler

• Coverage will be highlighted by default
• This can be switched off in the mod's config.

Ad-hoc

1. Press F3
2. Point at a sprinkler or scarecrow.

Alternative

Alternatively, you can use Data Layers to show coverage of sprinklers, scarecrows, and much more.

Compatibility

Better Sprinklers is compatible with Stardew Valley 1.3+ on Linux/Mac/Windows, both single-player and multiplayer.

If two players have the mod installed in multiplayer, both ranges will apply.

Some mod incompatibilities have been observed, particularly mods that change sprinkler behaviour.

It's out of scope of my aims to improve this. But, I'll happily accept and consider checking out bug reports.

Roadmap

• [x] (balancing) Option: Do not sprinkle tiles if we run out of money.
• [x] (balancing) Option: Don't water if we can't afford vs Cut out.
• [x] (ui) Message: When watering is skipped/cut out, warn the user
  • [x] Option to enable/disable (using main option)
• [x] Update Mod Screenshots
• [x] (immersion) Same bills cutout with default tiles?
• [x] (ui) Click & Drag to change multiple tiles quickly
• [x] (ui) Live Preview of costs on config menu
• [x] (gameplay) Ability to change maximum range of each sprinkler type.
• [x] (gameplay) Ability to remove default tiles.
• [x] (ui) Don't draw tile on center tile.
• [x] (ui) Add reset button to Sprinkler edit menu.
• [x] (balancing) Quality and Iridium sprinklers should cost less.
• [x] (balancing) Pressure Nozzle should cut cost/do something!
• [x] (fix) Overlapping Sprinkler Range issue
  • (One Sprinkler unwatering another sprinkler's tiles).
• [x] (gamplay) Ability to activate one or all sprinklers manually (same cost).
• [x] (fix) rainy day unwatering
  • Only unwater on default tiles
  • Do not unwater in the rain
• [x] (fix) Do not activate sprinklers if the menu is open
• [x] (fix) Error during launch reported by Chargoal
• [x] (balancing) Default tiles are free Option, suggested by MicomiBite
• [x] (fix) Greenhouse watering/unwatering, reported by hiew32
• [x] (balancing) Default tile count is free, suggested by MicomiBite
• [x] (fix) Clicking the sprinkler in the edit menu adds an extra tile.
• [ ] (multiplayer) Make Master Game responsible for Sprinkler Coverage setting?
• [ ] (ui) Add ability to open coverage menu from config menu?
• [ ] (accessibility) i18n basics.

Versions

2.18.0

• Update to .Net 6
• Added sprinkler cooldown logic to avoid overlapping of sprinkler animations if a sprinkler is activated in quick succession. Configurable via settings.

2.17.2

• Changelog update only.

2.17.1

• fix: Clicking the sprinkler in the edit menu adds an extra tile.

2.17.0

• feat: Default tile count is free, suggested by MicomiBite

2.16.1

• fix: Greenhouse watering/unwatering, reported by hiew32.

2.16.0

• docs: deprecate notice about DataLayers, as the PR has been merged!

2.15.4

• fix: Error during game launch reported by Chargoal

2.15.3

• fix: Do not activate sprinklers on click/check if the menu is open
• fix: Do not activate sprinklers on click/check if an event is active

2.15.2

• fix: unwatering in the rain no longer happens
• refactor(perf): only unwater default tiles
• gameplay: If it's raining, don't run sprinklers or cost

2.15.0

• Add Feature: Activate Sprinklers

2.14.1

• FIX Overlapping Sprinkler Range Issue

2.14.0

• ADD Pressure Nozzle Halves cost of sprinkler

2.13.0

• ADD ability to remove default tiles
• REFACTOR rename SprinklerShapeEditMenu to CoverageEditMenu
• ADD Do not draw center tile in menus
• ADD Menu to reset to default sprinkler coverage (Cross to the left of OK)
• RENAME Max Coverage to "Range"
• REFACTOR Logger to singleton service
• REFACTOR CoverageEditMenu.draw() to use for loop instead of while to avoid inf-looping.
• TRY ADD Pressure nozzle halves cost of sprinkler (does not work yet).

2.11.0

• Add ability to change the maximum range of each sprinkler type

2.10.1

• Fix Showing cost on menu
• Fix click & drag to toggle
• Fix viewport zoom scale
• Fix Generic Mod Config Menu

2.10.0

• First hack at showing cost on menu.
• Fix shift key on click/drag.

2.9.0

• First hack at click & drag to toggle multiple squares at once.

2.8.9

• Refactor RunSprinklers method so it's easier to modify and follow.
• Remove CutOut option, feels unnecessary
• Remove Grid on placement
• Clean up and bugfix where it makes sense to.
• Rename BetterSprinklers to BetterSprinklersPlus everywhere

2.8.0

• Add options for what happens when you cannot afford to run the sprinklers
• Update readme

2.7.1

• Update Documentation.
• Don't show sprinkler cost if cost = 0

2.7.0

• Gut the old Balanced Mode
• ADD a per-day cost for water, water costs money.
• ADD do not sprinkle tiles if we run out of money for water.
• ADD Options to change difficulty and turn on/off these features

2.6.15

• Cleanup the config menu

2.6.14

• Fix divide by zero error (caused by me)
• Improve config options for coverage based balance
• Update default config options to match what (should?) be the default multipliers

2.6.13

• Add a copy of Data Layers with integration
• Raised PR with Data Layers to add support

2.6.12

• Moved to CI
• Fix Controller placement tile overlay

2.6.3 - 2.6.11

• Bug fixes and CI testing

2.6.2

• Fix placement overlay when switching from mouse to controller

2.6.1

• Add Support for Generic Mod Config Menu
  • Add config option for each price multiplier
  • Add config option for showing/hiding the grid on highlight
  • Add Keybind Changes

2.6.0

• Update to .Net 5
• Update License to MIT for this fork.
• Update Pathoschild.Stardew.ModBuildConfig to 4.1.1
• Change TargetPlatform to Any CPU
• SMAPI 4 compatibility:
  • Update SprinklerMod.cs to use Content Interception API
  • Update SprinklerMod.cs to use helper.GameContent.Load
  • Update SprinklerMod.cs to use helper.GameContent.InvalidateCache

Motivation

A fork of Better Sprinklers by Maurício Gomes (Speeder).

The goal of this fork is to maintain and rebuild the current version of Better Sprinklers.

The original developer has understandably lost touch with the mod.

I was starting a modded playthrough and loved the mod, but noticed some bugs shared by the wider community.

I decided to pick up the torch while I'm playing Stardew and give a little back. I'm Updating the mod, fixing the bugs I'm aware of, and adding some features I'd like to see.

r/iama: Senior Software Engineer in the midlands in the UK. A loving father and when the kids are asleep I get a chance to play some games.

You can find more about me at CodesThings.com.

Found a Bug?

Please report it in Github Issues.