Secret Note Framework

Secret Note Framework

This framework is a tool for mod authors to use to easily add highly-customizable Secret Notes to their mods for players to find.

If you are a user: you are probably here to fulfill requirements for another mod. Download, unzip, and enjoy!

If you are a mod author: please consult the author guide for documentation and examples, and please find me (ichortower) on the Stardew Valley discord server if you need help. To report a bug, please use the Bugs tab or the GitHub repository.

Special thanks, as always, to everyone on the Stardew Valley discord.

Capabilities

In addition to avoiding conflicts with other mods, here are some things you can do with this mod that are difficult or impossible to do normally:

• [](optionally) specify complex eligibility conditions on a note-by-note basis with game state queries

  []determine the specific locations (or location contexts) where your notes can appear

  []use different (custom) items to represent different sets of notes, as desired

  []specify your own assets for note content and formatting, including image notes

  []create notes with an image as well as a small amount of text

  []set any number of trigger actions to be run when a note is first read

  Requirements

  • []Stardew Valley 1. 6. 9+

    []SMAPI 4. 1+

    []Content Patcher is highly recommended for authors. It's not required, but you already have it

    Secret Notes are one of the few types of game data left in Stardew Valley 1. 6 that are required to have integer IDs. Right away, this means any two mods that wish to add secret notes face a coordination problem, but there are some other issues too:

    • []the ID is overloaded and also determines the type of note it is (any ID >= 1000 is a Journal Scrap and spawns in the Island location context; any lower ID spawns elsewhere)

      []the ID also determines the note's label in the collection menu

      []all secret notes must share the same image texture (for picture notes)

      []the secret notes tab in the collection menu knows there are only 38 notes, and is set up to draw only one page

      []I probably forgot some, secret notes are not ideal

      I discovered these infelicities when I set out to add some secret notes to one of my other mods, and I couldn't resist trying to fix the problem, so here we are.

      Translation Credits

      The following non-English lang