add or expand documentation for every mod

AnimalSocialMenu/docs/README.md

@@ -1,7 +1,20 @@
-# Animal Social Menu
-A social menu for your animals. Check your animals' friendship values and if they need petting.
+**Animal Social Menu** is a [Stardew Valley](http://stardewvalley.net/) mod which adds a social
+menu for your animals. Check your animals' friendship values and if they need petting.
 
 ![](screenshot.png)
 
+## Install
+1. Install the latest version of...
+   * [SMAPI](https://smapi.io);
+   * and [SpaceCore](https://www.nexusmods.com/stardewvalley/mods/1348).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/3283).
+3. Run the game using SMAPI.
+
+## Use
+Click the extra heart tab at the top of the in-game menu.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
 ## See also
 * [Release notes](release-notes.md)

AnotherHungerMod/docs/README.md

@@ -1,22 +1,35 @@
-# Another Hunger Mod
-This mod adds a hunger system to the game.
+**Another Hunger Mod** is a [Stardew Valley](http://stardewvalley.net/) mod which adds a hunger
+system to the game.
 
-Fullness cap of 100, losing 0.8 every 10 minutes. Eating food restores fullness based on its
-edibility value, which is what the game uses to calculate stamina and health restored.
-(Essentially, the more stamina it restores, the more fullness it restores.
+![](screenshot.png)
 
-When you have over 80 fullness, you get a speed, defense, and attack buff.  
-When you have below 25 fullness, you get a speed debuff.  
-When you reach 0 fullness, you start taking starvation damage.
+## Install
+1. Install the latest version of...
+   * [SMAPI](https://smapi.io);
+   * and [SpaceCore](https://www.nexusmods.com/stardewvalley/mods/1348).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/3379).
+3. Run the game using SMAPI.
 
-Starving to death resets your fullness to 25.
+## Use
+* You have a fullness cap of 100, which reduces by 0.8 points every 10 minutes. Eating food
+  restores fullness based on its edibility value, which is what the game uses to calculate stamina
+  and health restored. (Essentially, the more stamina it restores, the more fullness it restores.)
 
-ADDITIONALLY. You have to feed your spouse each day. If you don't, you take a relationship hit of
-50 points.
+  Your fullness provides buffs or debuffs:
 
-Most all numbers are configurable.
+  fullness | effects
+  -------- | -------
+  over 80  | improved speed and attack.
+  below 25 | reduced speed.
+  0        | starvation damage over time.
 
-![](screenshot.png)
+  Starving to death resets your fullness to 25.
+
+* You need to feed your spouse each day. Forgetting to feed them will reduce friendship by 50 points
+per day.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
 
 ## See also
 * [Release notes](release-notes.md)

ArcadeRoom/docs/README.md

@@ -0,0 +1,25 @@
+**Arcade Room** is a [Stardew Valley](http://stardewvalley.net/) mod which adds an arcade room in
+the Saloon.
+
+![](screenshot-interior.png)
+
+## Install
+This mod isn't released yet.
+
+1. ~~Install the latest version of...
+   * ~~[SMAPI](https://smapi.io);~~
+   * ~~and [SpaceCore](https://www.nexusmods.com/stardewvalley/mods/1348).~~
+2. ~~Install this mod from Nexus Mods.~~
+3. ~~Run the game using SMAPI.~~
+
+## Use
+Just walk to the Saloon and enter the new arcade door! The arcade currently includes Junimo Kart
+and Prairie King.
+
+![](screenshot-door.png)
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
+## See also
+* [Release notes](release-notes.md)

BetterMeteorites/docs/README.md

@@ -1,7 +1,18 @@
-# Better Meteorites
-Better meteorite drops. They drop a lot of stone, coal, iridium ore, and geodes.
+**Better Meteorites** is a [Stardew Valley](http://stardewvalley.net/) mod which improves loot
+dropped by meteorites. They drop a lot of stone, coal, iridium ore, and geodes.
 
 ![](screenshot.png)
 
+## Install
+1. Install the latest version of [SMAPI](https://smapi.io).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/5096).
+3. Run the game using SMAPI.
+
+## Use
+Just break meteorites and they'll drop new items.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
 ## See also
 * [Release notes](release-notes.md)

BetterShopMenu/docs/README.md

@@ -1,14 +1,19 @@
-# Better Shop Menu
-This is the source code. Releases can be found at:
-* [My site](http://spacechase0.com/mods/stardew-valley/better-shop-menu/)
-* [Nexus](http://www.nexusmods.com/stardewvalley/mods/2012/?)
-* [Chucklefish forums](https://community.playstarbound.com/resources/better-shop-menu.5245/)
+**Better Shop Menu** is a [Stardew Valley](http://stardewvalley.net/) mod which changes the shop
+menu into a grid (can be disabled in the config file), and adds buttons to filter by category and
+sort by price/name.
 
-Changes the shop menu to be a grid. (Can be disabled in the config file.)
+![](screenshot.png)
 
-Adds a couple of buttons allowing you to filter by category, and sort by price or item name.
+## Install
+1. Install the latest version of [SMAPI](https://smapi.io).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/2012).
+3. Run the game using SMAPI.
 
-![](screenshot.png)
+## Use
+Just open any shop menu to see the new UI. Click the buttons in the bottom-left to sort/filter.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
 
 ## See also
 * [Release notes](release-notes.md)

BiggerCraftables/docs/README.md

@@ -1,9 +1,21 @@
-# Bigger Craftables
-Make big craftables bigger than one tile!
-
-Example pack [here](https://spacechase0.com/files/sdvmod/BiggerCraftables.Example.zip).
+**Bigger Craftables** is a [Stardew Valley](http://stardewvalley.net/) mod which lets content packs
+add bigcraftables bigger than one tile!
 
 ![](screenshot.png)
 
+## Install
+1. Install the latest version of [SMAPI](https://smapi.io).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/7530).
+3. Run the game using SMAPI.
+
+## Use
+**This is a framework for mod authors.** If you're a player, you only need to install the mod and
+it'll work automatically for content packs that use it.
+
+See [example content pack](https://spacechase0.com/files/sdvmod/BiggerCraftables.Example.zip).
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
 ## See also
 * [Release notes](release-notes.md)

BiggerJunimoChest/docs/README.md

@@ -0,0 +1,18 @@
+**Bigger Junimo Chest** is a [Stardew Valley](http://stardewvalley.net/) mod which increases Junimo
+chests from four item slots to 36, similar to regular chests.
+
+## Install
+This mod isn't released yet.
+
+1. ~~Install the latest version of [SMAPI](https://smapi.io).~~
+2. ~~Install this mod from Nexus Mods.~~
+3. ~~Run the game using SMAPI.~~
+
+## Use
+This mod works automatically; just open Junimo chests and enjoy the new capacity!
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
+## See also
+* [Release notes](release-notes.md)

BugNet/docs/README.md

@@ -1,9 +1,21 @@
-# Bug Net
-A net that lets you catch bugs and other critters that you find.
-
-Net purchaseable for 500g at Pierre's shop.
+**Bug Net** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you catch critters with
+a net.
 
 ![](screenshot.gif)
 
+## Install
+1. Install the latest version of...
+   * [SMAPI](https://smapi.io);
+   * and [SpaceCore](https://www.nexusmods.com/stardewvalley/mods/1348).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/5099).
+3. Run the game using SMAPI.
+
+## Use
+Buy the bug net from Pierre's shop for 500g, hold it like any other tool, and swing it to catch
+critters.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
 ## See also
 * [Release notes](release-notes.md)

BuildableLocationsFramework/docs/README.md

@@ -0,0 +1,18 @@
+**Buildable Locations Framework** is a [Stardew Valley](http://stardewvalley.net/) mod which lets
+you construct buildings outside the farm.
+
+## Install
+This mod isn't released yet.
+
+1. ~~Install the latest version of [SMAPI](https://smapi.io).~~
+2. ~~Install this mod from Nexus Mods.~~
+3. ~~Run the game using SMAPI.~~
+
+## Use
+This mod isn't fully implemented yet.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
+## See also
+* [Release notes](release-notes.md)

CapstoneProfessions/docs/README.md

@@ -1,11 +1,23 @@
-# Capstone Professions
-Once you max out all your skills, a new profession choice arrives...
+**Capstone Professions** is a [Stardew Valley](http://stardewvalley.net/) mod which adds a final
+choice of professions once you max out all your skills.
 
-Both choices stack with multiple players.
+![](screenshot.png)
 
-Supports All Professions.
+## Install
+1. Install the latest version of...
+   * [SMAPI](https://smapi.io);
+   * and [SpaceCore](https://www.nexusmods.com/stardewvalley/mods/1348).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/7636).
+3. Run the game using SMAPI.
 
-![](screenshot.png)
+## Use
+Once you've maxed out all your skill levels, a new profession choice arrives overnight... Both
+professions stack with multiple players.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
+Compatible with [All Professions](https://www.nexusmods.com/stardewvalley/mods/174).
 
 ## See also
 * [Release notes](release-notes.md)

CarryChest/docs/README.md

@@ -1,14 +1,20 @@
-# Carry Chest
-This is the source code. Releases can be found at:
-* [My site](http://spacechase0.com/mods/stardew-valley/carry-chest/)
-* [Nexus](http://www.nexusmods.com/stardewvalley/mods/1333/?)
-* [Chucklefish forums](http://community.playstarbound.com/resources/carry-chest.4851/)
+**Carry Chest** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you move chests
+around, even if they have things in them.
 
-This mod allows you to move chests around, even if they have things in them.
+![](screenshot.png)
 
-Warning: Placing a chest without the mod will lose its contents.
+## Install
+1. Install the latest version of [SMAPI](https://smapi.io).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/1333).
+3. Run the game using SMAPI.
 
-![](screenshot.png)
+## Use
+Just pick up a chest like normal, even if it's not empty!
+
+**Caution:** placing a non-empty chest without the mod installed will lose its contents.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
 
 ## See also
 * [Release notes](release-notes.md)

CaveFarm/docs/README.md

@@ -0,0 +1,18 @@
+**Cave Farm** is a [Stardew Valley](http://stardewvalley.net/) mod which creates a cave farm type
+with diggable walls.
+
+## Install
+This mod isn't released yet.
+
+1. ~~Install the latest version of [SMAPI](https://smapi.io).~~
+2. ~~Install this mod from Nexus Mods.~~
+3. ~~Run the game using SMAPI.~~
+
+## Use
+This mod isn't fully implemented yet.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
+## See also
+* [Release notes](release-notes.md)

CombatLevelDamageScaler/docs/README.md

@@ -1,5 +1,16 @@
-# Combat Level Damage Scaler
-Scale your damage up by 5% per combat level (configurable).
+**Combat Level Damage Scaler** is a [Stardew Valley](http://stardewvalley.net/) mod which increases
+your damage by 5% per combat level (configurable).
+
+## Install
+1. Install the latest version of [SMAPI](https://smapi.io).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/3905).
+3. Run the game using SMAPI.
+
+## Use
+The damage you deal will be buffed automatically based on your combat skill level.
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
 
 ## See also
 * [Release notes](release-notes.md)

ConsoleCode/docs/README.md

@@ -1,24 +1,49 @@
-# Console Code
-This mod lets you write and execute C# code from the console.
+**Console Code** is a [Stardew Valley](http://stardewvalley.net/) mod which lets you write and
+execute C# code from the SMAPI console.
 
-You can write a short snippet using `cs <code>`, such as cs `Game1.activeClickableMenu = null;` or
-`cs return Game1.player.money;`.
+## Install
+1. Install the latest version of [SMAPI](https://smapi.io).
+2. Install [this mod from Nexus Mods](http://www.nexusmods.com/stardewvalley/mods/3101).
+3. Run the game using SMAPI.
 
-* Note: Snippets with "quotes" don't work in the console due to the SMAPI command argument parser.
+## Use
+### Short snippets
+You can run code directly in the SMAPI console using the `cs` command. You can separate multiple
+expressions with `;`. If the last expression returns a value, it'll be shown in the SMAPI console.
 
-Alternatively, you can load a block from a file, like `cs --script file` and it will load a script
-from the mod folder. The script must not include imports, `public class Xyz`, etc. Example script:
+For example:
 
+```
+cs Game1.player.Money = 5000; Game1.player.currentLocation.Name
+> Output: "FarmHouse"
+```
+
+You can't use double quotes (`"`) directly in the console (due to the SMAPI command parser), but
+you can replace them with backticks (<code>&#96;</code>).
+
+### Script files
+You can load a block from a file in Console Code's folder. The script must not include `using`
+statements, class declarations, etc.
+
+For example, let's say you have this `sell-items.cs` file in the mod folder:
 ```c#
-foreach ( var item in Game1.player.items )
+foreach (var item in Game1.player.items)
 {
-	if ( item == null )
-		continue;
+    if (item == null)
+        continue;
 
-	Game1.player.money += item.salePrice();
-	Game1.player.removeItemFromInventory( item );
+    Game1.player.money += item.salePrice();
+    Game1.player.removeItemFromInventory(item);
 }
 ```
 
+You can execute it like this:
+```
+cs --script sell-items.cs
+```
+
+## Compatibility
+Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer.
+
 ## See also
 * [Release notes](release-notes.md)