🛠 macros

added macros basically in order to add a reading time to the page. might
use it for other stuff later, but that's what i want it for now.

according to https://thereadtime.com/ the words-per-minute reading rate
for reading out loud is 183. And the average speed for reading silently
is 234 wpm. which is what we use here.

if you ever want to adjust this rate, edit zxWPM in macros

README.md

@@ -49,3 +49,11 @@ syndicated: yes
 ```
 
 [^bool]: These are not true booleans. Pandoc templates cannot evaluate the value of a field. Only its presence. This could say `public: astronauts` or `syndicated: spaghetti`. You can only set these flags on and off by including or omitting the field entirely. This is probably not the way you would expect it to work, so watch out. Incidentally, this is the same way that the stateless templating engine *mustache* works. Pandoc templates bring so little to the table that it might be easier in the future to just use recfiles instead of markdown+yaml, and pipe it through mustache or recfmt.
+
+## macros
+
+you can define macros in `/macros` and then include them in your documents to be expanded while building.
+
+i arbitrarily adopted a "zxMACRONAME" naming convention because an all-caps macro name is *probably* safe, but is even safer with a random `zx` in front of it.
+
+also it gives you good autocompletion if all your macros have the same prefix / namespace.

basement.order

@@ -30,4 +30,5 @@ src/geography.md
 src/cosmology.md
 src/history.md
 src/notes.md
+src/acknowledgements.md
 src/afterword.md

justfile

@@ -4,26 +4,28 @@ default:
 
 # build referee facing html
 spoilers:
-  cat basement.order |\
+  cat basement.order \
-  xargs pandoc -f markdown -t markdown |\
+  | xargs pandoc -f markdown -t markdown \
-  pandoc \
+  | m4 macros - \
+  | pandoc \
     -t html \
     --standalone \
     --toc \
     --metadata title="BASEMENT QUEST" \
     -H includes/styles.html \
-    > www/spoilers.html
+  > /tmp/spoilers.html && cp /tmp/spoilers.html www/spoilers.html
 
 # build player facing html
 public:
-  cat basement.order |\
+  cat basement.order \
-  xargs -I % pandoc -f markdown -t markdown --template=templates/public.tmpl % |\
+  | xargs -I % pandoc -f markdown -t markdown --template=templates/public.tmpl % \
-  pandoc -t html \
+  | m4 macros - \
+  | pandoc -t html \
     --standalone \
     --toc \
     --metadata title="BASEMENT QUEST" \
     -H includes/styles.html \
-    > www/index.html
+  > /tmp/quest.html && cp /tmp/quest.html www/index.html
 
 # build rss
 rss:
@@ -49,7 +51,7 @@ up:
 
 # copy assets
 assets:
-  cp assets/* www/
+  rsync -vup assets/* www/
 
 # build public, spoilers, and rss
 build: spoilers public rss assets

macros

@@ -0,0 +1,5 @@
+changequote(`<!', `!>')dnl
+define(<!zxWPM!>, 234)dnl
+define(<!zxWORDS!>, <!esyscmd(pandoc -t plain www/index.html | wc -w | sed -e 's/ //g' | tr '\n' ' ')!>)dnl
+define(<!zxMINUTES!>, <!esyscmd(expr zxWORDS / zxWPM | tr '\n' ' ')!>)dnl
+changequote()dnl

src/about.md

@@ -6,10 +6,12 @@ public: yes
 ---
 ## About
 
+Total length: zxWORDS words / zxMINUTES minutes
+
 This is a game that me and the kids in the basement are playing over email.
 
 [www thread](https://framalistes.org/sympa/arc/tildepals/2022-07/msg00004.html)
 
-You'll probably be most interested in [jumping straight to the story](#epistolary)
+You can [read from the beginning](#chapter-1), or jump into the [current story arc](#current-story).
 
 If you're not on the mailing list and want to keep up with the story, you can [subscribe to the rss feed](https://tilde.town/~dozens/quest/rss.xml).

src/acknowledgements.md

@@ -0,0 +1,17 @@
+---
+title: acknowledgements
+created: Wed, 05 Oct 2022 19:19:42 -0600
+updated: Wed, 05 Oct 2022 19:19:42 -0600
+---
+## Acknowledgements
+
+The setting, plot, and major non-player characters of Basement Quest are all lifted wholesale from Trinyvale, by Not Another D&D Podcast.
+
+- <https://notanotherdndpodcast.fandom.com/wiki/Category:Trinyvale>
+- <https://www.naddpod.com/>
+
+Paths and Templates are inspired by Caput Caprae and many others.
+
+- <https://caput-caprae.blogspot.com/2020/11/using-templates.html>
+
+And if there's anything else creative or original herein, then it probably came from the feverish minds of my players!

src/characters/corraidhin.md

@@ -18,7 +18,7 @@ I think with my share of the reward I'll buy more books. Lots and lots of books,
 - Player: sinatra
 - XP: 0
 - Skills: Do Anything 1, Arcane Lore 2, Sneak 2
-- Equipment: Sword of Yam'L, Ginnarak Crystal
+- Equipment: Sword of Yam'L, Ginnarak Crystal (Earth)
 
 Paths:
 

src/characters/inky.md

@@ -18,7 +18,7 @@ What do you plan to do with your cut of the money? Buy lots of ink ingredients,
 - Player: mio
 - XP: 1
 - Skills: Do Anything 1, Persuasive 2, Plantomancy 2
-- Equipment: Fine Feathered Quills, Jade Tea Set, Mountain Range Glyph Ink, Bead of the Werehare
+- Equipment: Handy Duffer Discette, Fine Feathered Quills, Jade Tea Set, Mountain Range Glyph Ink, Bead of the Werehare
 
 Paths:
 

src/characters/jarrod.md

@@ -17,7 +17,7 @@ He leans over and places his elbows on the table, tenting his fingers and leanin
 "Other than that, I'm willing to take on cooking chores and spin the occasional tale around a campfire. My cut of the money goes towards opening my own tavern when I retire."
 </details>
 
-- Player: marc
+- Player: marcus
 - XP: 0
 - Skills: Do Anything 1, Oratory 2
 - Equipment: Fascinating Bangle

src/notes.md

@@ -5,37 +5,49 @@ updated: Tue, 26 Jul 2022 20:32:23 -0600
 ---
 ## Spoilers
 
-### names
+<details>
+<summary>SPOILERS!!</summary>
+NAMES AND NPCS
 
-Upcoming NPCs and/or monsters?
+Upcoming NPCs and/or monsters
 
-```
+- zai-ni
-07:10      ~mio | lol okay, we can call it zai-ni for a day
+- zeyeknee
-07:10      ~mio | tiny zeyeknee
+- standard ed
-```
+- three fingered gerald
+- paladin of emacs
+- monks of vim
+- gnu zealots
+- hinderbloke
+- falterchap
 
-Pirates?
 
-### crystals
+CRYSTALS
 
-the five Ginnarak crystals:
+Each crystal has an associated *element*, a *location* appropriate to the element, and an *aspect* of Neddas for the guardian and their minions.
 
-- earth -- cave
-- water -- underwater pirate shipwreck
-- fire -- volcano
-- wind -- cloudstuff
-- heart? ice?
 
-### hodgepodge
+| Element | Location                    | Aspect |
+|---------|-----------------------------|--------|
+| earth   | cave                        | coin   |
+| water   | underwater pirate shipwreck | mirth  |
+| wind    | cloudstuff                  | lore   |
+| void    | spaaaaace                   | craft  |
+| fire    | volcano                     | tact   |
 
-mio's (Inky's) Handy Duffer Discette = HD Diskette = better stay away from magnets!!
+The crystals will eventually lead them to Neddas
 
-The Benefactor is Nullar
+IDEAS
 
-Blavin is a secret agent, working for the Golden Iris, a secret society that wants to 'create balance' by seating a fourth god
+todo:
 
-Nullar got tired of being a god and wanted to die, and Neddas agreed to help him. Shit went bad and turned Liandt to stone, and Nullar's leg to stone.
+- [ ] mio's (Inky's) Handy Duffer Discette = HD Diskette = better stay away from magnets!!
+- [ ] The Benefactor is Nullar
+- [ ] Blavin is a secret agent, working for the Golden Iris, a secret society that wants to 'create balance' by seating a fourth god
+- [ ] Nullar got tired of being a god and wanted to die, and Neddas agreed to help him. Shit went bad and turned Liandt to stone, and Nullar's leg to stone. Now Nullar is trying to gather the Ginnarak crystals to assemble the *God Slayer* to attempt once more to end his own life.
 
-Now Nullar is trying to gather the Ginnarak crystals to assemble the *God Slayer* to attempt once more to end his own life.
+completed:
+
+- [x] The gang has a rival: the gophers of Retrieval Team 70
+</details>
 
-The gang has a rival: the gophers of Retrieval Team 70

www/index.html

@@ -236,13 +236,14 @@ of the Were-Hare</a></li>
 </ul>
 </nav>
 <h2 id="about">About</h2>
+<p>Total length: 15376 words / 65 minutes</p>
 <p>This is a game that me and the kids in the basement are playing over
 email.</p>
 <p><a
 href="https://framalistes.org/sympa/arc/tildepals/2022-07/msg00004.html">www
 thread</a></p>
-<p>You’ll probably be most interested in <a href="#epistolary">jumping
+<p>You can <a href="#chapter-1">read from the beginning</a>, or jump
-straight to the story</a></p>
+into the <a href="#current-story">current story arc</a>.</p>
 <p>If you’re not on the mailing list and want to keep up with the story,
 you can <a href="https://tilde.town/~dozens/quest/rss.xml">subscribe to
 the rss feed</a>.</p>
@@ -273,7 +274,7 @@ story entirely.</p>
 <li>Player: sinatra</li>
 <li>XP: 0</li>
 <li>Skills: Do Anything 1, Arcane Lore 2, Sneak 2</li>
-<li>Equipment: Sword of Yam’L, Ginnarak Crystal</li>
+<li>Equipment: Sword of Yam’L, Ginnarak Crystal (Earth)</li>
 </ul>
 <p>Paths:</p>
 <ul>
@@ -323,8 +324,8 @@ very soon!</p>
 <li>Player: mio</li>
 <li>XP: 1</li>
 <li>Skills: Do Anything 1, Persuasive 2, Plantomancy 2</li>
-<li>Equipment: Fine Feathered Quills, Jade Tea Set, Mountain Range Glyph
+<li>Equipment: Handy Duffer Discette, Fine Feathered Quills, Jade Tea
-Ink, Bead of the Werehare</li>
+Set, Mountain Range Glyph Ink, Bead of the Werehare</li>
 </ul>
 <p>Paths:</p>
 <ul>
@@ -357,7 +358,7 @@ occasional tale around a campfire. My cut of the money goes towards
 opening my own tavern when I retire.”</p>
 </details>
 <ul>
-<li>Player: marc</li>
+<li>Player: marcus</li>
 <li>XP: 0</li>
 <li>Skills: Do Anything 1, Oratory 2</li>
 <li>Equipment: Fascinating Bangle</li>

www/spoilers.html

@@ -232,23 +232,21 @@ of the Were-Hare</a></li>
 <li><a href="#geography" id="toc-geography">Geography</a></li>
 <li><a href="#cosmology" id="toc-cosmology">Cosmology</a></li>
 <li><a href="#history" id="toc-history">History</a></li>
-<li><a href="#spoilers" id="toc-spoilers">Spoilers</a>
+<li><a href="#spoilers" id="toc-spoilers">Spoilers</a></li>
-<ul>
+<li><a href="#acknowledgements"
-<li><a href="#names" id="toc-names">names</a></li>
+id="toc-acknowledgements">Acknowledgements</a></li>
-<li><a href="#crystals" id="toc-crystals">crystals</a></li>
-<li><a href="#hodgepodge" id="toc-hodgepodge">hodgepodge</a></li>
-</ul></li>
 <li><a href="#afterword" id="toc-afterword">Afterword</a></li>
 </ul>
 </nav>
 <h2 id="about">About</h2>
+<p>Total length: 15376 words / 65 minutes</p>
 <p>This is a game that me and the kids in the basement are playing over
 email.</p>
 <p><a
 href="https://framalistes.org/sympa/arc/tildepals/2022-07/msg00004.html">www
 thread</a></p>
-<p>You’ll probably be most interested in <a href="#epistolary">jumping
+<p>You can <a href="#chapter-1">read from the beginning</a>, or jump
-straight to the story</a></p>
+into the <a href="#current-story">current story arc</a>.</p>
 <p>If you’re not on the mailing list and want to keep up with the story,
 you can <a href="https://tilde.town/~dozens/quest/rss.xml">subscribe to
 the rss feed</a>.</p>
@@ -279,7 +277,7 @@ story entirely.</p>
 <li>Player: sinatra</li>
 <li>XP: 0</li>
 <li>Skills: Do Anything 1, Arcane Lore 2, Sneak 2</li>
-<li>Equipment: Sword of Yam’L, Ginnarak Crystal</li>
+<li>Equipment: Sword of Yam’L, Ginnarak Crystal (Earth)</li>
 </ul>
 <p>Paths:</p>
 <ul>
@@ -329,8 +327,8 @@ very soon!</p>
 <li>Player: mio</li>
 <li>XP: 1</li>
 <li>Skills: Do Anything 1, Persuasive 2, Plantomancy 2</li>
-<li>Equipment: Fine Feathered Quills, Jade Tea Set, Mountain Range Glyph
+<li>Equipment: Handy Duffer Discette, Fine Feathered Quills, Jade Tea
-Ink, Bead of the Werehare</li>
+Set, Mountain Range Glyph Ink, Bead of the Werehare</li>
 </ul>
 <p>Paths:</p>
 <ul>
@@ -363,7 +361,7 @@ occasional tale around a campfire. My cut of the money goes towards
 opening my own tavern when I retire.”</p>
 </details>
 <ul>
-<li>Player: marc</li>
+<li>Player: marcus</li>
 <li>XP: 0</li>
 <li>Skills: Do Anything 1, Oratory 2</li>
 <li>Equipment: Fascinating Bangle</li>
@@ -2207,32 +2205,104 @@ Basmentaria.</p>
 <p>They reduced the once fertile lands of Ginnarak to ash and
 embers.</p>
 <h2 id="spoilers">Spoilers</h2>
-<h3 id="names">names</h3>
+<details>
-<p>Upcoming NPCs and/or monsters?</p>
+<summary>
-<pre><code>07:10      ~mio | lol okay, we can call it zai-ni for a day
+<p>SPOILERS!!</p>
-07:10      ~mio | tiny zeyeknee</code></pre>
+</summary>
-<p>Pirates?</p>
+<p>NAMES AND NPCS</p>
-<h3 id="crystals">crystals</h3>
+<p>Upcoming NPCs and/or monsters</p>
-<p>the five Ginnarak crystals:</p>
 <ul>
-<li>earth – cave</li>
+<li>zai-ni</li>
-<li>water – underwater pirate shipwreck</li>
+<li>zeyeknee</li>
-<li>fire – volcano</li>
+<li>standard ed</li>
-<li>wind – cloudstuff</li>
+<li>three fingered gerald</li>
-<li>heart? ice?</li>
+<li>paladin of emacs</li>
+<li>monks of vim</li>
+<li>gnu zealots</li>
+<li>hinderbloke</li>
+<li>falterchap</li>
 </ul>
-<h3 id="hodgepodge">hodgepodge</h3>
+<p>CRYSTALS</p>
-<p>mio’s (Inky’s) Handy Duffer Discette = HD Diskette = better stay away
+<p>Each crystal has an associated <em>element</em>, a <em>location</em>
-from magnets!!</p>
+appropriate to the element, and an <em>aspect</em> of Neddas for the
-<p>The Benefactor is Nullar</p>
+guardian and their minions.</p>
-<p>Blavin is a secret agent, working for the Golden Iris, a secret
+<table>
-society that wants to ‘create balance’ by seating a fourth god</p>
+<thead>
-<p>Nullar got tired of being a god and wanted to die, and Neddas agreed
+<tr class="header">
-to help him. Shit went bad and turned Liandt to stone, and Nullar’s leg
+<th style="text-align: left;">Element</th>
-to stone.</p>
+<th style="text-align: left;">Location</th>
-<p>Now Nullar is trying to gather the Ginnarak crystals to assemble the
+<th style="text-align: left;">Aspect</th>
-<em>God Slayer</em> to attempt once more to end his own life.</p>
+</tr>
-<p>The gang has a rival: the gophers of Retrieval Team 70</p>
+</thead>
+<tbody>
+<tr class="odd">
+<td style="text-align: left;">earth</td>
+<td style="text-align: left;">cave</td>
+<td style="text-align: left;">coin</td>
+</tr>
+<tr class="even">
+<td style="text-align: left;">water</td>
+<td style="text-align: left;">underwater pirate shipwreck</td>
+<td style="text-align: left;">mirth</td>
+</tr>
+<tr class="odd">
+<td style="text-align: left;">wind</td>
+<td style="text-align: left;">cloudstuff</td>
+<td style="text-align: left;">lore</td>
+</tr>
+<tr class="even">
+<td style="text-align: left;">void</td>
+<td style="text-align: left;">spaaaaace</td>
+<td style="text-align: left;">craft</td>
+</tr>
+<tr class="odd">
+<td style="text-align: left;">fire</td>
+<td style="text-align: left;">volcano</td>
+<td style="text-align: left;">tact</td>
+</tr>
+</tbody>
+</table>
+<p>The crystals will eventually lead them to Neddas</p>
+<p>IDEAS</p>
+<p>todo:</p>
+<ul class="task-list">
+<li><input type="checkbox" disabled="" />mio’s (Inky’s) Handy Duffer
+Discette = HD Diskette = better stay away from magnets!!</li>
+<li><input type="checkbox" disabled="" />The Benefactor is Nullar</li>
+<li><input type="checkbox" disabled="" />Blavin is a secret agent,
+working for the Golden Iris, a secret society that wants to ‘create
+balance’ by seating a fourth god</li>
+<li><input type="checkbox" disabled="" />Nullar got tired of being a god
+and wanted to die, and Neddas agreed to help him. Shit went bad and
+turned Liandt to stone, and Nullar’s leg to stone. Now Nullar is trying
+to gather the Ginnarak crystals to assemble the <em>God Slayer</em> to
+attempt once more to end his own life.</li>
+</ul>
+<p>completed:</p>
+<ul class="task-list">
+<li><input type="checkbox" disabled="" checked="" />The gang has a
+rival: the gophers of Retrieval Team 70</li>
+</ul>
+</details>
+<h2 id="acknowledgements">Acknowledgements</h2>
+<p>The setting, plot, and major non-player characters of Basement Quest
+are all lifted wholesale from Trinyvale, by Not Another D&amp;D
+Podcast.</p>
+<ul>
+<li><a
+href="https://notanotherdndpodcast.fandom.com/wiki/Category:Trinyvale"
+class="uri">https://notanotherdndpodcast.fandom.com/wiki/Category:Trinyvale</a></li>
+<li><a href="https://www.naddpod.com/"
+class="uri">https://www.naddpod.com/</a></li>
+</ul>
+<p>Paths and Templates are inspired by Caput Caprae and many others.</p>
+<ul>
+<li><a
+href="https://caput-caprae.blogspot.com/2020/11/using-templates.html"
+class="uri">https://caput-caprae.blogspot.com/2020/11/using-templates.html</a></li>
+</ul>
+<p>And if there’s anything else creative or original herein, then it
+probably came from the feverish minds of my players!</p>
 <h2 id="afterword">Afterword</h2>
 <p>I don’t know what I’m going to put here, but I didn’t want this
 document to just abruptly end. So here you go: a kind farewell and a