Skip to content

Commit

Permalink
Update SynthesisMeta.json for v1.1.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
kjack9 committed May 8, 2021
1 parent ba76491 commit 0865f16
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion BookSmart/SynthesisMeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"Nickname": "BookSmart",
"Visibility": "Visible",
"OneLineDescription": "Enhance book titles to show more information about them (configurable).",
"LongDescription": "Enhance book titles to show more information about them. Each label can be enabled/disabled in settings.\r\n\r\n* LABEL TYPES *\r\nSkill label:\r\nAdds a label to any books you find that will cause you to gain skills. Dynamically pulls this information from any book as long as it has the standard 'Teaches Skill' script attached. Will not work if a custom mod is using different scripts to apply the skill up.\r\n\r\nMap Marker label:\r\nAdds a label to any books you find that will give you a map marker via script. Will work as long as the script is on the book itself and contains \"MapMarker\" (case insensitive) somehwere in the script name. Will not apply to scripts belonging to the quest record instead of the book. This may be able to be improved in the future.\r\n\r\nQuest label:\r\nAdds a label to any books you find that are involved in a quest. Enabling this label will require the patcher to create a quest book cache at the beginning of each run, which will extend processing time a bit. This cache looks through all quests and finds any aliases that reference a book. If found, that book will be marked as a quest book. Also checks for scripts on the book itself that have the word \"Quest\" (case insenstive) in the name.\r\n\r\n* LABEL SETTINGS * \r\nLabel Format:\r\nStar: *BookName\r\nShort: <Alch> BookName\r\nLong: <Alchemy> BookName\r\n\r\nLabel Position:\r\nBefore_Name: <Alchemy> BookName\r\nAfter_Name: BookName <Alchemy>\r\n\r\nEncapsulating Characters:\r\nParenthesis: (Alchemy) BookName\r\nCurly Brackets: {Alchemy} BookName\r\nSquare Brackets: [Alchemy] BookName\r\nChevrons: <Alchemy> BookName\r\nStars: *Alchemy* BookName",
"LongDescription": "# SynBookSmart\nEnhance book titles to show more information about them. Fully configurable.\n\n## Settings\nAll settings can be configured inside the Synthesis app.\n\n### Add Skill Labels\nAdds a label to any books you find that will cause you to gain skills. Dynamically pulls this information from any book as long as it has the standard 'Teaches Skill' script attached. Will not work if a custom mod is using different scripts to apply the skill up.\n\n### Add Map Marker Labels\nAdds a label to any books you find that will give you a map marker via script. Will work as long as the script is on the book itself and contains \"MapMarker\" (case insensitive) somehwere in the script name. Will not apply to scripts belonging to the quest record instead of the book. This may be able to be improved in the future.\n\n#### Add Quest Labels\nAdds a label to any books you find that are involved in a quest. Enabling this label will require the patcher to create a quest book cache at the beginning of each run, which will extend processing time a bit. This cache looks through all quests and finds any aliases that reference a book. If found, that book will be marked as a quest book. Also checks for scripts on the book itself that have the word \"Quest\" (case insenstive) in the name. Please open a [Github issue](https://github.com/Synthesis-Collective/SynBookSmart/issues) if you find a quest book that is not being caught by the patcher, even if it's from a mod.\n\n### Label Position\n- Before_Name\n - `<Alchemy> Snape's Book of Potions`\n- After_Name\n - `Snape's Book of Potions <Alchemy>`\n\n### Label Format\n- Star\n - `*Snape's Book of Potions`\n- Short\n - `<Alch> Snape's Book of Potions`\n- Long\n - `<Alchemy> Snape's Book of Potions`\n\n### Encapsulating Characters\nThis setting has no effect if a Label Format of `Star` is chosen.\n\n- Parenthesis\n - `(Alch) Snape's Book of Potions`\n- Curly Brackets\n - `{Alch} Snape's Book of Potions`\n- Square Brackets\n - `[Alch] Snape's Book of Potions`\n- Chevrons\n - `<Alch> Snape's Book of Potions`\n- Stars\n - `*Alch* Snape's Book of Potions`\n",
"PreferredAutoVersioning": "Default",
"RequiredMods": []
}

0 comments on commit 0865f16

Please sign in to comment.