From 3c43972fdbd0ec36a14ab1f9c5fbed9eabee2f61 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Mon, 31 Jul 2017 00:56:32 -0400 Subject: [PATCH] add main README and per-mod READMEs --- GeneralMods/AutoSpeed/README.md | 30 ++--- .../BillboardAnywhere.csproj | 2 +- GeneralMods/BillboardAnywhere/README.md | 20 ++++ GeneralMods/BillboardAnywhere/Readme.txt | 12 -- .../BuildEndurance/BuildEndurance.csproj | 1 + GeneralMods/BuildEndurance/README.md | 32 +++++ GeneralMods/BuildHealth/BuildHealth.csproj | 2 +- GeneralMods/BuildHealth/ReadMe.md | 48 ++++---- .../BuyBackCollectables.csproj | 2 +- GeneralMods/BuyBackCollectables/README.md | 28 +++++ GeneralMods/BuyBackCollectables/ReadMe.txt | 33 ----- .../CustomShopsRedux/CustomShopsRedux.csproj | 5 +- .../Custom_Shop_Redux_Config.txt | 20 ---- GeneralMods/CustomShopsRedux/Mod_readme.txt | 14 --- GeneralMods/CustomShopsRedux/ReadMe.md | 113 +++++++----------- .../DailyQuestAnywhere.csproj | 2 +- GeneralMods/DailyQuestAnywhere/README.md | 19 +++ GeneralMods/DailyQuestAnywhere/ReadMe.txt | 25 ---- .../Fall28SnowDay/Fall28SnowDay.csproj | 2 +- GeneralMods/Fall28SnowDay/README.md | 19 +++ GeneralMods/Fall28SnowDay/Readme.txt | 20 ---- .../HappyBirthday/HappyBirthday.csproj | 2 +- GeneralMods/HappyBirthday/README.md | 50 ++++++++ GeneralMods/HappyBirthday/ReadMe.txt | 77 ------------ GeneralMods/MoreRain/README.md | 35 +++--- .../MuseumRearranger/MuseumRearranger.csproj | 2 +- GeneralMods/MuseumRearranger/ReadMe.md | 36 +++--- GeneralMods/NightOwl/NightOwl.csproj | 2 +- GeneralMods/NightOwl/README.md | 21 ++++ GeneralMods/NightOwl/ReadMe.txt | 47 -------- GeneralMods/NoMorePets/NoMorePets.csproj | 2 +- GeneralMods/NoMorePets/README.md | 19 +++ GeneralMods/NoMorePets/ReadMe.txt | 21 ---- GeneralMods/SaveAnywhere/README.md | 33 +++++ GeneralMods/SaveAnywhere/ReadMe.txt | 70 ----------- GeneralMods/SaveAnywhere/SaveAnywhere.csproj | 2 +- GeneralMods/SaveBackup/ReadMe.md | 26 ++-- GeneralMods/SaveBackup/SaveBackup.csproj | 2 +- GeneralMods/StardewMods.sln | 1 + GeneralMods/StardewSymphony/README.md | 19 +++ GeneralMods/StardewSymphony/ReadMe.txt | 11 -- .../StardewSymphony/StardewSymphony.csproj | 2 +- GeneralMods/TimeFreeze/README.md | 17 +++ GeneralMods/TimeFreeze/ReadMe.txt | 8 -- GeneralMods/TimeFreeze/TimeFreeze.csproj | 2 +- README.md | 80 +++++++++++++ 46 files changed, 510 insertions(+), 526 deletions(-) create mode 100644 GeneralMods/BillboardAnywhere/README.md delete mode 100644 GeneralMods/BillboardAnywhere/Readme.txt create mode 100644 GeneralMods/BuildEndurance/README.md create mode 100644 GeneralMods/BuyBackCollectables/README.md delete mode 100644 GeneralMods/BuyBackCollectables/ReadMe.txt delete mode 100644 GeneralMods/CustomShopsRedux/Custom_Shop_Redux_Config.txt delete mode 100644 GeneralMods/CustomShopsRedux/Mod_readme.txt create mode 100644 GeneralMods/DailyQuestAnywhere/README.md delete mode 100644 GeneralMods/DailyQuestAnywhere/ReadMe.txt create mode 100644 GeneralMods/Fall28SnowDay/README.md delete mode 100644 GeneralMods/Fall28SnowDay/Readme.txt create mode 100644 GeneralMods/HappyBirthday/README.md delete mode 100644 GeneralMods/HappyBirthday/ReadMe.txt create mode 100644 GeneralMods/NightOwl/README.md delete mode 100644 GeneralMods/NightOwl/ReadMe.txt create mode 100644 GeneralMods/NoMorePets/README.md delete mode 100644 GeneralMods/NoMorePets/ReadMe.txt create mode 100644 GeneralMods/SaveAnywhere/README.md delete mode 100644 GeneralMods/SaveAnywhere/ReadMe.txt create mode 100644 GeneralMods/StardewSymphony/README.md delete mode 100644 GeneralMods/StardewSymphony/ReadMe.txt create mode 100644 GeneralMods/TimeFreeze/README.md delete mode 100644 GeneralMods/TimeFreeze/ReadMe.txt create mode 100644 README.md diff --git a/GeneralMods/AutoSpeed/README.md b/GeneralMods/AutoSpeed/README.md index 8100c10a..4610bbe4 100644 --- a/GeneralMods/AutoSpeed/README.md +++ b/GeneralMods/AutoSpeed/README.md @@ -1,20 +1,20 @@ -# AutoSpeed_Mod +**Auto Speed** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you move faster +without the need to enter commands in the console. +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. -Initial Post: 3/27/16 -Updated: v1.1.0 10/11/16 +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/443). +3. Run the game using SMAPI. -Compatability: -Windows -SDV 1.1 +## Usage +Launch the game with the mod installed to generate the config file, then edit the +`AutoSpeed_data.txt` to set the speed you want (higher values are faster). -Changelog: -1.1.0 --Updated to SDv 1.1 --Updated to SMAPI 0.40.0 1.1-3 +## Versions +1.0 +* Initial release. -Description: -This is a simple .dll mod for SMAPI which automatically changes the character's speed value referenced in AutoSpeed.txt. -This basically just bypasses having to type in the command everytime you load SMAPI. - -Install in by putting it into Stardew Valley/Mods/AutoSpeed! +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. diff --git a/GeneralMods/BillboardAnywhere/BillboardAnywhere.csproj b/GeneralMods/BillboardAnywhere/BillboardAnywhere.csproj index f3e9d9e4..f1b4d72f 100644 --- a/GeneralMods/BillboardAnywhere/BillboardAnywhere.csproj +++ b/GeneralMods/BillboardAnywhere/BillboardAnywhere.csproj @@ -42,7 +42,7 @@ - + diff --git a/GeneralMods/BillboardAnywhere/README.md b/GeneralMods/BillboardAnywhere/README.md new file mode 100644 index 00000000..f6649f40 --- /dev/null +++ b/GeneralMods/BillboardAnywhere/README.md @@ -0,0 +1,20 @@ +**Billboard Anywhere** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you look at +the billboard anywhere in-game for easy access to upcoming events and birthdays. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/492). +3. Run the game using SMAPI. + +## Usage +Press `B` while in-game to show the billboard menu. Edit the `Billboard_Anywhere_Config.txt` file +to change the key. + +## Versions +1.0 +* Initial release. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. diff --git a/GeneralMods/BillboardAnywhere/Readme.txt b/GeneralMods/BillboardAnywhere/Readme.txt deleted file mode 100644 index a54b33ed..00000000 --- a/GeneralMods/BillboardAnywhere/Readme.txt +++ /dev/null @@ -1,12 +0,0 @@ -Billboard Anywhere 1.1.0 - -Posted 7/12/16 at 1:29 AM -Updated: 10/11/16 1:08AM - -Updates: -1.1.0 --Updated to SDV 1.1 - -Usage:See config - --A simple mod that allows the Billboard/Calendar to be shown anywhere by pressing the key defined in Billboard_Anywhere_Config.txt diff --git a/GeneralMods/BuildEndurance/BuildEndurance.csproj b/GeneralMods/BuildEndurance/BuildEndurance.csproj index a163c9c3..5abdf38e 100644 --- a/GeneralMods/BuildEndurance/BuildEndurance.csproj +++ b/GeneralMods/BuildEndurance/BuildEndurance.csproj @@ -44,6 +44,7 @@ + diff --git a/GeneralMods/BuildEndurance/README.md b/GeneralMods/BuildEndurance/README.md new file mode 100644 index 00000000..36174664 --- /dev/null +++ b/GeneralMods/BuildEndurance/README.md @@ -0,0 +1,32 @@ +**Build Endurance** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you level up +your endurance to increase your max stamina as you play. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/445). +3. Run the game using SMAPI. + +**NOTE:** to undo the mod's changes to your player, edit the `PlayerData\BuildEndurance_data_*.txt` +file and change the "RESET ALL MOD EFFECTS?" field to `True`. + +## Usage +You'll automatically get XP for... + +* using tools; +* sleeping; +* eating or drinking; +* running out of stamina (becoming exhausted); +* passing out (either by working while exhausted or or staying up late). + +Get enough XP, and your endurance will level up. + +Edit `BuildEnduranceConfig.json` to configure the mod settings. + +## Versions +1.0 +* Initial release. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. diff --git a/GeneralMods/BuildHealth/BuildHealth.csproj b/GeneralMods/BuildHealth/BuildHealth.csproj index 2ff118da..d141e6c4 100644 --- a/GeneralMods/BuildHealth/BuildHealth.csproj +++ b/GeneralMods/BuildHealth/BuildHealth.csproj @@ -44,7 +44,7 @@ - + diff --git a/GeneralMods/BuildHealth/ReadMe.md b/GeneralMods/BuildHealth/ReadMe.md index 79fdca6b..a0ade205 100644 --- a/GeneralMods/BuildHealth/ReadMe.md +++ b/GeneralMods/BuildHealth/ReadMe.md @@ -1,33 +1,33 @@ -[SMAPI]BuildEndurance -Initial Release 4/10/16 10:40 PM -Updated: 10/11/16 12:55 AM +**Build Health** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you level up +your endurance to increase your max health as you play. -Compatability: -Windows +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. -Updates: -1.1.0 10/11/16 12:55 AM --Updated to SDV 1.1 +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/445). +3. Run the game using SMAPI. -v1.0.0 4/10/16 10:40 PM PST +**NOTE:** to undo the mod's changes to your player, edit the `PlayerData\BuildEndurance_data_*.txt` +file and change the "RESET ALL MOD EFFECTS?" field to `True`. -Description --Fixed the glitch where eating and using tools would not net you xp. +## Usage +You'll automatically get XP for... -This is the BuildEndurance mod, which can increase your max health in a couple of different ways! As you partake in the tasks below, you gain xp points, and when you reach enough xp points, your max health will increase! +* using tools; +* sleeping; +* eating or drinking; +* taking damage; +* running out of stamina (becoming exhausted); +* passing out (either by working while exhausted or or staying up late). -Ways to increase maximum health: +Get enough XP, and your health will level up. -Use tools. +Edit `BuildHealthConfig.json` to configure the mod settings. -Eating Food. +## Versions +1.0 +* Initial release. -Sleeping! - -I'm up to a few more suggestions as well that can add to this list. - -All of the data can be set up/edited in BuildEndurance_Config.tx. If you want to increase/decrease any of the values such as the xp to level up, the maximum level, or even the amount of health you gain upon level up can be found here. - -All data values currently associated with the character can also be change around with BuildEndurance_data.txt - -NOTE! If at any time you want to remove/reverse the properties set by this mod, open up the BuildEndurance_data.txt file and set the value associated with resetting the mod data to true! This will revert the player's max health to the value initially stored when the mod was installed/ the value associate with old health. +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. diff --git a/GeneralMods/BuyBackCollectables/BuyBackCollectables.csproj b/GeneralMods/BuyBackCollectables/BuyBackCollectables.csproj index 6365b2c0..9d346e51 100644 --- a/GeneralMods/BuyBackCollectables/BuyBackCollectables.csproj +++ b/GeneralMods/BuyBackCollectables/BuyBackCollectables.csproj @@ -43,7 +43,7 @@ - + diff --git a/GeneralMods/BuyBackCollectables/README.md b/GeneralMods/BuyBackCollectables/README.md new file mode 100644 index 00000000..d01e5f55 --- /dev/null +++ b/GeneralMods/BuyBackCollectables/README.md @@ -0,0 +1,28 @@ +**Buy Back Collectables** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you buy +items from the collectables menu by pressing a key, at a configurable markup. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/507). +3. Run the game using SMAPI. + +## Usage +Press `B` to open the buy-collectibles menu. Edit `BuildHealthConfig.json` to change the key or the +price markup. + +## Versions +1.0: +* Initial release. + +1.0.1: +* Corrected price display to reflect markup. + +1.0.2: +* Fixed issues where unintended items were bought. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. +* Fixed mouse not appearing in menu. +* Fixed bug where you sometimes couldn't buy an item even if you had enough money. \ No newline at end of file diff --git a/GeneralMods/BuyBackCollectables/ReadMe.txt b/GeneralMods/BuyBackCollectables/ReadMe.txt deleted file mode 100644 index 12c14207..00000000 --- a/GeneralMods/BuyBackCollectables/ReadMe.txt +++ /dev/null @@ -1,33 +0,0 @@ -BuyBackCollectables - -Version:1.1.0 - -Published: 8/2/16 12:39 AM - -Updated: 10/32/16 10:38 PM - -Compatability: - -Stardew Valley 1.1.0 Windows - -SMAPI 0.40.0 1.1-3 - -Description: - -A simple mod that allows you to buy back any collectable that you have already shiped at 3 times the shipping price. (Configurable in the config file) - -Usage: Press B to open up the buy back menu. - -Update Info: -1.1.0 --Updated to SDV 1.1 --Fixed glitch where mouse would not show up on menu draw. --Fixed glitch where I used a bad math algorithm and you wouldn't be able to buy an item if you had enough money. - -1.0.2 - --Fixed some bugs where you would accidentally purchase some items when not intending to. - -1.0.1 - --Changed price display in buy back menu to propperly reflect buy back price. diff --git a/GeneralMods/CustomShopsRedux/CustomShopsRedux.csproj b/GeneralMods/CustomShopsRedux/CustomShopsRedux.csproj index 70969484..e3adeacd 100644 --- a/GeneralMods/CustomShopsRedux/CustomShopsRedux.csproj +++ b/GeneralMods/CustomShopsRedux/CustomShopsRedux.csproj @@ -48,14 +48,11 @@ PreserveNewest - - PreserveNewest - - + diff --git a/GeneralMods/CustomShopsRedux/Custom_Shop_Redux_Config.txt b/GeneralMods/CustomShopsRedux/Custom_Shop_Redux_Config.txt deleted file mode 100644 index b2071dd4..00000000 --- a/GeneralMods/CustomShopsRedux/Custom_Shop_Redux_Config.txt +++ /dev/null @@ -1,20 +0,0 @@ -Config: Custom_Shop_Redux. Feel free to mess with these settings. -==================================================================================== -Key binding for saving anywhere. Press this key to save anywhere! -U - - - - - - - - - - - - - - - - diff --git a/GeneralMods/CustomShopsRedux/Mod_readme.txt b/GeneralMods/CustomShopsRedux/Mod_readme.txt deleted file mode 100644 index 6213c689..00000000 --- a/GeneralMods/CustomShopsRedux/Mod_readme.txt +++ /dev/null @@ -1,14 +0,0 @@ -This is the custom shop mod! - -Basically making a custom shop is as simple as following the formatting in the pre-existsing custom_shops in a new text file. - -If you ever wish to call the mod without the menu in your own mod, simply call shop_file_call("myfilename.txt") in your Stardew Valley Mod. -(Make sure you add a reference to this mod.) - -The full call would look something like. - -Custom_Shop_Mod_Redux.Class1.shop_file_call("file.txt"); - -Where file.txt is the name of the shop info you wish to open. - -Make sure the formatting is correct otherwise you will get errors! \ No newline at end of file diff --git a/GeneralMods/CustomShopsRedux/ReadMe.md b/GeneralMods/CustomShopsRedux/ReadMe.md index 6e0aa0f5..09c9b129 100644 --- a/GeneralMods/CustomShopsRedux/ReadMe.md +++ b/GeneralMods/CustomShopsRedux/ReadMe.md @@ -1,80 +1,59 @@ -Custom_Shop_Mod_Redux_GUI v 1.2.0 +**Custom Shop Redux GUI** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you +create custom shops by editing text files. -For SDV 1.0.7 and SMAPI v0.40 +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. -Posted at 9:15 PM PST 5/8/16 +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install this mod from Nexus mods (not yet released). +3. Run the game using SMAPI. --Updated to be able to be called from other mods for NPC shop binding and soforth. +## Usage +Make a custom shop by copying & editing one of the included custom shop templates, or use the +[Custom Shops Creation Tool](https://myscccd-my.sharepoint.com/personal/0703280_my_scccd_edu/_layouts/15/guestaccess.aspx?guestaccesstoken=ZYxG9Cs8S0q%2bxCVV3fEnc8MI4SfVfe07919rhFUhRiA%3d&docid=0e51dae1da2eb43988f77f5c54ec3ee58) +(see [demo video](https://youtu.be/bSvNTZmgeZE)). --Fixed a bug where pressing the U key on the main menu causes the game to crash. +You can access the custom shops by pressing `U` in-game (configurable via `Custom_Shop_Redux_Config.txt`). -Good evening everyone. At this point I don't even know how I'm creating mods so quickly, but I think I'll strike while the iron is hot. Here is my third release of the day, the Custom Shops Mod Redux! +Supported item types: -The custom_shop_mod_redux is a second, much better attempt at adding custom shops into StardewValley! - -***Not to be confused with the custom_shop_mod which was it's predecessor and was based around the SMAPI console. - -Basically making a custom shop is as simple as following the formatting in the pre-existsing custom_shops in a new text file. (Or by using the super useful Custom Shop Creation Tool) - -You can access these custom shops by pressing a key. (The U key by default, which is configurable in the config file) - -I recommend that you use the Custom Shop Creation Tool that I created for everyone to create your custom shops. The link is down below. Took me a little bit of time to put together, but it works. - -Watch the new video to understand how it works. - -Have fun with this one! I hope to see all of the custom shops that you all put out! - -==================================================== -If you wish to call this mod in your own mod without the menu the code would be - -Custom_Shop_Mod_Redux.Class1.external_shop_file_call(path, filename); - -Where path is the directory path of the desired text file, and filename is the name of the file inside of the path directory. - -*Note that path will not include the file itself. The code will take care of that for you. - -This would be useful if you want a custom NPC to have a shop but you don't want to have to code in the shop yourself. -========================================================= -Some goals of mine with this mod: - -1. Get as many different types of items available for selling. (finished) - -2.Create a nice gui interface in Unity for creating custom shops so that modders don't have to deal with my icky formatting rules. The GUI will take care of that for modders. (finished) - -3.Make my code compatible with other mods for modders, so that they can call my shop_command_code and be able to open up a shop from text file with just path information, and file names. (This is next) - -4. Document the mod for future user use. -========================================================== -Types of Items this mod supports in shops. -1.Items (like normal inventory items) - -2.Furniture- (windows, tables, chairs, etc) - -3.swords- Swish, swish. - -4.Hats -Got to look cool - -5.Boots - Lace up for adventure. - -6.Wallpapers - Make your house look nice. - -7.Carpets/Flooring - Like animal crossing. - -8.Rings - As long as they aren't evil. - -9.Lamps - Light up the world. - -10.craftables* =*note that there was some....issues adding in craftable objects. They all act like torches when you interact with them. It's kind of hilarious and I don't think I'll change it anytime soon. You can still have objects like the furnace function like normal, by right clicking it with copper. In order to get the smelted copper bar however, you would have to destroy it, as would go for all machines that behave this way. Sorry. On the plus side your scarecrows can be on fire forever. +* inventory items; +* furniture (windows, tables, chairs, etc); +* swords (swish, swish); +* gats (got to look cool); +* boots (lace up for adventure); +* wallpapers (make your house look nice); +* carpets & flooring (like Animal Crossing); +* rings (as long as they aren't evil); +* lamps (light up the world); +* craftables (note that there are some... issues with craftables. They all act like torches when + you interact with them. It's kind of hilarious and I don't think I'll change it anytime soon. You + can still have objects like the furnace function like normal, by right-clicking it with copper. + In order to get the smelted copper bar however, you would have to destroy it, as would go for all + machines that behave this way. Sorry. On the plus side your scarecrows can be on fire forever.) -Link: -Get it Here! -Link for the Custom Shops Creation Tool.: -https://myscccd-my.sharepoint.com/personal/0703280_my_scccd_edu/_layouts/15/guestaccess.aspx?guestaccesstoken=ZYxG9Cs8S0q%2bxCVV3fEnc8MI4SfVfe07919rhFUhRiA%3d&docid=0e51dae1da2eb43988f77f5c54ec3ee58 +## Goals +* [x] Get as many different types of items available for selling. +* [x] Create a nice GUI for creating custom shops so that modders don't have to deal with my icky + formatting rules. The GUI will take care of that for modders. +* [x] Make my code compatible with other mods for modders, so that they can call my + shop_command_code and be able to open up a shop from text file with just path information, + and file names. -Also here is a video demonstrating how this mod works. +## Versions +1.0: +* Initial release. -https://youtu.be/bSvNTZmgeZE +1.0.1: +* Corrected price display to reflect markup. +1.0.2: +* Fixed issues where unintended items were bought. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. +* Fixed mouse not appearing in menu. +* Fixed bug where you sometimes couldn't buy an item even if you had enough money. \ No newline at end of file diff --git a/GeneralMods/DailyQuestAnywhere/DailyQuestAnywhere.csproj b/GeneralMods/DailyQuestAnywhere/DailyQuestAnywhere.csproj index 79cebd2a..4d20b61a 100644 --- a/GeneralMods/DailyQuestAnywhere/DailyQuestAnywhere.csproj +++ b/GeneralMods/DailyQuestAnywhere/DailyQuestAnywhere.csproj @@ -42,7 +42,7 @@ - + diff --git a/GeneralMods/DailyQuestAnywhere/README.md b/GeneralMods/DailyQuestAnywhere/README.md new file mode 100644 index 00000000..c719b2f8 --- /dev/null +++ b/GeneralMods/DailyQuestAnywhere/README.md @@ -0,0 +1,19 @@ +**Daily Quest Anywhere** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you open +the daily quest menu from anywhere in-game. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/513). +3. Run the game using SMAPI. + +## Usage +Press `H` to open the daily quest menu. Edit `DailyQuest_Anywhere_Config.txt` to change the key. + +## Versions +1.0: +* Initial release. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. diff --git a/GeneralMods/DailyQuestAnywhere/ReadMe.txt b/GeneralMods/DailyQuestAnywhere/ReadMe.txt deleted file mode 100644 index db5cdd2d..00000000 --- a/GeneralMods/DailyQuestAnywhere/ReadMe.txt +++ /dev/null @@ -1,25 +0,0 @@ -DailyQuest_Anywhere - -Version:1.1.0 - -Published: 8/14/16 12:50 PM - -Updated: 10/14/16 12:27 AM - -Compatability: - -Stardew Valley 1.1.0 Windows - -SMAPI 0.40.0 1.1-3 - -Description: - -A simple mod that allows you to open the daily quest menu from anywhere. - -Usage: Press H to open up the buy back menu. - -Update Info: -1.1.0 --Updated to SDV 1.1 -1.0.0 --Initial Release diff --git a/GeneralMods/Fall28SnowDay/Fall28SnowDay.csproj b/GeneralMods/Fall28SnowDay/Fall28SnowDay.csproj index 6ec42d5f..14355c61 100644 --- a/GeneralMods/Fall28SnowDay/Fall28SnowDay.csproj +++ b/GeneralMods/Fall28SnowDay/Fall28SnowDay.csproj @@ -42,7 +42,7 @@ - + diff --git a/GeneralMods/Fall28SnowDay/README.md b/GeneralMods/Fall28SnowDay/README.md new file mode 100644 index 00000000..7fa8c3b9 --- /dev/null +++ b/GeneralMods/Fall28SnowDay/README.md @@ -0,0 +1,19 @@ +**Daily Quest Anywhere** is a [Stardew Valley](http://stardewvalley.net/) mod which makes snow fall +on the last day of fall, which would explain why the town is covered in snow on the next day. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/486). +3. Run the game using SMAPI. + +## Usage +It automatically snows on fall 28. + +## Versions +1.0: +* Initial release. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. diff --git a/GeneralMods/Fall28SnowDay/Readme.txt b/GeneralMods/Fall28SnowDay/Readme.txt deleted file mode 100644 index f5c910c9..00000000 --- a/GeneralMods/Fall28SnowDay/Readme.txt +++ /dev/null @@ -1,20 +0,0 @@ -Fall 28 Snow Day 1.1.0 - -Posted on 7/9/16 -Updated 10/21/16 12:26 AM - -Compatability: -SDV 1.1 -SMAPI 0.40.0 1.1-3 -Windows - -Descritption: - --Just a small mod that makes it snow on Fall 28th, which would explain why the town is covered in snow come the 1st of Winter. - -Updates: -1.1.0 --Updated to SDV 1.1 - -1.0.0 --Initial release. \ No newline at end of file diff --git a/GeneralMods/HappyBirthday/HappyBirthday.csproj b/GeneralMods/HappyBirthday/HappyBirthday.csproj index 75594a12..594e1929 100644 --- a/GeneralMods/HappyBirthday/HappyBirthday.csproj +++ b/GeneralMods/HappyBirthday/HappyBirthday.csproj @@ -56,7 +56,7 @@ - + diff --git a/GeneralMods/HappyBirthday/README.md b/GeneralMods/HappyBirthday/README.md new file mode 100644 index 00000000..8a8d545a --- /dev/null +++ b/GeneralMods/HappyBirthday/README.md @@ -0,0 +1,50 @@ +**Happy Birthday** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you pick a day +for your birthday. On your birthday, you get letters from your parents, and villagers give you +gifts and wish you happy birthday. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/520). +3. Merge the mod's `Content` folder with the game's `Content` folder. +4. Run the game using SMAPI. + +## Usage +The menu to choose your birthday should appear when you wake up in the morning. On your birthday, +talk to NPCs as usual and they'll wish you happy birthday and give you gifts. Their gifts will +change based on your friendship with them. Check your mailbox for letters from your parents. + +## Versions +1.0: +* Initial release. + +1.0.1: +* Fixed a dialogue error with Shane. +* Reduced log spam in the SMAPI console. + +1.0.2: +* Deleted some old data. + +1.0.3: +* Fixed being able to "talk" to your pet. + +1.0.4: +* Fixed everyone wishing you a happy birthday every day. Oops. + +1.0.5: +* Fixed NPCs giving you a gift but not wishing you a happy birthday. + +1.0.6: +* Fixed NPCs not wishing you a happy birthday if your birthday didn't exist already. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. +* Added a popup that wishes you happy birthday on your birthday. +* Added mail from your parents on your birthday. + +1.1.1: +* Fixed some gifts being too OP (like 25 rabbit foots). +* Fixed the birthday menu not letting you exit without choosing a date. +* Fixed NPCs sometimes giving you broken items and useless rocks. +* Fixed game crashing when in an event. It gives priority to the event over your birthday in worst case scenario. diff --git a/GeneralMods/HappyBirthday/ReadMe.txt b/GeneralMods/HappyBirthday/ReadMe.txt deleted file mode 100644 index 73282d51..00000000 --- a/GeneralMods/HappyBirthday/ReadMe.txt +++ /dev/null @@ -1,77 +0,0 @@ -Happy Birthday - -Version:1.1.1 - -Published: 8/18/16 11:21 AM - -Updated: 11/8/16 1:17 AM - -Compatability: - -Stardew Valley 1.1.0 Windows - -SMAPI 0.40.0 - -Description: - -Ever wonder why you don't have a birthday in Stardew Valley? Well worry no more! - -Introducing the mod, Happy Birthday! - -This mod is pretty basic and does a few things. - -1.Adds in a new menu where you can choose the birthday for your farmer. Just load up your character and try to move and the menu should pop up! - -2.NPCs wish you a happy birthday. Dialogue for this can be found at StardewValley/Content/Data/FarmerBirthdayDialogue.xnb - -3.You get a random gift from each NPC according to how close you are to them. Possible gifts can be found at StardewValley/Content/Data/PossibleBirthdayGifts.xnb - -There may or may not be a few content additions in the future depending on how much time I have, so keep an eye out just incase! - -Installation: -1.Download SMAPI -2.Download the main mod file -3.Download the mod Content file. -4.Place the main mod content file at StardewValley/Mods\ -5.Merge the mod Content file with the content file located at StardewValley/Content -OR -Place FarmerBirthdayDialogue.xnb and PossibleBirthdayGifts.xnb from the mod content folder inside of StardewValley/Content/Data -6.Run the game! - -Note: This mod was built with custom NPCs in mind. You can either add in your custom NPC to the mod content files to allow for NPC specific dialogue and gifts, but if you don't you'll just get a default birthday message and the NPC will choose a gift from the general gift pool. - -Have fun! - -Update Info: -1.1.1 --Balanced some gifts to be a bit less op. (Like 25 rabit foots); --Fixed the birthday menu to force you to choose a season and date before you are allowed to exit the menu. --Hopefully fixed the ???, Error Item, and useless rocks from showing up as possible gifts. --Implemented a cheep fix to hopefully prevent the game from crashing when inside an event. It gives priority to the event over your birthday in worst case scenario. - -1.1.0 --Updated to SDV 1.1 --Added a popup that wishes you happy birthday on your birthday --Added a way for the player to receive mail from their parents on their birthday. - -1.0.6 --Fixed a bug where NPC's wouldn't wish you a happy birthday if your birthday didn't exist already. - -1.0.5 --Fixed a bug where NPCs wouldn't wish you a happy birthday but give you a gift. - -1.0.4 --Fixed a bug where everyone would wish you a happy birthday every day. Opps - -1.0.3 --Fixed a bug where you could "talk" to your pet. - -1.0.2 --Deleted some old data. all good now. - -1.0.1 --Fixed a dialogue error with Shane --Stopped spamming info to the SMAPI console. - -1.0.0 --Initial Release diff --git a/GeneralMods/MoreRain/README.md b/GeneralMods/MoreRain/README.md index 1269103b..73cb7380 100644 --- a/GeneralMods/MoreRain/README.md +++ b/GeneralMods/MoreRain/README.md @@ -1,24 +1,25 @@ -Stardew Valley MoreRain 1.2.0 +**More Rain** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you adjust the +probability of rain and storms for each season. +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. -Initial Release:v1.0.0 posted on 6/7/16 at 11:34 AM -Updated: 3/2/16 6:51 PM +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/441). +3. Run the game using SMAPI. -Updates: -1.2.0 -Updated the mod to have configurable rain and storm chances for every season except winter. Winter gets a snow chance. +## Usage +Edit `More_Rain_Config.txt` to change the chance of rain, storms, or snow. Each value is a +percentage (0 to 100). -1.1.0 --Updated to SDV 1.1 +It won't rain on days where a wedding or a festival would take place. -1.0.0 --Finally got around to an offical full release of this mod. Basically rewrote it from the ground up. +## Versions +1.0: +* Initial release. -Description -This is the MoreRain mod, which can increase or decrease how much it rains in your game as well as increase the chance to get lightning storms! -I basically wrote this mod a long time ago because some people complained about the rain in Stardew Valley being too spotty, so this adds in a new level of control to the game. - -It will not rain on days where a wedding or a festival would take place, so this mod will ignore those days. - -All of the values that can be configured in More_Rain_Config.txt +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. +1.2: +* Added configurable rain and storm chances for every season (snow chance in winter). diff --git a/GeneralMods/MuseumRearranger/MuseumRearranger.csproj b/GeneralMods/MuseumRearranger/MuseumRearranger.csproj index 1db00ce6..0f71dfc2 100644 --- a/GeneralMods/MuseumRearranger/MuseumRearranger.csproj +++ b/GeneralMods/MuseumRearranger/MuseumRearranger.csproj @@ -43,7 +43,7 @@ - + diff --git a/GeneralMods/MuseumRearranger/ReadMe.md b/GeneralMods/MuseumRearranger/ReadMe.md index 610aaad2..b6795beb 100644 --- a/GeneralMods/MuseumRearranger/ReadMe.md +++ b/GeneralMods/MuseumRearranger/ReadMe.md @@ -1,23 +1,25 @@ -Museum Rearranger 1.1.0 +**Museum Rearranger** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you rearrange +donated items in the museum by pressing a key, even if you don't have a new item to donate. -Initial Release 7/12/16 1:52 AM -Updated: 10/11/16 11:51 PM +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. -Compatability: -SDV 1.1 -Windows +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/428). +3. Run the game using SMAPI. -Updates: -1.1.0 --Updated to SDV 1.1 --Added in a new key config for toggling if the inventory displays while rearranging the museum. Press T by default to toggle showing the menu. +## Usage +Press `R` while in the museum to open the rearranging menu. Press `T` while the menu is open to +toggle the inventory box. Edit `Museum_Rearrange_Config.txt` to change the keys. + +## Versions +1.0: +* Initial release. 1.0.2 --Massively rewrote some code because it was super necessary. --Fixed some typoes with the config files. +* Massively rewrote some code because it was super necessary. +* Fixed typos in the config files. -This is the museum rearranger mod! This mod allows you to rearrange the museum without having to have something to donate! - -Simply press the R key while inside the museum and you will be able to make the museum look however you like! - -That's pretty much it. I haven't found any issues thus far, so feel free to go at it! +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. +* Added key to toggle the inventory box while rearranging the museum. diff --git a/GeneralMods/NightOwl/NightOwl.csproj b/GeneralMods/NightOwl/NightOwl.csproj index 24cde61b..5e6c4b36 100644 --- a/GeneralMods/NightOwl/NightOwl.csproj +++ b/GeneralMods/NightOwl/NightOwl.csproj @@ -48,7 +48,7 @@ - + diff --git a/GeneralMods/NightOwl/README.md b/GeneralMods/NightOwl/README.md new file mode 100644 index 00000000..90082218 --- /dev/null +++ b/GeneralMods/NightOwl/README.md @@ -0,0 +1,21 @@ +**Night Owl** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you stay up a full +24 hours instead of collapsing at 2am, including a morning light transition as the sun rises. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/433). +3. _(optional)_ Merge the `Content` folder into your game's `Content` folder to improve night fishing. +3. Run the game using SMAPI. + +## Usage +Simply stay up past 2am, and you won't collapse. The lighting will gradually brighten as the sun +rises. At 6am you'll temporarily collapse so the game can save, but you won't lose anything and +you'll stay where you are. + +Edit the `Night_Owl_Config_.txt` to change the mod settings. + +## Versions +1.0: +* Initial release. diff --git a/GeneralMods/NightOwl/ReadMe.txt b/GeneralMods/NightOwl/ReadMe.txt deleted file mode 100644 index 49138e17..00000000 --- a/GeneralMods/NightOwl/ReadMe.txt +++ /dev/null @@ -1,47 +0,0 @@ -Night Owl - -Version:1.2.0 - -Published: 7/4/16 1:37 PM - -Updated: 10/21/16 12:35 AM - -Compatability: - -Stardew Valley 1.1.0 Windows - -SMAPI 0.40.0 1.1-3 - -Description: - -Night Owl is a mod that allows players to stay up a full 24 hours instead of being restricted to 2AM. -Some of the features include --A transitional lighting effect that lasts from 2AM to 6 AM --Gold doesn't have to be subtracted from you when you collapse. --Persistent health and stamina when you stay up 24 hours --Remaining in the same place as where you collapsed! -Plenty of features can be found in the Night Owl Config to be edited as you please. - -Installation: - -1.Unzip the NightOwl.zip folder. -2.Place the Unzipped folder into Stardew Valley/Mods -3.Play! - -Installation for Night Owl Fish: http://www.nexusmods.com/stardewvalley/mods/433/?tab=1&navtag=http%3A%2F%2Fwww.nexusmods.com%2Fstardewvalley%2Fajax%2Fmoddescription%2F%3Fid%3D433%26preview%3D&pUp=1 -1.Unzip the Fish.zip folder -2.Place the Fish.xnb FILE inside of Stardew Valley/Content/Data -3.Overwrite the old Fish.xnb -4.Play! -Yes this compatibility file is incompatible with other mods that edit the Fish.xnb file. No, I do not plan on making compatibility patches with these mods. - - -Update Info: -1.2.0 --Updated to SDV 1.1 - -1.1.0 --Added a bug/error catching system that should help prevent the mod from outright crashing, and instead just dump some error logic to the mod's folder for better debgging in the future. - -1.0.0 --Initial Release diff --git a/GeneralMods/NoMorePets/NoMorePets.csproj b/GeneralMods/NoMorePets/NoMorePets.csproj index 3efc9204..122d6730 100644 --- a/GeneralMods/NoMorePets/NoMorePets.csproj +++ b/GeneralMods/NoMorePets/NoMorePets.csproj @@ -42,7 +42,7 @@ - + diff --git a/GeneralMods/NoMorePets/README.md b/GeneralMods/NoMorePets/README.md new file mode 100644 index 00000000..b9a1fe83 --- /dev/null +++ b/GeneralMods/NoMorePets/README.md @@ -0,0 +1,19 @@ +**No More Pets** is a [Stardew Valley](http://stardewvalley.net/) mod which removes all pets from +the game. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/506). +3. Run the game using SMAPI. + +## Usage +All your pets will be removed automatically when you play the save. + +## Versions +1.0: +* Initial release. + +1.1: +* Updated to Stardew Valley 1.1 and SMAPI 0.40 1.1-3. diff --git a/GeneralMods/NoMorePets/ReadMe.txt b/GeneralMods/NoMorePets/ReadMe.txt deleted file mode 100644 index 25366a92..00000000 --- a/GeneralMods/NoMorePets/ReadMe.txt +++ /dev/null @@ -1,21 +0,0 @@ -NoMorePets - -version: 1.1.0 - -Released: 8/1/16 - -Updated:10/21/16 12:48 AM - -Compatability: - -Stardew Valley 1.1.0 Windows - -SMAPI 0.40.0 1.1-3 - -Description: A simple mod that removes your pet from the game incase you somehow dupe it, or are annoyed with it. - -Accidently duped my pet while modding. This helped clean up the issue for me. - -Updates: -1.1.0 --updated to SDV 1.1 \ No newline at end of file diff --git a/GeneralMods/SaveAnywhere/README.md b/GeneralMods/SaveAnywhere/README.md new file mode 100644 index 00000000..d3c27104 --- /dev/null +++ b/GeneralMods/SaveAnywhere/README.md @@ -0,0 +1,33 @@ +**Save Anywhere** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you save your +game anywhere by pressing a key. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/444). +3. Run the game using SMAPI. + +## Usage +Press `K` to save anywhere. Edit `Save_Anywhere_Config.txt` to configure the key. + +## Versions +1.0: +* Initial release. + +2.0: +* Major rewrite. +* Time is no longer simulated at high-speed to reset to the same time. This caused too many NPC pathfinding issues and players felt it was a bit of an exploit. +* NPCs should now properly pathfind themselves when loading after saving anywhere. Thanks to @Entoarox for the help! +* Save data is now better organised. +* Fixed various load crashes. +* Fixed the game transitioning to the next day when you save after putting items in your shipping bin. + +2.0.1: +* Fixed crash if you don't have a horse. + +2.0.2: +* Fixed config file. + +2.1: +* Fixed mod crashing in some cases. diff --git a/GeneralMods/SaveAnywhere/ReadMe.txt b/GeneralMods/SaveAnywhere/ReadMe.txt deleted file mode 100644 index efd7a8b4..00000000 --- a/GeneralMods/SaveAnywhere/ReadMe.txt +++ /dev/null @@ -1,70 +0,0 @@ -Save Anywhere V2 - -Version:2.1.0 - -Published: 8/26/16 8:46 AM - -Updated: 9/5/16 1:16 PM - -Compatability: - -Stardew Valley 1.0.7 Windows - -SMAPI 0.40.0 - -Description: - -UPDATE 2.0.0!!!! - -Hey everyone, it's been a super long time since this mod got an update, but here it is, Save Anywhere V2! - -The number one reason this mod took so long to re-release is the fact that the old code was garbage and full of bugs that I couldn't test because I didn't have access to a save file that was very far along. That all changes now. - -The re-written version has some fundamental changes. I'll post everything down below. - -1.Old versions of the Save Anywhere mod are no longer supported. Update to this new, much better version. That said old save_anywhere data files don't work when you update to this version of the mod. - -2.Time is no longer simulate at a higher speed. This caused too many issues for pathfinding for NPCs and many players complained about it being a bit of an exploit. - -3.NPCs should now properly pathfind themselves when loading after saving anywhere. Thanks to @Entoarox for the help! - -4.Folder organization: Tons of organization regarding the data files used to Save/Load with this mod. It's way nicer and simpler for me to manage now. - -5.You can now save in the community center! No more of this awful glitch. Just make sure you download this mod HERE so that this works. Otherwise this bug will still exist due to the game's serializer not understanding what the heck a Junimo is. - -6.Hopefully no more Load crashes. I tested this out on a 2nd year character with farm animals, horse, cat, a wife, etc. Also better folder organization and better techniques should help prevent this mod from exploding. - -7.The game no longer transitions to the next day when you save and items are shipped. Didn't realize this was a thing until someone pointed it out. - -Now for the good part: - -Installation: - -1.Download and install SMAPI. The link for that is HERE. - -2.Install the Serializer Utility by Advize which is HERE. - -3.Download Save Anywhere V2. (Not the old mod version). - -4.Place BOTH mods at Stardew Valley/Mods - -5.Run the game! - -Usage: -1.To save anywhere simply press the K key. This is configuragble in the config file in the mod directory. - -If you have any bugs/comments/etc please post them in the new discussion form tab for Save Anywhere V2. - -Thanks and have fun! - -Update Info: -2.1.0 --Added in some bug handling that should prevent the mod from outright crashing. Also it dumps error logs to (thisModDirectory)/Error_Logs - -2.0.2 --Forgot to change the config back to the original state -2.0.1 --Fixed a glitch that would cause the game to crash if you don't have a horse. - -2.0.0 --Initial rewritten release. diff --git a/GeneralMods/SaveAnywhere/SaveAnywhere.csproj b/GeneralMods/SaveAnywhere/SaveAnywhere.csproj index 33583934..00d66f1d 100644 --- a/GeneralMods/SaveAnywhere/SaveAnywhere.csproj +++ b/GeneralMods/SaveAnywhere/SaveAnywhere.csproj @@ -45,7 +45,7 @@ - + diff --git a/GeneralMods/SaveBackup/ReadMe.md b/GeneralMods/SaveBackup/ReadMe.md index cb01c432..38dd13b7 100644 --- a/GeneralMods/SaveBackup/ReadMe.md +++ b/GeneralMods/SaveBackup/ReadMe.md @@ -1,16 +1,20 @@ -[SMAPI]Stardew_Save_Backup +**Save Backup** is a [Stardew Valley](http://stardewvalley.net/) mod which automatically backs up +your save files before you play and every in-game night. --v1.0.2 3/31/16 12:43 AM PST +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. --Updated to back up upon launch and upon sleeping. --Now supports x# of save files (28 by default) for Nightly backups and pre-launch backups (28 for each category). This can be changed in AutoBackup_data.txt. +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/435). +3. Run the game using SMAPI. -This is the Stardew_Save_Backup mod which automatically takes your save folder and zips it into %appdata%/StardewValley/Backed_Up_Saves for later retrieval upon launching SMAPI! This is especially usefulif you are modding/using mods and don't want your characters to be messed up, or if your game happens to crash form some odd reason, or you lose your save file! +## Usage +Your saves will be backed up automatically before you play and each in-game night. You can find the +files in `%appdata%/StardewValley/Backed_Up_Saves`. -The back-up happens every time you load up SMAPI so your files are zipped up nice and safe before anything can touch them. Also works when you go to bed at night. +This keeps the last 30 backups of each type by default, but you can edit `AutoBackup_data.txt` to +configure that. -You can also keep as many back-ups as you desire, and are only limited by the hard drive space on your computer! (Editable by AutoBackup_data.txt) - -If you ever want to get back to your old save files, simply open up the desired .zip folder with any archival tool such as windows file manager or .7zip and you can now access your old save files! - -I'm open to improvements for this mod as of writing this. If so desired I will research adding functionality for when your character goes to bed that it will back up your save files, or doing a backup after x amount of days that have passed in game. +## Versions +1.0: +* Initial release. diff --git a/GeneralMods/SaveBackup/SaveBackup.csproj b/GeneralMods/SaveBackup/SaveBackup.csproj index e2649fa8..47f36497 100644 --- a/GeneralMods/SaveBackup/SaveBackup.csproj +++ b/GeneralMods/SaveBackup/SaveBackup.csproj @@ -42,7 +42,7 @@ - + diff --git a/GeneralMods/StardewMods.sln b/GeneralMods/StardewMods.sln index 6999bd93..50207bd7 100644 --- a/GeneralMods/StardewMods.sln +++ b/GeneralMods/StardewMods.sln @@ -40,6 +40,7 @@ EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "~metadata", "~metadata", "{90EB59CA-51F6-49CF-8DCE-A8BB62C58E17}" ProjectSection(SolutionItems) = preProject deploy.targets = deploy.targets + ..\README.md = ..\README.md EndProjectSection EndProject Global diff --git a/GeneralMods/StardewSymphony/README.md b/GeneralMods/StardewSymphony/README.md new file mode 100644 index 00000000..080ad71f --- /dev/null +++ b/GeneralMods/StardewSymphony/README.md @@ -0,0 +1,19 @@ +**Stardew Symphony** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you add music +packs to Stardew Valley and play them without editing the game's default sound files. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/425). +3. Run the game using SMAPI. + +## Usage +Drop Stardew Symphony music packs into `Mods/Stardew_Symphony/Music_Files` to enable them. +Music can be conditional on location, season, and weather. + +This won't mute the music for in-game events or festivals. + +## Versions +1.0: +* Initial release. diff --git a/GeneralMods/StardewSymphony/ReadMe.txt b/GeneralMods/StardewSymphony/ReadMe.txt deleted file mode 100644 index ff90cd01..00000000 --- a/GeneralMods/StardewSymphony/ReadMe.txt +++ /dev/null @@ -1,11 +0,0 @@ -This is Stardew Symphony - -What this is is a music expansion API that allows users to add in music packs into Stardew Valley and play them without editing the game's default soundtrack. Music can be player per location and season, with additional options to play specific music depending on the time of day and the weather. More options such as muting the default rain soundtrack exist within the config file. This will not mute the music for in-game events or festivals. - -Installing music packs is simple as dragging and dropping a music pack into Stardew Valley/Mods/Stardew_Symphony/Music_Files/ - -Only music names included into the files located at -Stardew Valley/Mods/Stardew_Symphony/Music_Files/(music_pack_name)/Locations -and -Stardew Valley/Mods/Stardew_Symphony/Music_Files/(music_pack_name)/Seasons -will play according to the name of the file.txt \ No newline at end of file diff --git a/GeneralMods/StardewSymphony/StardewSymphony.csproj b/GeneralMods/StardewSymphony/StardewSymphony.csproj index f8c5abf8..35131fa1 100644 --- a/GeneralMods/StardewSymphony/StardewSymphony.csproj +++ b/GeneralMods/StardewSymphony/StardewSymphony.csproj @@ -46,7 +46,7 @@ - + diff --git a/GeneralMods/TimeFreeze/README.md b/GeneralMods/TimeFreeze/README.md new file mode 100644 index 00000000..790b788a --- /dev/null +++ b/GeneralMods/TimeFreeze/README.md @@ -0,0 +1,17 @@ +**Time Freeze** is a [Stardew Valley](http://stardewvalley.net/) mod which freezes time while +indoors. It configurably lets time pass while bathing. + +Compatible with Stardew Valley 1.2+ on Linux, Mac, and Windows. + +## Installation +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Install [this mod from Nexus mods](http://www.nexusmods.com/stardewvalley/mods/973). +3. Run the game using SMAPI. + +## Usage +Time will be frozen automatically when you're indoors. Time will unfreeze by default if you swim, +but you can edit `ModConfig.txt` to change that. + +## Versions +1.0: +* Initial release. diff --git a/GeneralMods/TimeFreeze/ReadMe.txt b/GeneralMods/TimeFreeze/ReadMe.txt deleted file mode 100644 index f65f488a..00000000 --- a/GeneralMods/TimeFreeze/ReadMe.txt +++ /dev/null @@ -1,8 +0,0 @@ -TimeFreeze - -Version 1.0.0 Windows/Mac/Linux - -Created: 3/2/17 6:07 P.M -Updated: 3/2/17 6:07 P.M - -Description: Freezes the passage of time while indoors with some extra config options for balancing and play style. \ No newline at end of file diff --git a/GeneralMods/TimeFreeze/TimeFreeze.csproj b/GeneralMods/TimeFreeze/TimeFreeze.csproj index 5da42a3d..13f289da 100644 --- a/GeneralMods/TimeFreeze/TimeFreeze.csproj +++ b/GeneralMods/TimeFreeze/TimeFreeze.csproj @@ -42,7 +42,7 @@ - + diff --git a/README.md b/README.md new file mode 100644 index 00000000..d7ab8eab --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +This repository contains my SMAPI mods for Stardew Valley. See the individual mods for +documentation and release notes. + +## Mods +Active mods: +* **[Auto Speed](http://www.nexusmods.com/stardewvalley/mods/443)** ([source](AutoSpeed)) + _Lets you move faster without the need to enter commands in the console._ + +* **[Billboard Anywhere](http://www.nexusmods.com/stardewvalley/mods/492)** ([source](BillboardAnywhere)) + _Lets you look at the billboard anywhere in-game for easy access to upcoming events and birthdays._ + +* **[Build Endurance](http://www.nexusmods.com/stardewvalley/mods/445)** ([source](BuildEndurance)) + _Lets you level up your endurance to increase your max stamina as you play._ + +* **[Build Health](http://www.nexusmods.com/stardewvalley/mods/446)** ([source](BuildHealth)) + _Lets you level up your endurance to increase your max health as you play._ + +* **[Buy Back Collectables](http://www.nexusmods.com/stardewvalley/mods/507)** ([source](BuyBackCollectables)) + _Lets you buy items from the collectables menu by pressing a key, at a configurable markup._ + +* **[Daily Quest Anywhere](http://www.nexusmods.com/stardewvalley/mods/513)** ([source](DailyQuestAnywhere)) + _Lets you open the daily quest menu from anywhere in-game._ + +* **[Fall 28 Snow Day](http://www.nexusmods.com/stardewvalley/mods/486)** ([source](Fall28SnowDay)) + _Snow falls on the last day of fall._ + +* **[Happy Birthday](http://www.nexusmods.com/stardewvalley/mods/520)** ([source](HappyBirthday)) + _Lets you pick a day for your birthday. On your birthday, you get letters from your parents, and + villagers give you gifts and wish you happy birthday._ + +* **[More Rain](http://www.nexusmods.com/stardewvalley/mods/441)** ([source](MoreRain)) + _Lets you adjust the probability of rain and storms for each season._ + +* **[Museum Rearranger](http://www.nexusmods.com/stardewvalley/mods/428)** ([source](MuseumRearranger)) + _Lets you rearrange donated items in the museum by pressing a key, even if you don't have a new + item to donate._ + +* **[Night Owl](http://www.nexusmods.com/stardewvalley/mods/433)** ([source](NightOwl)) + _Lets you stay up a full 24 hours instead of collapsing at 2am, including a morning light + transition as the sun rises._ + +* **[No More Pets](http://www.nexusmods.com/stardewvalley/mods/506)** ([source](NoMorePets)) + _Removes all pets from the game._ + +* **[Save Anywhere](http://www.nexusmods.com/stardewvalley/mods/444)** ([source](SaveAnywhere)) + _Lets you save your game anywhere by pressing a key._ + +* **[Save Backup](http://www.nexusmods.com/stardewvalley/mods/435)** ([source](SaveBackup)) + _Automatically backs up your save files before you play and every in-game night._ + +* **[Stardew Symphony](http://www.nexusmods.com/stardewvalley/mods/425)** ([source](StardewSymphony)) + _Lets you add music packs to Stardew Valley and play them without editing the game's default + sound files. Music can be conditional on location, season, and weather._ + +* **[Time Freeze](http://www.nexusmods.com/stardewvalley/mods/973)** ([source](TimeFreeze)) + _Freezes time while indoors. Configurably lets time pass while bathing._ + +Inactive mods: +* **Custom Shops Redux GUI** ([source](CustomShopsRedux)) + _In development. Lets you create custom shops by editing text files._ + +## Compiling the mods +Installing stable releases from Nexus Mods is recommended for most users. If you really want to +compile the mod yourself, read on. + +These mods use the [crossplatform build config](https://github.com/Pathoschild/Stardew.ModBuildConfig#readme) +so they can be built on Linux, Mac, and Windows without changes. See [the build config documentation](https://github.com/Pathoschild/Stardew.ModBuildConfig#readme) +for troubleshooting. + +To compile a mod and add it to your game's `Mods` directory: + +1. Rebuild the project in [Visual Studio](https://www.visualstudio.com/vs/community/) or [MonoDevelop](http://www.monodevelop.com/). + This will compile the code and package it into the mod directory. +2. Launch the project with debugging. + This will start the game through SMAPI and attach the Visual Studio debugger. + +To package a mod for release: + +1. Rebuild the project in release mode. +2. The release zips will be generated in the `_releases` folder.