Informant

A mod that displays additional information on various objects. It marks inventory items that are still necessary for the bundle, calculates how many days are still left until the harvest and displays what is in a machine and how much time is left on it.

This mod also provides a handy API to extend its functionality.


The mod is automatically present in the game. You just need to move the mouse over the object you wish to get the information from.

If you don’t like one or more of the displayed information (or worse, if there are conflicts with other mods), you can disable each type.


Decorators

There are some decorators, i.e. images displayed on the regular item tooltip, that have a specific meaning:

• 
  Bundles Decorator - displayed when the item is still needed for the bundles
• 
  Field Office Decorator - displayed when the item is still needed for the island field office
• 
  Museum Decorator - displayed when the item is still needed for the museum
• 
  Rarecrow Decorator - displayed when the item is still needed for the rarecrow collection
• 
  Shipping Decorator - displayed when the item was not yet shipped
  

For the Bundles Decorator, there is the option to show it on items needed for still locked bundles. On default, the decorator is only shown for the bundles you have access to, to keep it fair and balanced.


Tooltips

You can also configure the tooltip “trigger”, i.e. if you want the tooltip to show when the mouse hovers over an object, or if you want to press a key. You can also select the key to press.

On default, of all the big craftable objects in the game, only machines that produce something will get a tooltip. You can configure that to include all craftable objects, or all except chest (if you have a mod that shows specific information for them already).



Configuration

If you wish to configure this mod, it’s advised to install spacechase0’s Generic Mod Config Menu. Then there will be a config page.

But if you wish to change the config.json file manually, you can also do that. The config.json with all entries is documented here.



Versions

• Future (Issues):
• 1.4.0 (Issues): Add rarecrow and field office decorators
• 1.3.3 (Issues): Portuguese translation and bugfixes
• 1.3.2 (Issues): Translations (add French translation; update Korean translation)
• 1.3.1 (Issues): Bugfixes (fix config for “new” recipe; fix fruit tree calculation on Ginger Island; make decorator display shipped item needed for “ship 15 of everything”; fix time remaining for casks; fix ginger tooltip)
• 1.3.0 (Issues): Additional information (marks uncrafted recipes, shipping decorator, shows icons on tooltips)
• 1.2.2 (Issues): Turkish translation
• 1.2.1 (Issues): Chinese translation
• 1.2.0 (Issues): Sell price feature
• 1.1.1 (Issues): Bugfixes from NexusMods feedback
• 1.1.0 (Issues): Split-screen & API fixes
• 1.0.0 (Issues): Nexus Release
• 0.4.0 (Issues): Prepare for Nexus Release
• 0.3.0 (Issues): Strutured PoC
• 0.2.0: Crop Informant
• 0.1.0: Bundle Informant
  

(All issues can be found here.)



Translator Guide

Right now, not all translations are provided. If you want to help, translate either file in the i18n/ and test it right in your Stardew Valley (the same folder exists in your Mods/ folder). You can than provide it to me via pull request or email.

• English (default): ✅
• German (de): ✅
• Spanish (es): ?
• French (fr): ✅ (thanks to ArndGlh)
• Hungarian (hu): ?
• Italian (it): ?
• Japanese (ja): ?
• Korean (ko): ✅ (thanks to brighteast99)
• Portugese (pt): ✅ (thanks to Mikeliro
• Russian (ru): ?
• Thai (th): ?
• Turkish (tr): ✅ (thanks to ExaBronto)
• Chinese (zh): ✅ (thanks to gottyduke)
  

Developer Notes

Can be found here.

The source code for this mod is on GitHub.



License

This project is licensed under the MIT License - see the MIT license for details.