Skip to content

Commit

Permalink
[Unsettling] Add config options to mod documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonqora committed Oct 6, 2020
1 parent 869cbfc commit 69da440
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
24 changes: 24 additions & 0 deletions UnsettlingDescriptions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,30 @@ You should see the new item descriptions show up right away. Almost every descri

If you want to help add to this mod by suggesting description ideas for missed items, you can join our contributor group by commenting on our [shared google speadsheet document!](https://docs.google.com/spreadsheets/d/1s3Upkb2qTd6m02gyfdLdIgkqdHE1TD2ga0LU8BdDnKY/edit?usp=sharing)


## Config Settings
After running SMAPI at least once with Unsettling Item Descriptions (and Content Patcher) installed, a `config.json` file will be created inside the `[CP] Unsettling Item Descriptions` mod folder. Open it in any text editor to change your config settings.


- **DescribeObjects:** Use unsettling descriptions for normal objects. Defaults to `true`.

- **DescribeBigCraftables:** Use unsettling descriptions for big craftables (large objects). Defaults to `true`.

- **DescribeWeapons:** Use unsettling descriptions for weapons. Defaults to `true`.

- **DescribeTools:** Use unsettling descriptions for tools. Defaults to `true`.


- **DescribeBoots:** Use unsettling descriptions for shoes and boots. Defaults to `true`.

- **DescribeHats:** Use unsettling descriptions for hats and headgear. Defaults to `true`.

- **DescribeClothing:** Use unsettling descriptions for pants and shirts. Defaults to `true`.


- **DescribeBuildings:** Use unsettling descriptions for farm buildings. Defaults to `true`.


---
## Notes
### ACKNOWLEDGEMENTS
Expand Down
23 changes: 23 additions & 0 deletions UnsettlingDescriptions/promo/nexus_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,29 @@ If you want to help add to this mod by suggesting description ideas for missed i



[size=5][center][b]Config Settings[/b][/center][/size]After running SMAPI at least once with Unsettling Item Descriptions (and Content Patcher) installed, a [code]config.json[/code] file will be created inside the [code][CP] Unsettling Item Descriptions[/code] mod folder. Open it in any text editor to change your config settings.

[b][size=3]DescribeObjects:[/size][/b]
Use unsettling descriptions for normal objects. Defaults to [code]true[/code].
[b][size=3]DescribeBigCraftables:[/size][/b]
Use unsettling descriptions for big craftables (large objects). Defaults to [code]true[/code].
[b][size=3]DescribeWeapons:[/size][/b]
Use unsettling descriptions for weapons. Defaults to [code]true[/code].
[b][size=3]DescribeTools:[/size][/b]
Use unsettling descriptions for tools. Defaults to [code]true[/code].

[b][size=3]DescribeBoots:[/size][/b]
Use unsettling descriptions for shoes and boots. Defaults to [code]true[/code].
[b][size=3]DescribeHats:[/size][/b]
Use unsettling descriptions for hats and headwear. Defaults to [code]true[/code].
[b][size=3]DescribeClothing:[/size][/b]
Use unsettling descriptions for pants and shirts. Defaults to [code]true[/code].

[b][size=3]DescribeBuildings:[/size][/b]
Use unsettling descriptions for farm buildings. Defaults to [code]true[/code].



[b][size=5][center]Notes[/center][/size][/b][size=4][b]ACKNOWLEDGEMENTS[/b][/size]
[list]
[*]This project was made possible by the joint creativity of many people! Huge thanks to contributors [url=https://www.nexusmods.com/users/8049772]Draylon[/url], [url=https://www.nexusmods.com/users/61873026]SwiftIsHere[/url], [url=https://www.nexusmods.com/users/48380238]foggywizard[/url], [url=https://www.nexusmods.com/users/84002498]Forsy :D[/url], [url=https://www.nexusmods.com/users/41011220]ItsBenter[/url], [url=https://www.nexusmods.com/users/12004908]Undare[/url], [url=https://www.nexusmods.com/users/3391358]Ruukas[/url], [url=https://www.nexusmods.com/users/85656033]ExnoticTest[/url], [url=https://github.com/KatrinaHoffert]Kat[/url], [url=https://www.nexusmods.com/users/94394293]General Alexis[/url], [url=https://www.nexusmods.com/users/18592979?tab=user+files]LenneDalben[/url], Glowbug, Wingheart, [url=https://www.nexusmods.com/stardewvalley/users/92469153]Arknir[/url], ssoshwac, Wobin, [url=https://www.nexusmods.com/stardewvalley/users/24986819]Gervig91[/url], [url=https://www.nexusmods.com/users/67314851?tab=user+files]Arcane[/url], and [url=https://www.nexusmods.com/users/91777683]icecreamrat[/url].
Expand Down

0 comments on commit 69da440

Please sign in to comment.