Release: Version 1.3

FossilOrigin-Name: 9f7e1f8b4e9fe05c319e678ee20dbc1aa49a5b7fa797b1e836817a4cc51af6ae

CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## v1.3 — 2024-06-16
+Tested to work on game version 207.71
+
+* Reorganizes options
+
+Meta:
+
+* Add `CHANGELOG.md`
+* Update icon
+* Update cover photo
+* Update `LICENSE`
+
+## v1.2 — 2022-07-24
+Tested to work on game version 203.54
+
+* Expands customization options (range of coloring highlight)
+
+## v1.1 — 2022-07-24
+Tested to work on game version 203.54
+
+* Adds customization options regarding hint display
+  * coloring (on or off)
+  * capitalization (key words, whole clue, and none)
+
+## v1.0 — 2022-05-25
+
+* Initial release

LICENSE

@@ -1,121 +1,5 @@
-Creative Commons Legal Code
+Copyright (C) 2022–2023 by librarianmage <[email protected]>
 
-CC0 1.0 Universal
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
 
-    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
-    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
-    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
-    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
-    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
-    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
-    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
-    HEREUNDER.
-
-Statement of Purpose
-
-The laws of most jurisdictions throughout the world automatically confer
-exclusive Copyright and Related Rights (defined below) upon the creator
-and subsequent owner(s) (each and all, an "owner") of an original work of
-authorship and/or a database (each, a "Work").
-
-Certain owners wish to permanently relinquish those rights to a Work for
-the purpose of contributing to a commons of creative, cultural and
-scientific works ("Commons") that the public can reliably and without fear
-of later claims of infringement build upon, modify, incorporate in other
-works, reuse and redistribute as freely as possible in any form whatsoever
-and for any purposes, including without limitation commercial purposes.
-These owners may contribute to the Commons to promote the ideal of a free
-culture and the further production of creative, cultural and scientific
-works, or to gain reputation or greater distribution for their Work in
-part through the use and efforts of others.
-
-For these and/or other purposes and motivations, and without any
-expectation of additional consideration or compensation, the person
-associating CC0 with a Work (the "Affirmer"), to the extent that he or she
-is an owner of Copyright and Related Rights in the Work, voluntarily
-elects to apply CC0 to the Work and publicly distribute the Work under its
-terms, with knowledge of his or her Copyright and Related Rights in the
-Work and the meaning and intended legal effect of CC0 on those rights.
-
-1. Copyright and Related Rights. A Work made available under CC0 may be
-protected by copyright and related or neighboring rights ("Copyright and
-Related Rights"). Copyright and Related Rights include, but are not
-limited to, the following:
-
-  i. the right to reproduce, adapt, distribute, perform, display,
-     communicate, and translate a Work;
- ii. moral rights retained by the original author(s) and/or performer(s);
-iii. publicity and privacy rights pertaining to a person's image or
-     likeness depicted in a Work;
- iv. rights protecting against unfair competition in regards to a Work,
-     subject to the limitations in paragraph 4(a), below;
-  v. rights protecting the extraction, dissemination, use and reuse of data
-     in a Work;
- vi. database rights (such as those arising under Directive 96/9/EC of the
-     European Parliament and of the Council of 11 March 1996 on the legal
-     protection of databases, and under any national implementation
-     thereof, including any amended or successor version of such
-     directive); and
-vii. other similar, equivalent or corresponding rights throughout the
-     world based on applicable law or treaty, and any national
-     implementations thereof.
-
-2. Waiver. To the greatest extent permitted by, but not in contravention
-of, applicable law, Affirmer hereby overtly, fully, permanently,
-irrevocably and unconditionally waives, abandons, and surrenders all of
-Affirmer's Copyright and Related Rights and associated claims and causes
-of action, whether now known or unknown (including existing as well as
-future claims and causes of action), in the Work (i) in all territories
-worldwide, (ii) for the maximum duration provided by applicable law or
-treaty (including future time extensions), (iii) in any current or future
-medium and for any number of copies, and (iv) for any purpose whatsoever,
-including without limitation commercial, advertising or promotional
-purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
-member of the public at large and to the detriment of Affirmer's heirs and
-successors, fully intending that such Waiver shall not be subject to
-revocation, rescission, cancellation, termination, or any other legal or
-equitable action to disrupt the quiet enjoyment of the Work by the public
-as contemplated by Affirmer's express Statement of Purpose.
-
-3. Public License Fallback. Should any part of the Waiver for any reason
-be judged legally invalid or ineffective under applicable law, then the
-Waiver shall be preserved to the maximum extent permitted taking into
-account Affirmer's express Statement of Purpose. In addition, to the
-extent the Waiver is so judged Affirmer hereby grants to each affected
-person a royalty-free, non transferable, non sublicensable, non exclusive,
-irrevocable and unconditional license to exercise Affirmer's Copyright and
-Related Rights in the Work (i) in all territories worldwide, (ii) for the
-maximum duration provided by applicable law or treaty (including future
-time extensions), (iii) in any current or future medium and for any number
-of copies, and (iv) for any purpose whatsoever, including without
-limitation commercial, advertising or promotional purposes (the
-"License"). The License shall be deemed effective as of the date CC0 was
-applied by Affirmer to the Work. Should any part of the License for any
-reason be judged legally invalid or ineffective under applicable law, such
-partial invalidity or ineffectiveness shall not invalidate the remainder
-of the License, and in such case Affirmer hereby affirms that he or she
-will not (i) exercise any of his or her remaining Copyright and Related
-Rights in the Work or (ii) assert any associated claims and causes of
-action with respect to the Work, in either case contrary to Affirmer's
-express Statement of Purpose.
-
-4. Limitations and Disclaimers.
-
- a. No trademark or patent rights held by Affirmer are waived, abandoned,
-    surrendered, licensed or otherwise affected by this document.
- b. Affirmer offers the Work as-is and makes no representations or
-    warranties of any kind concerning the Work, express, implied,
-    statutory or otherwise, including without limitation warranties of
-    title, merchantability, fitness for a particular purpose, non
-    infringement, or the absence of latent or other defects, accuracy, or
-    the present or absence of errors, whether or not discoverable, all to
-    the greatest extent permissible under applicable law.
- c. Affirmer disclaims responsibility for clearing rights of other persons
-    that may apply to the Work or any use thereof, including without
-    limitation any person's Copyright and Related Rights in the Work.
-    Further, Affirmer disclaims responsibility for obtaining any necessary
-    consents, permissions or other rights required for any use of the
-    Work.
- d. Affirmer understands and acknowledges that Creative Commons is not a
-    party to this document and has no duty or obligation with respect to
-    this CC0 or use of the Work.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Options.xml

@@ -1,6 +1,46 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <options>
-  <option ID="Books_FinderOfRuin_Highlight" DisplayText="Highlight hint text" Category="Finder of Ruin" Type="Combo" Values="None,Key Words,Entire Clue" Default="Key Words"/>
-  <option ID="Books_FinderOfRuin_HighlightStyle" DisplayText="Highlight color style" Category="Finder of Ruin" Type="Combo" Values="White,Colored Key Words" Default="Colored Key Words" />
-  <option ID="Books_FinderOfRuin_Capitalization" DisplayText="CAPTIALIZE hint text" Category="Finder of Ruin" Type="Combo" Values="Default,Key Words,Entire Clue" Default="Default" />
+  <option ID="Books_FinderOfRuin_EnableFormatting" DisplayText="Enable clue formatting" Category="Finder of Ruin" Type="Checkbox" Default="Yes">
+    <helptext>
+      Add visual indicators to the Ruin of House Isner clues, found in white-titled books.
+    </helptext>
+  </option>
+
+  <option ID="Books_FinderOfRuin_EnableHighlight" Requires="Books_FinderOfRuin_EnableFormatting==Yes" DisplayText="Enable hint text highlighting" Category="Finder of Ruin" Type="Checkbox" Default="Yes">
+    <helptext>
+      Adds color-based indicators to Ruin of Isner clues.
+    </helptext>
+  </option>
+  <option ID="Books_FinderOfRuin_HighlightSpan" Requires="Books_FinderOfRuin_EnableFormatting==Yes,Books_FinderOfRuin_EnableHighlight==Yes" DisplayText="Span of highlight" Category="Finder of Ruin" Type="Combo" Values="Key Words,Entire Clue" Default="Key Words">
+    <helptext>
+      Controls which parts of the clue gets highlighted.
+
+      {{W|Key Words}}: The phrases "masterwork", "Ruin", and "House Isner" will be highlighted.
+      {{W|Entire Clue}}: The entire clue phrase will be highlighted.
+    </helptext>
+  </option>
+  <option ID="Books_FinderOfRuin_HighlightStyle" Requires="Books_FinderOfRuin_EnableFormatting==Yes,Books_FinderOfRuin_EnableHighlight==Yes" DisplayText="Highlight color style" Category="Finder of Ruin" Type="Combo" Values="Only White,Colored Key Words" Default="Colored Key Words">
+    <helptext>
+      Controls how the clue gets colored.
+
+      {{W|Only White}}: The above span will be colored in {{Y|a brighter white}}.
+      {{W|Colored Key Words}}: The phrases "{{c|masterwork}}", "{{r|Ruin}}", and "{{M|House Isner}}" will be colored distinctively, while the rest of the span will be in a {{Y|brighter white}}.
+    </helptext>
+  </option>
+
+  <option ID="Books_FinderOfRuin_EnableUppercasing" Requires="Books_FinderOfRuin_EnableFormatting==Yes" DisplayText="Enable uppercasing hint text" Category="Finder of Ruin" Type="Checkbox" Default="No">
+    <helptext>
+      Adds case-based indicators to Ruin of Isner clues.
+    </helptext>
+  </option>
+  <option ID="Books_FinderOfRuin_UppercasingSpan" Requires="Books_FinderOfRuin_EnableFormatting==Yes,Books_FinderOfRuin_EnableUppercasing==Yes" DisplayText="Span of uppercasing" Category="Finder of Ruin" Type="Combo" Values="Key Words,Entire Clue" Default="Key Words">
+    <helptext>
+      Controls which parts of the clue gets uppercased.
+
+      {{W|Key Words}}: The phrases "MASTERWORK", "RUIN", and "HOUSE ISNER" will be uppercased.
+      {{W|Entire Clue}}: The entire clue phrase will be uppercased.
+    </helptext>
+  </option>
+  <option ID="Books_FinderOfRuin_OptionsVersion" Requires="Books_FinderOfRuin_EnableFormatting==Yes,Books_FinderOfRuin_EnableFormatting==No" Category="Finder of Ruin" Type="Slider" Default="0">
+  </option>
 </options>

README.md

@@ -1,8 +1,20 @@
 # Finder of Ruin
 A mod that aids in the finding of the Ruin of House Isner by making the clues a bit more obvious.
 
-The mod offers two aids: coloring or capitalizing the hint text (key words or the entire clue).
+The mod offers two aids: coloring or uppercasing the hint text (key words or the entire clue).
 
-Tested to work on game version 203.54
+Tested to work on game version 207.71
 
 [Github Page](https://github.com/librarianmage/FinderOfRuin) \| [Workshop Page](https://steamcommunity.com/sharedfiles/filedetails/?id=2812261314) \| [My Caves of Qud Mods (Steam Workshop)](https://steamcommunity.com/profiles/76561198836298826/myworkshopfiles/?appid=333640)
+
+## Installation
+
+Please refer to the Caves of Qud Wiki for [mod installation instructions](https://wiki.cavesofqud.com/wiki/Modding:Installing_a_mod).
+
+## Development
+
+In order for type-checking and auto-completion to work, place the game-generated `Mods.csproj` into the parent directory of this folder.
+
+## License
+
+I share the source of my mods with the intent that they can be useful for others. To this end, the code of this mod has been released with the Zero-Clause BSD (0BSD) license and the assets of this mod (namely, files in the `Assets/` folder) have been released with the Creative Commons Zero v1.0 Universal (CC0-1.0) license.

Scripts/ClueFormatter.cs

@@ -0,0 +1,171 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Text.RegularExpressions;
+using ConsoleLib.Console;
+using static FinderOfRuin.Options.Formatting;
+
+namespace FinderOfRuin
+{
+    /// <summary>
+    ///   Utilities for formatting Isner clues.
+    /// </summary>
+    public static class LoreFormatter
+    {
+        /// <remarks>
+        ///   Inspired by <see href="https://stackoverflow.com/a/7899205">Scott Rippey's StackOverflow answer</see>.
+        /// </remarks>
+        private const string MatchingCurlyBraces =
+            @"(?:[^\{\}]|(?<open>\{)|(?<-open>\}))+(?(open)(?!))";
+
+        /// <remarks>
+        ///   Made public for <see cref="Patches.FormattingPatcher"/>.
+        /// </remarks>
+        public static readonly string CluePattern = $@"\{{({MatchingCurlyBraces})\}}";
+
+        /// <summary>
+        ///   Matches the entire clue fragment. The first group is the inner clue text.
+        /// </summary>
+        public static readonly Regex ClueRegex = new(CluePattern);
+
+        private static readonly string ClueInnerPattern = $@"(?<=\{{){MatchingCurlyBraces}(?=\}})";
+
+        /// <summary>
+        ///   Matches the inner clue text, without the braces.
+        /// </summary>
+        public static readonly Regex ClueInnerRegex = new(ClueInnerPattern);
+
+        /// <summary>
+        ///   Formats the entire clue based on <see cref="Options.Formatting" />.
+        /// </summary>
+        /// <remarks>
+        ///   This function gets used as a <see cref="MatchEvaluator" />.
+        /// </remarks>
+        /// <returns>
+        ///   The formatted match.
+        /// </returns>
+        /// <param name="ClueMatch">
+        ///   A <see cref="Match"/> of the inside of a clue.
+        /// </param>
+        public static string FormatClueInner(Match ClueMatch)
+        {
+            var clue = ClueMatch.Value;
+
+            if (!WantEntireClue)
+            {
+                return clue;
+            }
+
+            if (Highlight.WantEntireClue)
+            {
+                clue = Highlight.Style switch
+                {
+                    Highlight.HighlightStyle.OnlyWhite => Markup.Color("Y", clue),
+                    Highlight.HighlightStyle.ColoredKeyWords => Markup.Color("Y", clue),
+                    _
+                        => throw new ArgumentOutOfRangeException(
+                            nameof(Highlight.HighlightStyle),
+                            $"Finder of Ruin: Unexpected highlight style: {Highlight.Style}"
+                        )
+                };
+            }
+
+            if (Uppercasing.WantEntireClue)
+            {
+                clue = ColorUtility.ToUpperExceptFormatting(clue);
+            }
+
+            return clue;
+        }
+
+        private const string KeyWordPattern = @"(?:masterwork)|(?:Ruin)|(?:House Isner)";
+
+        /// <summary>
+        ///   Matches the notable key words.
+        /// </summary>
+        public static readonly Regex KeyWordRegex = new(KeyWordPattern);
+
+        /// <summary>
+        ///   Map of key word to color format.
+        /// </summary>
+        public static readonly ReadOnlyDictionary<string, string> KeyWordColors =
+            new(
+                new Dictionary<string, string>
+                {
+                    { "masterwork", "c" },
+                    { "Ruin", "r" },
+                    { "House Isner", "M" }
+                }
+            );
+
+        /// <summary>
+        ///   Formats the key word matches based on <see cref="Options.Formatting" />.
+        /// </summary>
+        /// <remarks>
+        ///   This function gets used as a <see cref="MatchEvaluator" />.
+        /// </remarks>
+        /// <returns>
+        ///   The formatted match.
+        /// </returns>
+        /// <param name="KeyWordMatch">
+        ///   A <see cref="Match"/> of a key word.
+        /// </param>
+        public static string FormatKeyWords(Match KeyWordMatch)
+        {
+            var keyWord = KeyWordMatch.Value;
+
+            if (!WantKeyWords)
+            {
+                return keyWord;
+            }
+
+            if (Highlight.WantKeyWords)
+            {
+                keyWord = Highlight.Style switch
+                {
+                    Highlight.HighlightStyle.OnlyWhite => Markup.Color("Y", keyWord),
+                    Highlight.HighlightStyle.ColoredKeyWords
+                        => KeyWordColors.TryGetValue(keyWord, out var color)
+                            ? Markup.Color(color, keyWord)
+                            : keyWord,
+                    _
+                        => throw new ArgumentOutOfRangeException(
+                            nameof(Highlight.HighlightStyle),
+                            $"Finder of Ruin: Unexpected highlight style: {Highlight.Style}"
+                        )
+                };
+            }
+
+            if (Uppercasing.WantKeyWords)
+            {
+                keyWord = ColorUtility.ToUpperExceptFormatting(keyWord);
+            }
+
+            return keyWord;
+        }
+
+        ///<summary>Formats an Isner clue.</summary>
+        ///<remarks>For use in <see cref="Patches.LoreFormatterPatch"/>.</remarks>
+        public static string FormatLore(string Lore)
+        {
+            if (!Wanted)
+            {
+                return Lore;
+            }
+
+            if (WantKeyWords)
+            {
+                var keyWordMatcher = new MatchEvaluator(FormatKeyWords);
+                Lore = KeyWordRegex.Replace(Lore, keyWordMatcher);
+            }
+
+            if (WantEntireClue)
+            {
+                var clueMatcher = new MatchEvaluator(FormatClueInner);
+                Lore = ClueInnerRegex.Replace(Lore, clueMatcher);
+            }
+
+            return Lore;
+        }
+    }
+}