Grimshire Tweaks

This is a mod for Grimshire that adds various QoL improvements and customization options without affecting core gameplay. See the Features section for details.

• Installation
• Features
  • Quality of life
  • Control tweaks
  • Fixes and other changes
  • Features for developers
• Configuration

Installation

The mod currently targets game version v0.28.11; beta versions are untested (but might still work).

• Download the latest version from the releases page
• Extract the contents of the zip to the game folder (right-click Grimshire in your Steam library -> "Manage" -> "Browse local files")
  • The included BepInEx is a modloader for Unity, you can alternatively get it from their repo; the additional shipped .dlls are unstripped assemblies from Unity required for it to run with Grimshire
  • If you already had BepInEx installed, you only need to copy GrimshireTweaks.dll file to \Grimshire\BepInEx\plugins\

If you've done everything properly, after launching the game you should see the plugin name & version in the title screen by the settings button:

Features

Below is a list of features of the mod; most can be toggled through a settings file as described below.

Quality of life

• The crafting table can now use ingredients from chests on your farm; no need to have everything in your player inventory

  • Items from your inventory are taken first
  • If an ingredient from the recipe is fulfilled by items in chests, it'll be highlighted in green to indicate so:

  

• The ⬆️ button in the cooking UI can prioritize pulling ingredients with lowest stamina value (averaging the player & villager values)

• Giftable items can show who likes the gift in the inventory panel (if you've discovered the gift is liked), so you don't have to check the relationships tab as often:

  

• Added a "quick-stack" hotkey that moves items from your inventory onto nearby chests that already have stacks of those items (defaults to G)

  • Settings exist to prevent quick-stacking food that spoils or items in the toolbar (1st inventory row), and you can also adjust the range
  • You can alt-click items in the inventory UI to mark their type as "favorited", which prevents them from being quick-stacked. Favorited items are denoted by a star by their name in the inventory & tooltips.
  • Currently the only feedback for quick-stacking is a sound + notification showing how many stacks were moved:

  

• Villagers you haven't spoken to today yet can show a speech bubble when moused over (disabled by default):

  

• The collection log can highlight unobtained fish/critters/seeds that are currently in season

  • Additionally, unobtained fish can show their habitat as a hint for where to find them:

  

• Compostable items can show their compost quality value in the inventory and tooltips (while the composter UI is open):

  

• Holding the scythe can highlight harvestable crops, in case you find the harvestable sprites hard to distinguish (disabled by default):

  

• Items can show their sell price in the details panel in the inventory UI, even when outside shop UIs (disabled by default)

• You can customize the text speed of dialogues in the settings file, so you can adjust it to match your reading speed

  • Animal speech noises will try to play at the original frequency (they won't play sounds faster/slower)

• You can enable a "It's getting late..." notification to show when the clock hits 10PM, just so you don't forget to go to bed :P

• You can disable the "Equipped <X>" tool notifications.

• You can enable a reminders widget for certain tasks/info, which will display in the pinned quest UI. You can show the following reminders there (configurable independently):

  • Showing tomorrow's weather (after learning it from Percy)
  • Character birthdays
  • Critter waiting to be picked up from Tano (pro tip: it always takes 3 days)
  • Tool upgrades waiting to be picked up
  • Crops that need watering
  • Warning for empty troughs

  

Control tweaks

Most of these are disabled by default.

• In dialogues, you can press the Enter key to advance to the next line (as if clicking), and the Esc key to select options like "Nevermind", "No", etc. to dismiss choices quicker (English-only for now)
• You can invert the toolbar scroll direction, such that scrolling down moves to the slot on the right
  • This also applies to scrolling tabs in the pause menu
• You can auto-open/close gates when going near/away from them
• You can reduce the cooldown for left-clicking in UIs, so you can ex. swap items around in the inventory quicker
• You can make the player run by default instead of walking

Fixes & other changes

• If the cursor is over the toolbar, clicking a slot will no longer also try to interact with an object in the world
  • This fixes accidentally interacting with stuff while you're trying to switch slots by clicking them
• Added a setting to skip the splash screen, mostly useful to speed up testing while modding

Fixes for older game versions that have since then been addressed by the developers:

• Optimized the checks for placing objects, reducing the massive lag that occurs when placing ex. tree seeds
  • Placement checks now occur only when the placement cursor moves to another tile, instead of 20 times per second
  • The Physics2D.OverlapCircle() calls were also replaced with non-alloc variants to reduce lag spikes from GC
  • This works under the assumption that the world grid cannot change while the player is holding the object to place, which AFAIK is the case (only the player can place/destroy objects?)
• The WeatherSystem.IsInteriorScene() calls were replaced with a version that caches the LightSystem reference to avoid massive lag from FindObjectOfType calls (it's one of the most counter-intuitively expensive calls in Unity)
  • This is mostly noticeable when placing objects as well
  • This problem was now addressed by the developers in v0.28.11.

Features for developers

• The AutoLoadSave setting allows you to auto-load a save when the game starts, to speed up testing
  • You can set a specific file to be used through the AutoLoadSaveFileName setting; otherwise, the most recent save will be loaded

Configuration

After launching the game at least once with the mod, a config file will be created in \Grimshire\BepInEx\config\GrimshireTweaks.cfg where you can configure most of the mod's features. You need to restart the game to apply any changes.

Note that some features are disabled by default, mainly changes to controls.

Note

Support for changing settings in-game is planned for a future update.

Licensing

"Acute Owl Studio" may use any source code from this repository without needing to give any attribution.