asciidoctor-p2e 0.1.1 → 0.3.0

data/README.adoc

@@ -1,121 +1,375 @@
 = asciidoctor-p2e
+:toc: left
 
-You can find the git repo for this project on SourceHut:
-https://git.sr.ht/~bosco/asciidoctor-p2e.
+== Welcome Adventurer!
 
-This https://docs.asciidoctor.org/asciidoctor/latest/extensions/[extension] for
-https://asciidoctor.org/[Asciidoctor] is designed to make it easier to create
-content to work with the https://paizo.com/pathfinder[Pathfinder Second Edition
-roleplaying system]. Currently it only supports NPC/Creature stat blocks.
+Greetings weary traveller! I trust your journey was safe albeit long. Whether
+from the storm-tossed seas of _Word_ or the raging wastelands of _Google Docs_,
+you have finally made your way to the golden shore of
+https://asciidoctor.org/[Asciidoctor]! asciidoctor-p2e is an
+https://docs.asciidoctor.org/asciidoctor/latest/extensions/[extension] for
+AsciiDoctor that makes it easier to create stylized content for the
+https://paizo.com/pathfinder[Pathfinder Second Edition roleplaying system].
+Your years of searching are at an end, for this extension supports creature
+stat blocks, item stat blocks, hazard stat blocks, a stylized Table of
+Contents, decorated Sidebars, and Pathfinder-style headers. All of which will
+be demonstrated in cloying detail!
+
+You can find the git repo for this project in the mystical realm of SourceHut:
+https://git.sr.ht/~bosco/asciidoctor-p2e, a fantastic forge of free software
+also known to the old ones as
+https://drewdevault.com/2018/11/15/sr.ht-general-availability.html[Sir Hat].
 
 == Usage
 
-Once the `asciidoctor-p2e` gem is installed you can run
+This extension is archived in the scrolls of
+https://rubygems.org/gems/asciidoctor-p2e[RubyGems] and can be added to your
+inventory with the `gem install asciidoctor-p2e` command. Once the
+`asciidoctor-p2e` gem is installed you can run
 `asciidoctor -r asciidoctor-p2e <input>` to create your output.
 
-== Stat Blocks
+NOTE: Images and assets will be installed/referenced in a `p2e` directory
+wherever your output is created.
+
+== Style
+
+Zero level headers will use a yellow outline Eczar font and first level headers
+will use the Eczar font. This styling is from the
+https://www.gmbinder.com/share/-LxQNtitjvBT2eCVkPt1[GM Binder Pathfinder 2nd
+Edition Homebrew Template]. Fonts are included with `asciidoctor-p2e` and will
+be installed in the `p2e` directory when your output is created. The body of
+the document uses a parchment background.
+
+As you can see on the left, if the Table of Contents is used (`:toc: left`) a
+burnt parchment edge will be show with Pathfinder style header fonts for each
+section.
+
+== Enemies
 
-A new block of type `stat` can be used to create a stat block from
-https://toml.io/en/[TOML input]. For example the following TOML:
+A block of type `stat` can be used to create a creature stat block from
+https://toml.io/en/[TOML input]. For example:
 
 [source, asciidoc]
 ----
-[stat]
+[stat.center, type=creature]
 --
-name = "Dragon Cultist"
+name = "Hoo Man"
 level = "1"
-tags = ["ne","medium","humaniod"]
-perception = "+4"
-senses = "low-light vision"
-skills = ["Athletics +6","Intimidation +2","Survival +4"]
+tags = ["ce","tiny"]
+perception = "+1"
+senses = "scent"
+skills = ["Intimidation +2", "Thievery +1"]
 
 [attributes]
-cha = "-1"
-con = "+2"
-dex = "+1"
+cha = "-2"
+con = "+1"
+dex = "+2"
 int = "-2"
-str = "+3"
-wis = "+1"
+str = "-1"
+wis = "-1"
 
 [defense]
-ac = "16"
-fort = "+7"
+ac = "10"
+fort = "+2"
 ref = "+6"
-will = "+4"
-hp = "20"
+will = "+1"
+hp = "10"
 immunities = ""
 reactions = ["Attack of Opportunity"]
 
 [offense]
 speed = "25"
-otherSpeeds = ""
+otherSpeeds = "Climb Speed 25"
 
 [[offense.attacks]]
 actions = 1
-damage = "1d10+3 slashing"
+damage = "1d4 piercing"
 name = "Melee"
-text = "claws +8"
+text = "teeth +4"
 
 [[offense.attacks]]
 actions = 2
-name = "Special"
+name = "Helicopter Dance"
 text = """\
-  (fire) The dragon cultist breathes flames in a 15-foot cone that deals 2d6 \
-  fire damage to each creature within the area (DC 14 basic Reflex save). \
-  The dragon cultist can't use Breath Weapon again for 1d4 rounds.\
+  Hoo Man dazzles anyone watching with a unique dance causing anyone who \
+  fails a Will save (DC 15) to become fascinated.\
   """
 --
 ----
 
-Will create the following output:
+Notice that a role can be passed: in this case 'center'. If the block is floated
+(left right) a 20px margin will be set on the opposite side.  If a type is not
+specified, 'creature' is assumed.  The above listing creates the following stat
+block:
 
-[stat]
+[stat.center, type=creature]
 --
-name = "Dragon Cultist"
+name = "Hoo Man"
 level = "1"
-tags = ["ne","medium","humaniod"]
-perception = "+4"
-senses = "low-light vision"
-skills = ["Athletics +6","Intimidation +2","Survival +4"]
+tags = ["ce","tiny"]
+perception = "+1"
+senses = "scent"
+skills = ["Intimidation +2", "Thievery +1"]
 
 [attributes]
-cha = "-1"
-con = "+2"
-dex = "+1"
+cha = "-2"
+con = "+1"
+dex = "+2"
 int = "-2"
-str = "+3"
-wis = "+1"
+str = "-1"
+wis = "-1"
 
 [defense]
-ac = "16"
-fort = "+7"
+ac = "10"
+fort = "+2"
 ref = "+6"
-will = "+4"
-hp = "20"
+will = "+1"
+hp = "10"
 immunities = ""
 reactions = ["Attack of Opportunity"]
 
 [offense]
 speed = "25"
-otherSpeeds = ""
+otherSpeeds = "Climb Speed 25"
 
 [[offense.attacks]]
 actions = 1
-damage = "1d10+3 slashing"
+damage = "1d4 piercing"
 name = "Melee"
-text = "claws +8"
+text = "teeth +4"
 
 [[offense.attacks]]
 actions = 2
-name = "Special"
+name = "Helicopter Dance"
 text = """\
-  (fire) The dragon cultist breathes flames in a 15-foot cone that deals 2d6 \
-  fire damage to each creature within the area (DC 14 basic Reflex save). \
-  The dragon cultist can't use Breath Weapon again for 1d4 rounds.\
+  Hoo Man dazzles anyone watching with a unique dance causing anyone who \
+  fails a Will save (DC 15) to become fascinated.\
+  """
+--
+
+== Treasure
+
+In a similar fashion to creature stat blocks, item stat blocks can be created:
+
+[source, asciidoctor]
+----
+[stat.center, type=item]
+--
+name = "Pear of Silence"
+level = "6+"
+tags = ["uncommon"]
+price = "100 gp" # optional
+usage = "held in 1 hand"
+bulk = "L"
+description = """\
+  A cruel device famed to be designed by Roderick the Malevolent. A seemingly \
+  delicious fruit, when placed in someone's mouth it expands to render them \
+  unable to speak. A magical phrase that disables the effect is bound to the \
+  fruit at the time of creation (not that the victim would be able to utter \
+  it).\
+  """
+
+[hardness] # optional
+hardness = "9"
+hp = "10"
+bp = "5"
+
+[[activations]] # optional
+actions = 1
+actionText = "Interact" # optional
+trigger = "The pear is placed inside someone's mouth" # optional
+# effect is optional too
+effect = """\
+  The pear rapidly expands, filling the victims mouth and rendering them \
+  unable to speak until the pear is destroyed or disabled.\
+  """
+
+[[activations]]
+actions = 2
+actionText = "Interact"
+trigger = """\
+  The magic phrase that disables the pear is spoken loudly at a distance of \
+  less than five feet from the pear.\
+  """
+effect = """\
+  The pear resumes its normal shape and form. It can be spit out by the \
+  victim.\
+  """
+
+[[types]] #optional
+type = "lesser"
+level = "6"
+price = "100 gp" # optional
+description = """\
+  Can be destroyed by the victim with a DC 20 Fortitude saving throw.\
+  """
+
+[[types]]
+type = "greater"
+level = "10"
+price = "200 gp"
+description = """\
+  Can be destroyed by the victim with a DC 25 Fortitude saving throw.\
+  """
+
+[[types]]
+type = "major"
+level = "12"
+price = "300 gp"
+description = """\
+  Can be destroyed by the victim with a DC 30 Fortitude saving throw.\
+  """
+--
+----
+
+The above block yields:
+
+[stat.center, type=item]
+--
+name = "Pear of Silence"
+level = "6+"
+tags = ["uncommon"]
+price = "100 gp" # optional
+usage = "held in 1 hand"
+bulk = "L"
+description = """\
+  A cruel device famed to be designed by Roderick the Malevolent. A seemingly \
+  delicious fruit, when placed in someone's mouth it expands to render them \
+  unable to speak. A magical phrase that disables the effect is bound to the \
+  fruit at the time of creation (not that the victim would be able to utter \
+  it).\
+  """
+
+[hardness] # optional
+hardness = "9"
+hp = "10"
+bp = "5"
+
+[[activations]] # optional
+actions = 1
+actionText = "Interact" # optional
+trigger = "The pear is placed inside someone's mouth" # optional
+# effect is optional too
+effect = """\
+  The pear rapidly expands, filling the victims mouth and rendering them \
+  unable to speak until the pear is destroyed or disabled.\
+  """
+
+[[activations]]
+actions = 2
+actionText = "Interact"
+trigger = """\
+  The magic phrase that disables the pear is spoken loudly at a distance of \
+  less than five feet from the pear.\
+  """
+effect = """\
+  The pear resumes its normal shape and form. It can be spit out by the \
+  victim.\
+  """
+
+[[types]] #optional
+type = "lesser"
+level = "6"
+price = "100 gp" # optional
+description = """\
+  Can be destroyed by the victim with a DC 20 Fortitude saving throw.\
+  """
+
+[[types]]
+type = "greater"
+level = "10"
+price = "200 gp"
+description = """\
+  Can be destroyed by the victim with a DC 25 Fortitude saving throw.\
+  """
+
+[[types]]
+type = "major"
+level = "12"
+price = "300 gp"
+description = """\
+  Can be destroyed by the victim with a DC 30 Fortitude saving throw.\
   """
 --
 
-== Credits
+== Traps
+
+Hazard stat blocks can also be created:
+
+[source, asciidoctor]
+----
+[stat.center, type=hazard]
+====
+name = "Bed Spike"
+level = "1"
+tags = ["mechanical", "trap"]
+stealth = "DC 15 (or 0 if they look under the bed)"
+description = """\
+  The support ropes for a bed are cut almost completely through. Under the bed \
+  are several sharpened wooded spikes. Typically the sheets are hung over the \
+  edge of the bed to disguise the spikes.\
+  """
+disable = """\
+  Crafting DC 10 to remove the spikes. The bed will still not support weight \
+  but there will be no damage caused by falling through.\
+  """
+
+[[triggers]]
+name = "Fall Through"
+text = """\
+  A creature lays on the bed, causing the ropes to snap and dealing 1D6 piercing
+  damage.\
+  """
+====
+----
+
+The above block yields:
+
+[stat.center, type=hazard]
+====
+name = "Bed Spike"
+level = "1"
+tags = ["mechanical", "trap"]
+stealth = "DC 15 (or 0 if they look under the bed)"
+description = """\
+  The support ropes for a bed are cut almost completely through. Under the bed \
+  are several sharpened wooded spikes. Typically the sheets are hung over the \
+  edge of the bed to disguise the spikes.\
+  """
+disable = """\
+  Crafting DC 10 to remove the spikes. The bed will still not support weight \
+  but there will be no damage caused by falling through.\
+  """
+
+[[triggers]]
+name = "Fall Through"
+text = """\
+  A creature lays on the bed, causing the ropes to snap and dealing 1D6 piercing
+  damage.\
+  """
+====
+
+== Cryptic Texts
+
+When a sidebar is used to display information the background will use a styling
+from https://pf2.easytool.es/[Pathfinder 2 easy Library].
+
+Sidebars can especially effective for notes from Wizards with specific details
+regarding the functioning of dangerous items:
+
+.Wizard's Note
+****
+To Whom it May Concern,
+
+Reading this note will curse you for all time with a constant stone in your
+shoe. No take backs!
+
+Sincerely,
+
+Roderick the Malevolent
+****
+
+== Adventurer's Log
 
 * The layout, much of the styling, and the demonstration creature come from the
   https://slanguage.github.io/pf2monster/[Pathfinder 2E Monster Creator]
@@ -123,3 +377,7 @@ text = """\
   https://www.reddit.com/r/WorldAnvil/comments/kdzog2/css_for_pathfinder_2nd_edition/[CSS for Pathfinder 2nd Edition]
 * https://github.com/asciidoctor/asciidoctor-extensions-lab[Asciidoctor Extensions Lab]
   was used as a reference in creating this extension.
+* https://www.gmbinder.com/share/-LxQNtitjvBT2eCVkPt1[GM Binder Pathfinder 2nd
+  Edition Homebrew Template] was used for fonts and further styling.
+* The https://pf2.easytool.es/[Pathfinder 2 easy Library] was used for the
+  Sidebar styling

data/Rakefile

@@ -0,0 +1,37 @@
+require 'asciidoctor'
+require './lib/asciidoctor-p2e.rb'
+require 'dotenv/load'
+require 'rubygems'
+
+bearer = ENV['BEARER']
+docdir = 'docs'
+
+desc 'Build gem'
+task :gem_build do
+  sh "gem build asciidoctor-p2e.gemspec"
+end
+
+desc 'Pushes gem to RubyGems.org'
+task :gem_push do
+  spec = Gem::Specification::load('asciidoctor-p2e.gemspec')
+  sh "gem push asciidoctor-p2e-#{spec.version}.gem"
+end
+
+desc 'Builds documentation using the local (non-installed) extension'
+task :doc_build do
+  rm_rf docdir
+  Asciidoctor.convert_file(
+    'README.adoc',
+    to_file: 'asciidoctor-p2e.html',
+    to_dir: docdir,
+    mkdirs: true,
+    safe: :unsafe,
+  )
+end
+
+desc 'Deploys documentation to SourceHut site'
+task :doc_deploy do
+  sh 'tar cvzf site.tar.gz -C docs asciidoctor-p2e.html p2e'
+  sh "curl -H 'Authorization: Bearer #{bearer}' -Fcontent=@site.tar.gz https://pages.sr.ht/publish/bosco.srht.site"
+  rm 'site.tar.gz'
+end