| [[ member.name[:28] ]] |
[[ member.armor_class ]] |
- [[ member.perception + 10 ]] |
+ [[ member.perception.modifier + 10 ]] |
[% for class in member.class_list %]
[% if class.spellcasting_ability %] [[ member.spell_save_dc(class) ]], [% endif %]
[% endfor %]
diff --git a/dungeonsheets/forms/party_summary_template.tex b/dungeonsheets/forms/party_summary_template.tex
index fbebc2b..fa25c81 100644
--- a/dungeonsheets/forms/party_summary_template.tex
+++ b/dungeonsheets/forms/party_summary_template.tex
@@ -29,7 +29,7 @@
[% for member in party %]
[[ member.name[:28] ]]
& [[ member.armor_class ]]
- & [[ member.perception + 10 ]]
+ & [[ member.perception.modifier + 10 ]]
& [% for class in member.class_list %]
[% if class.spellcasting_ability %] [[ member.spell_save_dc(class) ]], [% endif %]
[% endfor %]
@@ -57,7 +57,7 @@
[% for member in party %]
[[ member.name[:28] ]]
& [[ member.armor_class ]]
- & [[ member.perception + 10 ]]
+ & [[ member.perception.modifier + 10 ]]
& [% for class in member.class_list %]
[% if class.spellcasting_ability %] [[ member.spell_save_dc(class) ]], [% endif %]
[% endfor %]
diff --git a/dungeonsheets/forms/spell_list_template.html b/dungeonsheets/forms/spell_list_template.html
new file mode 100644
index 0000000..1c9765f
--- /dev/null
+++ b/dungeonsheets/forms/spell_list_template.html
@@ -0,0 +1 @@
+Spell List
diff --git a/dungeonsheets/make_sheets.py b/dungeonsheets/make_sheets.py
index 040a0ec..f5d1308 100755
--- a/dungeonsheets/make_sheets.py
+++ b/dungeonsheets/make_sheets.py
@@ -9,7 +9,7 @@ import re
from pathlib import Path
from multiprocessing import Pool, cpu_count
from itertools import product
-from typing import Union, Sequence, Optional
+from typing import Union, Sequence, Optional, Literal, List
from dungeonsheets import (
character as _char,
@@ -70,6 +70,9 @@ class CharacterRenderer():
return template.render(character=character,
use_dnd_decorations=use_dnd_decorations, ordinals=ORDINALS)
+create_character_sheet_content = CharacterRenderer("character_sheet_template.{suffix}")
+create_spell_list_content = CharacterRenderer("spell_list_template.{suffix}")
+create_background_content = CharacterRenderer("background_template.{suffix}")
create_subclasses_content = CharacterRenderer("subclasses_template.{suffix}")
create_features_content = CharacterRenderer("features_template.{suffix}")
@@ -192,7 +195,7 @@ def make_gm_sheet(
gm_file = Path(gm_file)
basename = gm_file.stem
gm_props = readers.read_sheet_file(gm_file)
- session_title = gm_props.get("session_title", f"GM Notes: {basename}")
+ session_title = gm_props.pop("session_title", f"GM Notes: {basename}")
# Create the intro tex
content_suffix = format_suffixes[output_format]
content = [
@@ -295,6 +298,96 @@ def make_gm_sheet(
)
+def make_character_content(
+ character: Character,
+ content_format: Literal["tex", "html"],
+ fancy_decorations: bool = False,) -> List[str]:
+ """Prepare the inner content for a character sheet.
+
+ This will produce a fully renderable document, suitable for
+ passing to routines in either the ``epub`` or ``latex``
+ modules. If *content_format* is ``"html"``, the returned content
+ is just the portion that would be found inside the
+ ```` tag.
+
+ If *content_format* is ``"tex"``, the content returned will not
+ include the character, spell list, or biography sheets, since
+ these are currently processed through fillable PDFs.
+
+ Parameters
+ ----------
+ character
+ The character to render content for.
+ content_format
+ Which markup syntax to use.
+ fancy_decorations
+ Use fancy page layout and decorations for extra sheets, namely
+ the dnd style file for *tex*, or extended CSS for *html*.
+
+ Returns
+ -------
+ content
+ The list of rendered character sheet contents for *character* in
+ markup format *content_format*.
+
+ """
+ # Preamble, empty for HTML
+ content = [
+ jinja_env.get_template(f"preamble.{content_format}").render(
+ use_dnd_decorations=fancy_decorations,
+ title="Features, Magical Items and Spells",
+ )
+ ]
+ # Make the character sheet, and background pages if producing HTML
+ if content_format != "tex":
+ content.append(create_character_sheet_content(character,
+ content_suffix=content_format,
+ use_dnd_decorations=fancy_decorations))
+ content.append(create_spell_list_content(character,
+ content_suffix=content_format,
+ use_dnd_decorations=fancy_decorations)
+ )
+ content.append(create_background_content(character,
+ content_suffix=content_format,
+ use_dnd_decorations=fancy_decorations)
+ )
+ # Create a list of subcasses, features, spells, etc
+ if character.subclasses:
+ content.append(create_subclasses_content(character,
+ content_suffix=content_format,
+ use_dnd_decorations=fancy_decorations)
+ )
+ if character.features:
+ content.append(
+ create_features_content(character, content_suffix=content_format, use_dnd_decorations=fancy_decorations)
+ )
+ if character.magic_items:
+ content.append(
+ create_magic_items_content(character, content_suffix=content_format, use_dnd_decorations=fancy_decorations)
+ )
+ if character.is_spellcaster:
+ content.append(
+ create_spellbook_content(character, content_suffix=content_format, use_dnd_decorations=fancy_decorations)
+ )
+ if len(getattr(character, "infusions", [])) > 0:
+ content.append(
+ create_infusions_content(character, content_suffix=content_format, use_dnd_decorations=fancy_decorations)
+ )
+
+ # Create a list of Druid wild_shapes
+ if len(getattr(character, "all_wild_shapes", [])) > 0:
+ content.append(
+ create_druid_shapes_content(character, content_suffix=content_format, use_dnd_decorations=fancy_decorations)
+ )
+ # Postamble, empty for HTML
+ content.append(
+ jinja_env.get_template(f"postamble.{content_format}").render(
+ use_dnd_decorations=fancy_decorations
+ )
+ )
+ return content
+
+
def make_character_sheet(
char_file: Union[str, Path],
character: Optional[Character] = None,
@@ -336,12 +429,6 @@ def make_character_sheet(
pages = []
# Prepare the tex/html content
content_suffix = format_suffixes[output_format]
- content = [
- jinja_env.get_template(f"preamble.{content_suffix}").render(
- use_dnd_decorations=fancy_decorations,
- title="Features, Magical Items and Spells",
- )
- ]
# Start of PDF gen
char_pdf = create_character_pdf_template(
character=character, basename=char_base, flatten=flatten
@@ -360,43 +447,10 @@ def make_character_sheet(
sheets.append(spell_base + ".pdf")
# end of PDF gen
features_base = "{:s}_features".format(basename)
- # Create a list of subcasses
- if character.subclasses:
- content.append( create_subclasses_content(character,
- content_suffix=content_suffix,
- use_dnd_decorations=fancy_decorations) )
# Create a list of features and magic items
- if character.features:
- content.append(
- create_features_content(character, content_suffix=content_suffix, use_dnd_decorations=fancy_decorations)
- )
- if character.magic_items:
- content.append(
- create_magic_items_content(character, content_suffix=content_suffix, use_dnd_decorations=fancy_decorations)
- )
- # Create a list of spells
- if character.is_spellcaster:
- content.append(
- create_spellbook_content(character, content_suffix=content_suffix, use_dnd_decorations=fancy_decorations)
- )
-
- # Create a list of Artificer infusions
- if getattr(character, "infusions", []):
- content.append(
- create_infusions_content(character, content_suffix=content_suffix, use_dnd_decorations=fancy_decorations)
- )
-
- # Create a list of Druid wild_shapes
- if getattr(character, "wild_shapes", []):
- content.append(
- create_druid_shapes_content(character, content_suffix=content_suffix, use_dnd_decorations=fancy_decorations)
- )
-
- content.append(
- jinja_env.get_template(f"postamble.{content_suffix}").render(
- use_dnd_decorations=fancy_decorations
- )
- )
+ content = make_character_content(character=character,
+ content_format=content_suffix,
+ fancy_decorations=fancy_decorations)
# Typeset combined LaTeX file
if output_format == "pdf":
try:
diff --git a/dungeonsheets/stats.py b/dungeonsheets/stats.py
index 465e9b5..442f410 100644
--- a/dungeonsheets/stats.py
+++ b/dungeonsheets/stats.py
@@ -17,7 +17,7 @@ from dungeonsheets.features import (
NaturalExplorerRevised,
QuickDraw,
RakishAudacity,
- RemarkableAthelete,
+ RemarkableAthlete,
SeaSoul,
SoulOfTheForge,
SuperiorMobility,
@@ -35,7 +35,11 @@ def mod_str(modifier):
return "{:+d}".format(modifier)
-AbilityScore = namedtuple("AbilityScore", ("value", "modifier", "saving_throw"))
+def ability_mod_str(character, ability):
+ return mod_str(getattr(character, ability).modifier)
+
+
+AbilityScore = namedtuple("AbilityScore", ("value", "modifier", "saving_throw", "name"))
class Ability:
@@ -68,7 +72,7 @@ class Ability:
if is_proficient:
saving_throw += entity.proficiency_bonus
# Create the named tuple
- value = AbilityScore(modifier=modifier, value=score, saving_throw=saving_throw)
+ value = AbilityScore(modifier=modifier, value=score, saving_throw=saving_throw, name=self.ability_name)
return value
def __set__(self, entity, val):
@@ -78,38 +82,98 @@ class Ability:
class Skill:
- """An ability-based skill, such as athletics."""
+ """An ability-based skill, such as athletics.
+ Attributes
+ ----------
+ ability_name:
+ The name of the ability, as a python-compatible string.
+ skill_name:
+ The name of the base ability that determines the skill
+ modifier.
+ is_proficient
+ Bool that describes if the owner is proficient in this skill.
+ is_expertise
+ Bool that describes if the owner has expertise in this skill.
+ is_jack_of_all_trades
+ Bool that describes if this skill benefits from Jack of All
+ Trades feature (False if already proficient).
+ is_remarkable_athlete
+ Bool that describes if this skill benefits from Remarkable
+ Athlete feature (False if already proficient).
+ modifier
+ The base ability modifier, after relevant proficiency bonuses
+ have been applied.
+ proficiency_modifier
+ The bonus that is applied to the base ability. Usually the same
+ as the owner's proficiency bonus if ``is_proficient`` is True,
+ but can be different based on class features.,
+
+ """
+
+ ability_name = ""
+ skill_name = ""
+ entity = None
+
def __init__(self, ability):
self.ability_name = ability
- def __set_name__(self, entity, name):
+ def __set_name__(self, owner, name):
self.skill_name = name.lower().replace("_", " ")
- self.character = entity
def __get__(self, entity, owner):
- log.debug("Getting skill '%s' for '%s'", self.skill_name, entity.name)
- ability = getattr(entity, self.ability_name)
- modifier = ability.modifier
- # Check for proficiency
- proficiencies = [p.replace("_", " ") for p in entity.skill_proficiencies]
- is_proficient = self.skill_name in proficiencies
- log.debug(
- "%s is proficient in %s: %s", entity.name, self.skill_name, is_proficient
- )
- if is_proficient:
- modifier += entity.proficiency_bonus
- elif entity.has_feature(JackOfAllTrades):
- modifier += entity.proficiency_bonus // 2
- elif entity.has_feature(RemarkableAthelete):
- if self.ability_name.lower() in ("strength", "dexterity", "constitution"):
- modifier += ceil(entity.proficiency_bonus / 2.0)
+ self.entity = entity
+ return self
+ def __str__(self):
+ return self.skill_name.title()
+
+ @property
+ def is_remarkable_athlete(self):
+ already_proficient = (self.is_proficient or self.is_expertise)
+ if self.entity.has_feature(RemarkableAthlete) and not already_proficient:
+ return True
+ else:
+ return False
+
+ @property
+ def is_jack_of_all_trades(self):
+ already_proficient = (self.is_proficient or self.is_expertise or self.is_remarkable_athlete)
+ if self.entity.has_feature(JackOfAllTrades) and not already_proficient:
+ return True
+ else:
+ return False
+
+ @property
+ def is_proficient(self):
+ # Check for proficiency
+ proficiencies = [p.replace("_", " ") for p in self.entity.skill_proficiencies]
+ is_proficient = self.skill_name in proficiencies
+ return is_proficient
+
+ @property
+ def is_expertise(self):
+ return self.skill_name in self.entity.skill_expertise
+
+ @property
+ def proficiency_modifier(self):
+ modifier = 0
+ if self.is_proficient:
+ modifier += self.entity.proficiency_bonus
+ if self.is_remarkable_athlete:
+ modifier += ceil(self.entity.proficiency_bonus / 2.0)
+ if self.is_jack_of_all_trades:
+ modifier += self.entity.proficiency_bonus // 2
# Check for expertise
- is_expert = self.skill_name in entity.skill_expertise
- if is_expert:
- modifier += entity.proficiency_bonus
- log.info("'%s' modifier for '%s': %d", self.skill_name, entity.name, modifier)
+ if self.is_expertise:
+ modifier += self.entity.proficiency_bonus
+ return modifier
+
+ @property
+ def modifier(self):
+ ability = getattr(self.entity, self.ability_name)
+ modifier = ability.modifier + self.proficiency_modifier
+ log.info("%s modifier for '%s': %d", self, self.entity.name, modifier)
return modifier
diff --git a/tests/test_make_sheets.py b/tests/test_make_sheets.py
index 800f727..73ff1ca 100644
--- a/tests/test_make_sheets.py
+++ b/tests/test_make_sheets.py
@@ -56,11 +56,40 @@ class EpubOutputTestCase(unittest.TestCase):
gm_epub = Path(f"{GMFILE.stem}.epub").resolve()
char_epub = Path(f"{CHARFILE.stem}.epub").resolve()
+ def new_character(self):
+ char = character.Character(
+ name="Dr. Who",
+ classes=["Monk", "Druid", "Artificer"],
+ levels=[1, 1, 1],
+ subclasses=["way of the open hand", None, None],
+ magic_items=["cloak of protection"],
+ spells=["invisibility"],
+ wild_shapes=["crocodile"],
+ infusions=["boots of the winding path"]
+ )
+ return char
+
def tearDown(self):
for f in [self.gm_epub, self.char_epub]:
if f.exists():
f.unlink()
+ def test_character_html_content(self):
+ my_char = self.new_character()
+ html = make_sheets.make_character_content(character=my_char,
+ content_format="html")
+ html = "".join(html)
+ # Make sure the various sections get rendered
+ self.assertIn("Subclasses", html)
+ self.assertIn("Features", html)
+ self.assertIn("Magic Items", html)
+ self.assertIn("Spells", html)
+ self.assertIn("Infusions", html)
+ self.assertIn("Known Beasts", html)
+ # Check the character sheet
+ self.assertIn("Character Sheet", html)
+ self.assertIn("Dr. Who", html)
+
def test_gm_file_created(self):
# Check that a file is created once the function is run
make_sheets.make_gm_sheet(gm_file=GMFILE, output_format="epub")
diff --git a/tests/test_stats.py b/tests/test_stats.py
index a99d632..7ecfe61 100644
--- a/tests/test_stats.py
+++ b/tests/test_stats.py
@@ -77,10 +77,14 @@ class TestStats(TestCase):
proficiency_bonus = 2
my_class = MyClass()
- self.assertEqual(my_class.acrobatics, 2)
+ self.assertEqual(str(my_class.acrobatics), "Acrobatics")
+ self.assertEqual(my_class.acrobatics.modifier, 2)
+ self.assertEqual(str(my_class.sleight_of_hand), "Sleight Of Hand")
# Check for a proficiency
my_class.skill_proficiencies = ["acrobatics"]
- self.assertEqual(my_class.acrobatics, 4)
+ self.assertTrue(my_class.acrobatics.is_proficient)
+ self.assertEqual(my_class.acrobatics.proficiency_modifier, 2)
+ self.assertEqual(my_class.acrobatics.modifier, 4)
# Check for a proficiency with spaces in the name
my_class.skill_proficiencies = ["sleight_of_hand"]
- self.assertEqual(my_class.sleight_of_hand, 4)
+ self.assertEqual(my_class.sleight_of_hand.modifier, 4)
|