diff --git a/README.md b/README.md index fab784f..543f260 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,29 @@ -[size=5][b]Ditch the menus! See real-time gift suggestions based on the items in your inventory![/b][/size] - -[size=3][i]Are you tired of constantly having to dig through multiple wiki pages or mod menus every time you want to give a villager a gift? Wouldn't it be easier if there was just a visual indicator of who can receive a gift and who you can talk to? You deserve [b]Better Friendship[/b]![/i][/size] - -[size=2][color=#6aa84f][b]Compatible with Stardew Valley 1.5.5+ on Linux, Mac, and Windows[/b].[url=https://github.com/Pathoschild/SMAPI/releases]Requires SMAPI 3.13.1 or later.[/url][/color][/size] - -[left][img]https://media3.giphy.com/media/QV6wsQEJPypTFPvyCR/200.gif[/img][/left][size=5]Features[/size] -[list] -[*][size=3]Each villager shows an at-a-glance display of whether they can receive gifts or want to be talked to![/size] -[*][size=3]Simple gift suggestions based on what you are currently carrying![/size] -[*][size=3]Customizable preferences with built-in config menu (requires [url=https://www.nexusmods.com/stardewvalley/mods/5098]Generic Mod Config Menu[/url])[/size][list] - [*]Toggle for the prompts to speak with villagers - [*]Set minimum level of gift suggestions to display (e.g. Only show "loved" gifts) - [*]Customize the number of suggestions to cycle through and time in between cycling - [*]Ability to disable prompts when friendships are maxed and can't decay - [*]Preference to only display the highest quality available for each item -[/list] -[/list][size=5]Install [/size] -[list=1] -[*][size=3][url=https://github.com/Pathoschild/SMAPI/releases]Install the latest version of SMAPI[/url].[/size] -[*][size=3]Unzip the mod folder into Stardew Valley/Mods.[/size] -[*][size=3](optional) Install [url=https://www.nexusmods.com/stardewvalley/mods/5098]Generic Mod Config Menu[/url] for easy config setting management.[/size] -[*][size=3]Run the game using SMAPI.[/size] -[/list] -[size=5]Source[/size] -[size=3][url=https://github.com/urbanyeti/stardew-better-friendship]https://github.com/urbanyeti/stardew-better-friendship[/url][/size] - -[size=5]Other Mod[/size] -[size=3]If you like this mod, consider checking out my other mod, [url=https://www.nexusmods.com/stardewvalley/mods/859]Better Ranching[/url] (>15k endorsements)! I took a similar approach to try to remove some of the pain points from the ranching experience while still sticking to the spirit of the game. [/size] +# Ditch the menus! See real-time gift suggestions based on the items in your inventory! + +*Are you tired of constantly having to dig through multiple wiki pages or mod menus every time you want to give a villager a gift? Wouldn't it be easier if there was just a visual indicator of who can receive a gift and who you can talk to? You deserve **Better Friendship**!* + +**Compatible with Stardew Valley 1.5.5+ on Linux, Mac, and Windows** [Requires SMAPI 3.13.1 or later.](https://github.com/Pathoschild/SMAPI/releases) + +![](https://github.com/urbanyeti/stardew-better-friendship/blob/main/misc/multiple-gift.gif) + +## Features + +- Each villager shows an at-a-glance display of whether they can receive gifts or want to be talked to! +- Simple gift suggestions based on what you are currently carrying! +- Customizable preferences with built-in config menu (requires [Generic Mod Config Menu](https://www.nexusmods.com/stardewvalley/mods/5098)) + - Toggle for the prompts to speak with villagers + - Set minimum level of gift suggestions to display (e.g. Only show "loved" gifts) + - Customize the number of suggestions to cycle through and time in between cycling + - Ability to disable prompts when friendships are maxed and can't decay + - Preference to only display the highest quality available for each item + +## Install + +1. [Install the latest version of SMAPI](https://github.com/Pathoschild/SMAPI/releases). +2. Unzip the mod folder into Stardew Valley/Mods. +3. (optional) Install [Generic Mod Config Menu](https://www.nexusmods.com/stardewvalley/mods/5098) for easy config setting management. +4. Run the game using SMAPI. + +## Other Mod +If you like this mod, consider checking out my other mod, [Better Ranching](https://www.nexusmods.com/stardewvalley/mods/859) (>15k endorsements)! I took a similar approach to try to remove some of the pain points from the ranching experience while still sticking to the spirit of the game. +(https://github.com/urbanyeti/stardew-better-ranching)