Spelling/wrapping

Author: CBroz1

.cspell.json

@@ -5,7 +5,9 @@
     // language - current active spelling language
     "language": "en",
     "enabledLanguageIds": [
-        "markdown", "yaml", "python"
+        "markdown",
+        "yaml",
+        "python"
     ],
     "dictionaries": [
         "en",
@@ -16,50 +18,86 @@
         "python-common",
         "latex",
         "public-licenses",
-        "softwareTerm",
-        "custom-dictionary"
+        "softwareTerm"
     ],
     // words - list of words to be always considered correct
     "words": [
+        "addoption",
+        "addopts",
         "Attribs",
         "Battlecharged",
         "codemirror",
+        "compatiblelicenses",
+        "creativecommons",
+        "datadir",
         "delim",
         "Descrip",
+        "docstrings",
+        "dofa",
+        "dotenv",
+        "Edtech",
         "Erdania",
         "excepthook",
+        "fontawesome",
+        "Gameplay",
+        "ipykernel",
+        "ipynb",
         "isort",
+        "jupyterlab",
+        "jupytext",
         "kernelspec",
         "levelname",
         "manip",
         "markdownlint",
+        "minversion",
+        "mkdocs",
+        "mkdocstrings",
+        "mult",
         "nbconvert",
         "nbformat",
+        "noopener",
+        "posthog",
         "premade",
         "Premade",
         "premades",
         "Prereq",
         "Prereqs",
+        "purp",
         "pydot",
+        "pytests",
         "reflavoring",
         "remixable",
+        "respec",
         "roleplay",
         "Roleplay",
         "ruleset",
         "Scrying",
         "Shortbow",
         "Shortsword",
+        "sidenav",
+        "sublicensable",
+        "testpaths",
+        "Thadius",
+        "THEGAME",
+        "townsperson",
         "TTRPG",
         "TTRPGs",
         "Vuln",
         "Vulny",
         "Vulnys",
-        "workshopped"
+        "waivable",
+        "workshopped",
+        "Xena",
+        "yamls"
     ],
     // flagWords - list of words to be always considered incorrect
     // This is useful for offensive words and common spelling errors.
-    // For example "hte" should be "the"
-    "flagWords": [
-        "hte"
-    ]
+    "flagWords": [],
+    "ignorePaths": [
+        "**/docs/site",
+        ".git",
+        "automation.egg-info",
+        "__pycache__"
+    ],
+    "enabled": true
 }

LICENSE

@@ -70,7 +70,6 @@ Licensor grants You such rights in consideration of benefits the
 Licensor receives from making the Licensed Material available under
 these terms and conditions.
 
-
 Section 1 -- Definitions.
 
   a. Adapted Material means material subject to Copyright and Similar
@@ -150,7 +149,6 @@ Section 1 -- Definitions.
   n. You means the individual or entity exercising the Licensed Rights
      under this Public License. Your has a corresponding meaning.
 
-
 Section 2 -- Scope.
 
   a. License grant.
@@ -236,7 +234,6 @@ Section 2 -- Scope.
           the Licensed Material is used other than for NonCommercial
           purposes.
 
-
 Section 3 -- License Conditions.
 
 Your exercise of the Licensed Rights is expressly made subject to the
@@ -302,7 +299,6 @@ following conditions.
           Measures to, Adapted Material that restrict exercise of the
           rights granted under the Adapter's License You apply.
 
-
 Section 4 -- Sui Generis Database Rights.
 
 Where the Licensed Rights include Sui Generis Database Rights that
@@ -326,7 +322,6 @@ For the avoidance of doubt, this Section 4 supplements and does not
 replace Your obligations under this Public License where the Licensed
 Rights include other Copyright and Similar Rights.
 
-
 Section 5 -- Disclaimer of Warranties and Limitation of Liability.
 
   a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
@@ -355,7 +350,6 @@ Section 5 -- Disclaimer of Warranties and Limitation of Liability.
      possible, most closely approximates an absolute disclaimer and
      waiver of all liability.
 
-
 Section 6 -- Term and Termination.
 
   a. This Public License applies for the term of the Copyright and
@@ -384,7 +378,6 @@ Section 6 -- Term and Termination.
   d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
      License.
 
-
 Section 7 -- Other Terms and Conditions.
 
   a. The Licensor shall not be bound by any additional or different
@@ -394,7 +387,6 @@ Section 7 -- Other Terms and Conditions.
      Licensed Material not stated herein are separate from and
      independent of the terms and conditions of this Public License.
 
-
 Section 8 -- Interpretation.
 
   a. For the avoidance of doubt, this Public License does not, and

README.md

@@ -26,7 +26,7 @@ about how to play.
 3. **Running Code**. The `environment.yaml` file specifies a
    [Conda](https://docs.conda.io/en/latest/) environment that will allow you to run all
    code and generate documentation. `mkdocs` will allow you to see what the docs site
-   looks like before commiting by visiting `localhost:8000`
+   looks like before committing by visiting `localhost:8000`
 
 ```console
 conda env create -f environment.yaml # Generate conda environment
@@ -49,7 +49,7 @@ The following VS Code extensions have been used to support development...
     - [GitHub](https://github.com/stkb/Rewrap/)
 3. CSpell: Allows custom dictionaries on spell-check.
     - [Extension](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
-    - [GithHub](https://github.com/streetsidesoftware/vscode-spell-checker)
+    - [GitHub](https://github.com/streetsidesoftware/vscode-spell-checker)
     - Config: `.cspell.json`
 4. Black Formatter: Supports code uniformity.
     - [Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter)

automation/_input/04_Powers_SAMPLE.yaml

@@ -1,3 +1,15 @@
+Inorganic:
+    Category:
+        - Roleplay
+        - Society
+    Description: You were not born, but instead created. You are not a slave to the bodily needs of the rest, but may instead be called to a prescribed purpose.
+    Mechanic:
+        - You do not need to breathe, eat or sleep (but still rest to recover Health/Power Points). Choose one of the following when you take this Vulnerability
+        - Your creator or society at large consider you to have a function that you do not wish to pursue, such as a dangerous and laborious profession.
+        - You require a rare form of fuel that is difficult to obtain and are rendered catatonic without regular access. Work with your GM to see what makes sense for your character in the setting.
+    Type: Vulny
+    XP: -2
+
 Destructive Beam:
   Type: Major
   Category: Magic

automation/simulator/deck.py

@@ -1,7 +1,6 @@
-# Intial draft adapted from https://github.com/wynand1004/Projects by @TokyoEdtech
+# Initial draft adapted from https://github.com/wynand1004/Projects by @TokyoEdtech
 
 import random
-from typing import Union
 
 from ..utils import logger
 
@@ -19,6 +18,8 @@ class Card(object):
     Attributes:
         suit (str): one of [D,C,H,S,R,B] for Diamond, Club, Heart, Spade, Red, Black
         val (str): one of [A, K, Q, J, T] for Ace to Ten. Or 2 to 9.
+        val_number (int): integer corresponding to above value
+        color (str): either R or B for red or black
     """
 
     def __init__(self, suit, val=" "):
@@ -159,11 +160,15 @@ def __repr__(self):
         output += f"Discards:  {len(self.discards):02d}\n"
         return output
 
-    def shuffle(self, limit=None):
+    def shuffle(self, limit: int = None):
         """Shuffle N from discard to deck
 
-        If limit provided, only shuffle those from discard.
-        If no limit, reshuffle all discarded. Add jokers back to hand.
+        If limit provided, only shuffle those from discard. If no limit, reshuffle all
+        discarded. Add jokers back to hand.
+
+        Args:
+            limit (int, optional): Number of cards to shuffle back into deck. Defaults
+            to None.
         """
         random.shuffle(self.discards)
         if not limit:
@@ -176,15 +181,26 @@ def shuffle(self, limit=None):
             self.draw_TC()
 
     @property
-    def TC(self):
+    def TC(self) -> Card:
+        """Target card
+
+        Returns:
+            Card: Current Target Card from deck. Not applicable to GM decks.
+        """
         if not self._TC and self._use_TC:
             self.draw_TC
         return self._TC
 
     def draw_TC(self):
+        """Draw a new target card"""
         self._TC = self.draw()
 
-    def draw(self) -> Card:
+    def draw(self) -> Card | None:
+        """Draw a card, if available. Otherwise returns None.
+
+        Returns:
+            Card: _description_
+        """
         """Draw a card. If any available, return card"""
         if len(self.cards) == 0 and self._use_TC:
             logger.warning("No cards available in deck.")
@@ -200,12 +216,21 @@ def draw(self) -> Card:
 
     def check_by_skill(self, **kwargs):
         if self._use_TC:
-            raise TypeError("check_by_skill method envoked on a non-GM deck")
+            raise TypeError("check_by_skill method invoked on a non-GM deck")
         kwargs.pop("skill", None)
         return self.check(**kwargs)
 
-    def discard(self, n, return_string=False, **_):
-        """Draw n cards, return none. Discard/hand as normal"""
+    def discard(self, n: int, return_string=False, **_) -> str | None:
+        """Draw n cards, return none. Discard/hand as normal
+
+        Args:
+            n (int): Number of cards to discard. If "all", uses discards all remaining.
+            return_string (bool, optional): Return a string reflecting result. Defaults
+                to False.
+
+        Returns:
+            str | None: If return_string, report "Drew X"
+        """        """"""
         if n == "all":
             n = len(self.cards)
 
@@ -216,8 +241,11 @@ def discard(self, n, return_string=False, **_):
         if return_string:
             return f"Drew {draws}"
 
-    def exchange_fate(self, return_string=False):
-        """Move fate card from hand. If Ace, add to discard"""
+    def exchange_fate(self, return_string=False) -> str | None:
+        """Move fate card from hand. If Ace, add to discard
+        
+        Args:
+            return_string (bool, optional): Default to False"""
         if len(self.hand) == 0:
             result = "No cards available to exchange"
         else:
@@ -231,7 +259,7 @@ def exchange_fate(self, return_string=False):
 
         logger.info(result)
 
-    def _basic_check(self, TC: Card, DR: int) -> Union[None, int]:
+    def _basic_check(self, TC: Card, DR: int) -> None | int:
         """Return string corresponding to check 'Hit/Miss/Color/Suit' etc
 
         Args:
@@ -268,21 +296,29 @@ def check(
         return_val: bool = False,
         return_string: bool = False,
         verbose=True,
-    ) -> Union[None, int]:
+    ) -> tuple[int, str] | str:
         """Log string corresponding to check 'Hit/Miss/Color/Suit' etc
 
         Args:
             TC (Card): Target card
-            TR: (int): Target Range
+            DR: (int): Target Range
             mod (int): TR modifier
             upper_lower (str): 'upper' or 'lower' Hand ('u' or 'l'). Default neither.
             draw_n (int): How many to draw. If upper/lower, default 2. Otherwise 1.
             upper_lower_int (int): Instead of passing upper_lower and draw_n, use
                 positive/negative for upper/lower with int of draw_n -1.
                 for example, -1 for draw 2 lower
             draw_all (bool): If upper hand, draw all before stopping. Default false.
-            return_val (bool): Return the string. Default False.
+            return_val (bool): Return the integer of the result. Default False.
+            return_string (bool): Return the string describing what happened. Default 
+                False.
+            verbose (bool): Log the result string as a debug item            
+            
+        Returns:
+            tuple | str: If return_string, returns a tuple containing the result as a 
+                string, followed by the result value. If return_val, only integer result.
         """
+        
         DR = max(0, abs(DR) + mod)  # Apply mod to non-negative TR
         if upper_lower_int:
             upper_lower = (

automation/simulator/encounter.py

@@ -156,7 +156,7 @@ def sim_epic_event(
         Args:
             TC: target card. Default draw from gm_deck
             participants: list of those involved on a TC. Default all PCs
-            skill: Type of check for each participant in particpant order. Default 0 mod
+            skill: Type of check for each participant in participant order. Default 0 mod
                 e.g., participants=[PC1, PC2], skill=['STR','Finesse'].
                 If same for all, provide as string
             successes_needed: N suited hits before end. Default 1

automation/simulator/player.py

@@ -182,7 +182,7 @@ def save(self, DR: int = 3, attrib="None", **kwargs):
                 TC=self.TC, DR=DR, mod=getattr(self.Attribs, attrib, 0), **new_kwargs
             )
 
-        # NOTE: drawlog doesn't know if had options
+        # NOTE: draw_log doesn't know if had options
         draw_log.info(
             [
                 self.id,

automation/templates/powers.py

@@ -56,7 +56,7 @@ def __init__(self, input_files="04_Powers_SAMPLE.yaml", limit_types: list = None
         input_files = [
             file
             for file in ensure_list(ambiguous_item=input_files)
-            if "ower" in file.lower() or "vuln" in file.lower()
+            if "power" in file.lower() or "vuln" in file.lower()
         ]
         super().__init__(input_files=input_files)
         self._limit_types = limit_types or list_power_types

automation/templates/yaml_spec.py

@@ -117,7 +117,7 @@ def as_dict(self):
 
     @abstractmethod
     def categories(self) -> dict:
-        """{(heirarchy tuple): [List of names]} dict"""
+        """{(hierarchy tuple): [List of names]} dict"""
         pass
 
     @property