Stardew Valley
Help us shape the future of the Vortex mod manager by taking our survey
0 of 0

File information

Last updated

Original upload

Created by

tstaples

Uploaded by

tstaples

Virus scan

Safe to use

About this mod

Keeps your farm clean of pesky weeds and other debris.

Permissions and credits
On each new day this mod will remove all debris and other items from the farm that you specify in the config (see below).

Warning: It may be a good idea to back up your save game as your farm is saved after the items have been removed.

Install
  1. Install the latest version of SMAPI.
  2. Download this mod and unzip it into Stardew Valley/Mods.
  3. Run the game using SMAPI.

To uninstall this mod you can simply delete the "CleanFarm" folder from your Mods directory.

Compatibility
The 1.3-beta version of this mod will work with SDV 1.3 beta and does work in multiplayer (including if multiple people have it).

Note that if multiple people have this mod in multiplayer and one player has the option on to remove something that another player doesn't then it will still be removed. For example, if the host has RemoveGrass set to false but one of the farmers does, then the grass will still get removed.

I'm still not sure the best way to handle that kind of scenario, perhaps restricting it to only the host is best but I'm not sure. if you have any feedback let me know.

Configuration
In this mod's config.json file you will find options to enable/disable which objects are 'cleaned' from your farm. The options are:
{
"RemoveGrass": false,
"RemoveWeeds": true,
"RemoveStones": true,
"RemoveTwigs": true,
"RemoveStumps": true,
"RemoveSaplings": true,
"MaxTreeGrowthStageToAllow": 5, // min 1, max 5
"RemoveLargeLogs": true,
"RemoveLargeRocks": true,
"RemoveBushes": false // Removes the bushes near the shipping container.
"ReportRemovedItemsToConsole": true // Report extra info about what was removed to the console.
}


The MaxTreeGrowthStageToAllow is only used if RemoveSaplings is true. It represents the max growth stage allowed, so any trees with a lower growth stage will be removed. This allows you to remove all seeds but keep existing saplings etc. Only values between 1 and 5 are valid.

The growth stages are:
  • 0 - Seed
  • 1 - Sprout
  • 2 - Sapling
  • 3 - Bush
  • 4 - Small Tree
  • 5 - Tree

For more information on how to modify the config see this page.

Console Commands
  • cf_clean - Runs the clean command manually.
  • cf_restore - Restores the items removed from the last clean command that occured this play session.
  • cf_rload - Reloads the mod config so you can change what to remove on the fly.

You can view the release notes here.
Source code is available here.