Hat Mouse Lacey

Introducing Lacey, a new take on the hat mouse in Cindersap Forest. She's a newcomer to the valley, just like you, and recently bought and renovated the abandoned cabin. She's eager to open her new business making and selling hats!

She's cheerful and polite, but somewhat introverted, so she often keeps to herself. She is passionate about hats, and full of opinions about them. She loves good food and therefore admires Gus. Autumn is her favorite time of year, and she likes to spend time outside. But, sometimes it's hard being the only four-foot talking mouse.

Unlike the vanilla hat mouse (a map sprite), Lacey is a full-fledged friendable NPC with plenty of dialogue — including unique commentary on every vanilla hat and some modded ones — and a full set of heart events. She is also eligible for marriage; almost no one will comment on that, because it's not weird unless you make it weird.

If this is your first time playing with Lacey, I recommend a new save for the best experience, since she has some Year 1 dialogue.

I also recommend not snooping around in the mod files, since you may find spoilers in there, and I think it's fun to discover things and be surprised. Of course, if you like spoilers, be my guest; I can't stop you.

Special Thanks and Acknowledgements

• u/Aglet_Green, who made this Reddit post which directly inspired this mod.
• elizaphantomhive (Discord) and MriaMoonrose (Nexus) for bugfinding.
• All the other weirdos (affectionate) in the Stardew Valley Discord server.

Thanks to the following contributors for providing translations:

• Turkish: Rupurudu

My thanks as well to the following mod authors:

• Gweniaczek of Way Back Pelican Town
• Elle of Elle's Town Buildings
• YriKururu of Project Yellog
• Dolphin Is Not a Fish of Mouse Friends in the Forest

... who have given me their gracious permission to, where necessary, include derived versions of some of their mod assets in this mod. These files are NOT covered by this mod's MIT license, since they are derivative works used by permission.

For a full list of files which this mod's permissive license DOES NOT cover, see the file nonlicensed.txt.

Requirements

• Stardew Valley 1.6.9+
• SMAPI (4.1.0+) (the mod framework for Stardew Valley)
• Content Patcher (2.4.0+)
• (optional, since 1.3.0) Secret Note Framework, for some extra bits of lore

If you are using the legacy branch (1.5.6) of Stardew Valley, use the 1.1.3 release of this mod; that is the latest one compatible with the previous game version.

Installation

Download the latest release and unzip it into your Mods folder. It contains two folders:

• HatMouseLacey
• HatMouseLacey_Core

(If you see folders called CP, SMAPI, docs, etc. instead, that's the source code zip. Use the other one for installing to your game.)

HatMouseLacey is a Content Patcher content pack, which handles all of the content: images, maps, text, music, event scripts, etc. HatMouseLacey_Core is the C# mod which makes all the code changes necessary for Lacey's special features.

Configuration

Hat Mouse Lacey supports the following config settings.
Note that the former AlwaysAdopt setting has changed to ChildPolicy.

• DTF: true/false (default true). If true, enables some suggestive (but not explicit) dialogue. Set to false to keep it G-rated.
• ChildPolicy (formerly AlwaysAdopt): one of ByGender, AlwaysAdopt, or AlwaysPregnant (default ByGender). This controls how Lacey will approach having children with the farmer: the default is to check the farmer's gender just like vanilla spouses (so, with a male farmer, she will become pregnant). AlwaysAdopt will cause her to adopt children, and AlwaysPregnant will cause her to get pregnant, in both cases ignoring the player's gender entirely. If Lacey gets pregnant and gives birth to children, they will be mice, but due to how the game works, you can change this setting at any time before the child arrives without issue (and if you make a mistake, you can fix your children with a console command).
• RecolorPalette: one of Auto, Vanilla, Earthy, VPR, Starblue, or Wittily (default Auto). If set to Auto, this mod will attempt to detect which recolor mod you are using and match it. If you get the wrong result, you can manually set it to the desired value.
• InteriorPalette: one of Auto, Vanilla, Earthy, VPR, or Starblue (default Auto). This is just like RecolorPalette, but attempts to detect and match enabled interior recolors. (Wittily does not recolor interiors, so it is not listed as an option)
• MatchRetexture: one of Auto, Vanilla, WaybackPT, ElleTown, YriYellog, or FlowerValley (default Auto). This is like RecolorPalette, but it matches active building retextures that apply to the mouse house. As with the others, set manually if Auto does not detect your situation.
  NOTE: Elle's Town Buildings and Yri's Project Yellog will only be detected by Auto if you have set their respective config settings to retexture the mouse house (for Yellog, you will need HatMouseHouseRestored). Otherwise, you'll get the vanilla appearance.
• PortraitStyle: one of Auto, Nouveau, Nyapu, or Classic (default Auto). Controls which set of portraits to use. Auto will choose between Nouveau and Nyapu depending on whether Nyapu's Portraits are installed.
• SeasonalOutfits: true/false (default false). Enables Lacey's optional alternate outfits for summer and fall. The winter outfit is automatically enabled, since those are vanilla.
• WeddingAttire: one of Dress or Tuxedo (default Dress). Choose which outfit Lacey will wear to her wedding.
• MarkUnseenHats: true/false (default true). If true, hats in your inventory will be drawn with little icons of Lacey's face if you have not yet shown them to Lacey to get her reaction. Does not work with Fashion Sense hats, since they live in hammerspace (mirrorspace?).
• CollapseHatRegistry: true/false (default true). If true, the hat registry menu will avoid showing you duplicate modded hats (that is, hats which Lacey considers the same, or trivial variants).

These config settings will be read from the HatMouseLacey_Core mod's config.json. The Core mod will appear in the Generic Mod Config Menu, if you have that installed. The settings will apply to both mods.

Using Generic Mod Config Menu is highly recommended! It's much easier than editing your config.json by hand, and starting in 1.5, Lacey features live previews in GMCM of which sprites and portraits you have enabled.

Compatibility

✓ Fully supported
⤳ Partial or in-progress
✗ Expect breakage or major issues

Mods marked with EWONTFIX have conflicts I am not (currently) attempting to resolve.

Even mods listed as incompatible and/or EWONTFIX probably won't break your game, but please let me know if they do.

Up-to-date compatibility patches:

• ✓ Stardew Valley Expanded
  Added fixes for things that broke in 1.6. Should still be fully compatible.
• ✓ East Scarp
  Fixed a few festival collisions, and repaired one that broke since 1.5.6.
• ✓ Generic Mod Config Menu Fully compatible and highly recommended. Featuring live preview!
• ✓ Mods which add other mouse characters! Some of Lacey's lines change to acknowledge the existence of other mice if they are installed. Featuring:
  • ✓ Mouse Friends in the Forest
    Also adds a small crossover event.
  • ✓ Fievel Goes East Scarp
    Also adds a few lines and a small crossover event.
  • ✓ Hat Mouse and Friends
    No special content other than the dialogue edits, but it makes more sense now.
  • ✓ (unreleased Wildflour mod)
    No special content (yet!).
  • ✓ Cap Mouse
    No special content.
  • Please let me know about other mouse characters that I missed, so that Lacey can detect them.
• ✓ They Deserve It Too
  Works alongside Hat Mouse and Friends.
• ✓ Vibrant Pastoral Redrawn
  Updated to correctly detect VPR's new config setup.
• ⤳ Mods altering the terrain around the mouse house (including Cape Stardew and maybe others)
  Lacey's map edits are now set to late priority, so they will apply after normal-priority terrain edits.

Compatibility status as of version 1.1.3/SDV 1.5.6 (may still work, but have not been thoroughly tested in newer builds):

• ✓ Ridgeside Village
  Lacey attends the RSV festivals.
• ✓ Multiple popular map recolors:
  DaisyNiko's Earthy Recolour
  Vibrant Pastoral Recolor see Vibrant Pastoral Redrawn, above
  Starblue Valley
  A Wittily Named Recolor
  Additional recolors may be supported in the future.
• ✓ Multiple popular building retextures:
  Way Back Pelican Town
  Elle's Town Buildings
  Yri's Project Yellog
  Flower Valley
  Additional retextures may be supported in the future.
  NOTE: for Elle's Town Buildings and Project Yellog, you will need to set their config values for the mouse house. See Configuration, above.
• ✓ NPC Map Locations
• ✓ Stardew Valley Reimagined 3
• ✓ Community Center Reimagined
• ✗ Mods which replace or redesign the vanilla hats (Lacey's comments are written for the unmodified versions)
• ✗ Mods which add an interior map to the shack
  (incompatible vision; EWONTFIX)
• ✗ Hat Shop Restoration
  (incompatible vision; EWONTFIX)
• ✗ Fashion Mouse
  (incompatible vision; EWONTFIX)
• ✗ Unique Children
  This mod reimplements child sprites entirely, overriding my patch to provide custom sprites. EWONTFIX, manual compatibility only; see that mod's instructions.

Other Questions You May Have

What modded hats does Lacey have commentary for?

The list of supported hat mods is here.

I need help with <problem>. What should I do/Can you help?

There is a spoiler-filled help file. (WARNING: spoilers!) It has some tips and information in it.

If you have found a bug (including compatibility problems), please open a ticket.

I also frequent the Stardew Valley Discord server. I'm probably in #making-mods-general or #modded-farmers; you can ask me for help or report problems to me there as well.

Is this compatible with <mod name here>?

If it's not listed above, under Compatibility, the default answer is "probably, technically". What that means is that I don't expect this mod to crash your game or break much of it, but there may be asset conflicts, weird behavior, or lore clashes.

This even applies to mods above which I have listed as incompatible and/or EWONTFIX. Your game should still run and most things should still work. But it may be jarring, especially if those kinds of errors greatly bother you.

If you find any compatibility problems with mods not listed above, I would be much obliged to you if you let me know.

What about multiplayer?

Everything works correctly, as far as I know. Special thanks to MriaMoonrose for helping out.

kind of a weird decision to make the mouse datable

That's not a question.