Skip to content

Commit

Permalink
Documentation (#35)
Browse files Browse the repository at this point in the history
* Update dependencies

* Add contributors file

* Add contributing file

* Update version number

* Update wording in Features section
  • Loading branch information
CompSciLauren committed Mar 11, 2020
1 parent d744d26 commit 0678ef6
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 11 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Get started contributing!

:+1::tada: Thanks for your time! :tada::+1:

These are a set of guidelines, not rules, for contributing to this project. Use
your best judgment and feel free to propose changes to anything in this project
(including this document)!

### Got improvements?

* Open a new [pull request](../../pull/new) with the change.

### Bugs or suggestions you can't solve?

* **Ensure it was not already reported** by searching under [Issues](../../issues).

* If you're unable to find an open issue addressing the problem, [open a new one](../../issues/new).

### Code of Conduct

By participating, you are expected to uphold the [code of
conduct](CODE_OF_CONDUCT.md).

Please report unacceptable behavior.

### Thank you!
2 changes: 2 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Lauren Stephenson [@CompSciLauren]
- Scott Atkins [@kins-dev]
5 changes: 3 additions & 2 deletions DailyScreenshot/DailyScreenshot.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
<DefineConstants>DEBUG;TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<LangVersion>7.1</LangVersion>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType>
Expand Down Expand Up @@ -57,11 +58,11 @@
<None Include="packages.config" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Import Project="packages\Pathoschild.Stardew.ModBuildConfig.3.0.0\build\Pathoschild.Stardew.ModBuildConfig.targets" Condition="Exists('packages\Pathoschild.Stardew.ModBuildConfig.3.0.0\build\Pathoschild.Stardew.ModBuildConfig.targets')" />
<Import Project="packages\Pathoschild.Stardew.ModBuildConfig.3.1.0\build\Pathoschild.Stardew.ModBuildConfig.targets" Condition="Exists('packages\Pathoschild.Stardew.ModBuildConfig.3.1.0\build\Pathoschild.Stardew.ModBuildConfig.targets')" />
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
</PropertyGroup>
<Error Condition="!Exists('packages\Pathoschild.Stardew.ModBuildConfig.3.0.0\build\Pathoschild.Stardew.ModBuildConfig.targets')" Text="$([System.String]::Format('$(ErrorText)', 'packages\Pathoschild.Stardew.ModBuildConfig.3.0.0\build\Pathoschild.Stardew.ModBuildConfig.targets'))" />
<Error Condition="!Exists('packages\Pathoschild.Stardew.ModBuildConfig.3.1.0\build\Pathoschild.Stardew.ModBuildConfig.targets')" Text="$([System.String]::Format('$(ErrorText)', 'packages\Pathoschild.Stardew.ModBuildConfig.3.1.0\build\Pathoschild.Stardew.ModBuildConfig.targets'))" />
</Target>
</Project>
2 changes: 1 addition & 1 deletion DailyScreenshot/manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"Name": "Daily Screenshot",
"Author": "CompSciLauren",
"Version": "2.0",
"Version": "2.0.0",
"Description": "Automatically takes a daily screenshot of your entire farm.",
"UniqueID": "CompSciLauren.DailyScreenshot",
"EntryDll": "DailyScreenshot.dll",
Expand Down
2 changes: 1 addition & 1 deletion DailyScreenshot/packages.config
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="Newtonsoft.Json" version="12.0.3" targetFramework="net452" />
<package id="Pathoschild.Stardew.ModBuildConfig" version="3.0.0" targetFramework="net452" />
<package id="Pathoschild.Stardew.ModBuildConfig" version="3.1.0" targetFramework="net452" />
</packages>
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ Releases can be found at the following websites:

## Features

- A screenshot is automatically taken of your entire farm every day as soon as you leave your house.
- One screenshot is automatically taken of your entire farm every day as soon as you leave your house.
- Choose what time the screenshot gets taken.
- Choose how often a screenshot gets taken.
- Stores screenshots in the StardewValley/Screenshots folder, with each save file getting its own "FarmName-Screenshots" folder, so you can easily access the screenshots in-game under the "Options" tab in the menu and screenshots from multiple save files will not get mixed up. The file path to the screenshots folder is C:\Users\USERNAME\AppData\Roaming\StardewValley\Screenshots
- Makes it super easy to gather screenshots to create a GIF that shows how your farm changes over time! There are many GIF makers that can be found online, such as [ezgif GIF maker](https://ezgif.com/maker). Here is an [example](example.gif).
- 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, Spring, Day 3, the screenshot would be named "01-01-03.png".
- Can enable a keyboard shortcut for taking screenshots (set to "None" by default, so you need to specify a key on your keyboard in the Config file for this to work)
- Custom configuration options! See below.
- Choose how often a screenshot gets taken (daily, weekly, monthly, etc).
- 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.
- 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](https://ezgif.com/maker). Here is an [example](example.gif).
- 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".
- Keyboard shortcut that takes a screenshot when pressed (set to "None" by default).
- Can choose to disable automatic screenshots for rainy weather days (takes a screenshot every day regardless of weather by default).
- Custom configuration options, including ability to add multiple custom rules! See below.

## Installation

Expand Down

0 comments on commit 0678ef6

Please sign in to comment.