# Basic-Sprinkler-Improved
Stardew Valley mod to improve functionality of basic sprinkler.

1. INTRODUCTION

Basic Sprinkler Improved changes the way the basic sprinkler works without making it cover any more area than it does in the base game. I always found the most annoying thing about it to be the shape, which was just useless. But while there are a number of fine mods out there that change the way the sprinkler works, they all make it cover more total area, which seemed a bit overpowered to me. So I made this for my personal use.

It's hoped that in addition to making the basic sprinkler more useful, the different patterns one can make with them will give them a niche so they can still be useful even when you get improved sprinklers. However, if I'm being honest, I'm kinda updating this for posterity and not for my own use. Because of the need to reconfigure the watering area rather than just adding to it, there's an "unwatering" step that seems daunting to do in a way that does not interfere with other watering devices. On the other hand there's a mod called "Line Sprinklers" that does more or less what I would want to do with this mod, and more. So give this a try, but know that there are other options out there.

Source code is included in the install package and available here: https://github.com/littleraskol/Basic-Sprinkler-Improved

2. CONFIGURATION

Note that while this section refers to the config file, you can change settings in game using the Generic Mod Config Menu (GMCM) interface.

The mod works by watering tiles according to one of the following configurations. (The X represents the sprinkler and the Os the tiles it waters while each * represents an unwatered tile.) These configurations are set in the file config.json

horizontal:

*****
*****
OOXOO
*****
*****

vertical:

**O**
**O**
**X**
**O**
**O**

north:

**O**
**O**
**O**
**O**
**X**

south:

**X**
**O**
**O**
**O**
**O**

east:

*****
*****
XOOOO
*****
*****

west:

*****
*****
OOOOX
*****
*****

The config.json file by default makes the mod use the "horizontal" configuration. To change that, change the "patternType" item. The valid types are: "horizontal", "vertical", "north", "south", "east", "west", and "custom", which deserves more explanation.

The four items in the config.json called "northArea", "southArea", "eastArea", and "westArea" define possible alternative configurations. You need to set the "patternType" to "custom" for this to work. Then you need to provide values. Whatever value you put in the appropriate direction is how many tiles it will water in that direction. However, it won't let you water more than 4 tiles total.

For example, with this configuration:

"patternType": "custom",
"northArea": 2,
"southArea": 0,
"eastArea": 2,
"westArea": 0

The sprinkler will produce this pattern:

**O**
**O**
**XOO
*****
*****

If you don't set the "patternType" to "custom" then the numbers will be ignored entirely.

Changes to config.json will only take effect after restarting the game.

3. KNOWN ISSUES

*Can't do anything with the sprinkler's animation to make it match how it actually works, I'm afraid.
*There is a possibility that a basic sprinkler may "unwater" parts of the pattern of another kind of sprinkler. Don't put basic sprinklers within or adjacent to the watering area of another sprinkler.

4. FUTURE PLANS

*Something I would like to do is make it more dynamic in handling config changes. Currently, it only applies changes when you restart the game or (with GMCM) when you exit to the title screen and change them.

5. CREDITS

Based closely on work of OrSpeeder (maker of Configurable Improved Sprinklers) and ADoby (maker of Simple Sprinkler). The method overall is my own but without their pioneering work, I probably wouldn't have been able to make heads or tales of anything. If you want a different take on changing up how sprinklers work, definitely check them out.

Configurable Improved Sprinklers: http://community.playstarbound.com/threads/configurable-improved-sprinklers-scarecrow-and-sprinklers-area-highlights.112443/
Simple Sprinkler: http://community.playstarbound.com/threads/smapi-simple-sprinkler.110326/

6. LICENSE

Basic Sprinkler Improved is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

For information on this license, see:

Basic Sprinkler Improved mod is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

7. CHANGE LOG

Version 2.1.0 (9/16/20)
-Settings can now be changed in game using Generic Mod Config Menu.

Version 2.0.0 (9/13/20)
-Version to 2.0 (new API).
-Including default config file.
-Update keys added to manifest.
-Locations logic updated to include indoor and outdoor locations in search.
-Distinguishes between outdoor and indoor areas to handle rain appropriately.

Version 1.0.? (6/12/17)
-Removed deprecated function, replaced with new function.

Version 1.0.1 (3/5/17)
-Fixes an issue where modified basic sprinklers were un-watering other basic sprinklers' watering areas. Note that there may still be an issue with a basic sprinkler un-watering parts of the pattern of another kind of sprinkler. I plan on fixing this eventually, but for now, as a workaround, don't put basic sprinklers within or adjacent to the watering area of an improved or iridium sprinkler.

Version 1.0.0 (1/18/17)
-Now handles rainfall correctly, whether scheduled or forced by totem.
-Mod will now more robustly support changes in configuration.
-Fixed an issue with "mirroring" the north and south directions.