Skip to content

Latest commit

 

History

History
170 lines (147 loc) · 9.3 KB

File metadata and controls

170 lines (147 loc) · 9.3 KB

logo

Daily Screenshot v3.1.0

A Stardew Valley mod that automatically takes a screenshot of your entire farm at the start of each day.

Releases can be found at the following websites:

For Android users, releases can be found at the following websites:

Features

  • One screenshot is automatically taken of your entire farm every day as soon as you leave your house.
  • Super easy to gather screenshots to create a GIF that shows how your farm changes over time! GIF makers can be found online, such as ezgif GIF maker. Here is an example.
  • Customizable! Change any number of default settings based on your preferences. Examples:
    • What time of day to take screenshot.
    • How often to take screenshot (daily, weekly, monthly, etc).
    • Keyboard shortcut that takes screenshot when pressed (set to "None" by default).
    • What weather conditions are allowed. It is common to allow all except rainy/stormy days, but default option allows all weather.
    • Add multiple sets of rules (example, 1 set for daily automatic screenshots, 1 for manual key-press screenshots).
  • Compatible with the "Generic Mod Config Menu" mod, which adds an in-game UI for easily updating the config.
  • Screenshots are sent to your StardewValley/Screenshots folder, with each save file getting its own "FarmName-Screenshots" folder. Screenshots between multiple save files will not get mixed up.
  • Easily access the screenshots in-game by scrolling to the bottom of the "Options" tab in the menu and clicking the "Open Destination Folder" button.
  • Keeps the screenshots in the correct order to make creating the GIF easier. This is achieved by naming each screenshot with a "year-season-day.png" numerical format. For example, on Year 1, Winter, Day 3, the screenshot would be named "01-04-03.png".

Installation

  1. Install the latest version of SMAPI.
  2. Download Generic Mod Config Menu and unzip it into Stardew Valley/Mods. (recommended, but optional)
  3. Download this mod and unzip it into Stardew Valley/Mods.
  4. Run the game using SMAPI.

Compatibility

  • Works with Stardew Valley 1.4 or later on Linux/Mac/Windows.
  • Works in both single player and multiplayer.
  • No known mod conflicts.
  • Works with the Generic Mod Config Menu.

Configuration File

The file structure

You can add as many rules as you would like. The config file looks like:

{
  "AuditoryEffects": true,
  "VisualEffects": true,
  "ScreenshotNotifications": true,
  "SnapshotRules": [
    {
      "Name": "Daily Farm Picture",
      "ZoomLevel": 0.25,
      "Directory": "Default",
      "FileName": "Default",
      "Trigger": {
        "Days": "Daily",
        "Weather": "Any",
        "Location": "Farm",
        "Key": "None",
        "StartTime": 600,
        "EndTime": 2600
      }
    },
    {
      "Name": "Keypress Picture",
      "ZoomLevel": 1.0,
      "Directory": "/home/hailey/SDV",
      "FileName": "None",
      "Trigger": {
        "Days": "Daily",
        "Weather": "Any",
        "Location": "Any",
        "Key": "P",
        "StartTime": 600,
        "EndTime": 2600
      }
    }
  ]
}

Note: Older configuration files (from prior to v2.0) will automatically be upgraded to the newer format when you upgrade to v2.0 or later.

For more examples of ways to customize the config.json file, see the Examples from the GitHub Wiki!

Triggers

Triggers are things that must happen for a screenshot to take place. All of the conditions must be true. Automatic screenshots (without a key press) happen at most once a day. Manual screenshots (with a key press) can be taken multiple times.

Setting Description Type Default Setting
AuditoryEffects Global setting (applies to all screenshots). Whether a camera sound plays whenever a screenshot is taken. bool true
VisualEffects Global setting (applies to all screenshots). Whether the screen flashes whenever a screenshot is taken. bool true
ScreenshotNotifications Global setting (applies to all screenshots). Whether a notification is displayed whenever a screenshot is taken. bool true
Name What to show when taking a picture. Rules without a name will be given a name automatically. string Unnamed Rule #
ZoomLevel How should the picture be scaled. Any number between 0.01 and 1.0. The smaller the number, the smaller the picture (smaller pictures take less disk space). float 0.25
Directory Where to save the picture.

Default or empty means the standard Startdew Valley screenshot directory.

Note: Make sure to use a double backslash on Windows.
string Default
FileName A combination of values for the filename, separated by commas.

Possible values are: None, Date, FarmName, GameID, Location, Weather, PlayerName, Time, UniqueID.

Will follow the pattern: {FarmName}-{GameID}/{Location}/{Weather}/{Player Name}-{Date}-{Time}-{Unique ID}
enum Date, FarmName, GameID, Location
Days A combination of values for the days and seasons to take a screenshot.

Possible values are: Day_1 .. Day_28, Mondays, Tuesdays, Wednesdays, Thursdays, Fridays, Saturdays, Sundays, FirstDayOfTheMonth, LastDayOfTheMonth, Spring, Summer, Fall, Winter, AnySeason, AnyDay, Daily.

Note: It is important if not using the daily value to specify season(s) and day(s) or a picture will not be taken.

Example: To take a picture on the 15th of fall use Day_15, Fall.
enum Daily
Weather A combination of values for the weather.

Possible values are: Sunny, Rainy, Windy, Stormy, Snowy, Any.
enum Any
Location A combination of locations to take a picture. Picture will be taken when going to one of these locations.

Possible values are: Farm, Farmhouse, Greenhouse, Beach, FarmCave, Cellar, Desert, Museum, CommunityCenter, Town, Mountain, Mine, MineShaft, IslandWest, IslandFarmhouse, IslandFieldOffice, Unknown, Any.

Note: Unknown includes any locations not listed above.
enum Any
Key Key press to look for to take a picture. If set the picture will be taken on demand and not automatically.

Possible values: List of possible keybindings
enum None
StartTime Earliest point at which to take the picture. The time cannot be more than EndTime and must be less than 600. Must be an increment of 10. int 600
EndTime Last point at which to take the picture. The time cannot be less than StartTime and cannot be more than 2600. Must be an increment of 10. int 2600

Contributors

Thank you so much to everyone who has contributed to this mod!

CompSciLauren
Lauren Vu
kins-dev
Scott Atkins
dv297
Daniel Vu
atravita-mods
Atravita-Mods
f3wer
F3wer
vahtos
Glen Adams

If you're interested in contributing, please see Contributing.md. Thanks!