Grow: Song of the Evertree
0 of 0

File information

Last updated

Original upload

Created by

aracham

Uploaded by

aracham

Virus scan

Safe to use

About this mod

Adds configuration options, allowing players to override district limits on Buildings, Paths and Decorations.

Optional settings allow the player to build outside districts, ignore per-district copy limits, and remove myora/essence costs for buildings and decorations

Requirements
Permissions and credits
Changelogs
This mod adds configuration options to override the hard-coded building limits for your districts.   

Default mod behavior is to raise the decoration limit from 40 to 60 with no user action required, but much more is possible!


No game files are directly altered by this mod, a commonly-used patching tool called BepInEx is used to temporarily load changes into the game on launch.

Features
  • Change building limits for Buildings/Decorations/Paths (affects all districts)
  • [optional] Enable/Disable building outside district boundaries
  • [optional] Ignore per-district limits on number of copies for a buildable item
  • [optional] Eliminate Myora/Essence costs for placement of Buildings/Decorations/Paths
  • [optional] Eliminate consumption of Town Decorations on placement


Installation
Players can follow the instructions below for manual installation.  We hope to get Grow added to Vortex Mod Manager at a later time to automate this process.

[Manual install] Adding BepInEx:
  • Navigate to BepInEx' latest release page on GitHub
  • Download the _x64_ affixed zip file
  • Unzip the file to get the folder inside using your preferred program of choice
  • Copy all files/folders within the resulting folder
  • Navigate to Grow's root directory in your steam directory (default: C:\Program Files (x86)\Steam\steamapps\common\Grow Song of the Evertree
  • Paste the copied files/folders into the root directory
  • If these instructions are no longer up to date, you can reference BepInEx's installation guide for more info.

[Manual install] Adding the mod:
  • Manually download the zip file containing Grow-ConfigureLimits.dll from NexusMods
  • Unzip and copy the .dll file found within
  • Navigate to the BepInEx\plugins folder that now exists in Grow's root directory and paste the .dll into this folder
  • Launch the game to generate the configuration file and enjoy the new default limit of 60 decorations!

[(Recommended) Manual install] Adding BepInEx Configuration Manager:
  • Navigate to BepInEx' latest release page for Config Manager
  • Download the .zip file which includes Configuration Manager
  • Unzip the file, then copy the .dll and .xml file found within
  • Navigate to the BepInEx\plugins folder that now exists in Grow's root directory and paste the .dll and .xml files into this folder
  • Launch the game to generate the configuration file and enjoy easy editing of mod variables on the fly!


Config
A config file (aracham.bpx.Grow-ConfigureLimits.cfg) is created in the folder BepInEx\config after running the game once with this mod.

You can adjust the build limit values (and enable optional settings) by editing this file using Notepad or any text editor, changes will be reflected after saving the file and restarting the game.

Alternatively, these options can be accessed and altered in-game using the optional Config Manager (access by pressing F1 once at the title screen, click outside config window to dismiss).

After updating values using Config Manager, a game restart will be required for changes to take effect.

Limits support any numeric value (e.g. 0-9999), setting flags require a 0 (inactive) or 1 (active) value.

Limits set below default values (20/40/500) will be ignored, settings values other than 1 or 0 will be treated as 'inactive'.


Important Notice
While all efforts have been made to ensure compatibility with normal play and a stable experience, modding your game comes with inherent risk that the user accepts by installing this mod. 

When adjusting build limits, consider what your computer's hardware can support!  900 built decorations may not be the best idea for an older laptop, though a state-of-art desktop might handle this without issue.  When in doubt, go slow and remove decorations if you start to see frame-rate impacts.

For extra security, be sure to create backup copies of your save files (location: C:\Users\<username>\AppData\LocalLow\505 Games\Grow_ Song of the Evertree) prior to installation.


Additional Alert
Building above default limits (20/40/500) then reducing limits below your in-game counts for these objects is not recommended.

Taking this action may result in unexpected culling of placed buildings/decorations/paths and can result in unstable saves. 

If uninstalling this mod, practice good save hygiene and reduce in-game district counts equal to or below 20 buildings / 40 decorations / 500 paths first to avoid bad outcomes.


Licensing/Legal
Please  contact me and obtain my permission before re-packaging or distributing any part of this mod.

Explicit approval is needed before uploading this mod to other sites.


Additional Thanks
Credit to @Bleh (discord #8648) from the Grow:Song of the Evertree discord server for pioneering efforts to locate the methods/fields needed to make this mod exist.


More Info
Github Repo - Source Code for Configurable Build Limits
Steam Purchase Page - Steam page for purchasing the game
Community Discord - Where all the Grow folks hang out (best place to contact me for questions/notify me of bugs)


Technical Details
Methods overridden (return only):
  • DistrictTemplate.get_MaxBuilding()
  • DistrictTemplate.get_MaxDecorators()
  • DistrictTemplate.get_MaxPaths()
  • BuildableObjectBounds.IsInBuildArea()
  • OBJ_DistrictActorBase.IsInBuildArea()
  • TownMenu_State_Build.Check_CanPlaceInternal()
  • TownMenu_State_BuildMove.Check_CanPlaceInternal()
  • TownMenu_State_Build.DeductCost()

Known Incompatibilities:
None at present