Whether you use Blogger or WordPress, Github Pages or Ghost — even if you painstakingly craft every tab stop and angle bracket of your pure-HTML static site — if you post “actual play” reports of your role-playing adventures online, then you surely know the incessant struggle of separating narration from mechanics and die rolls from commentary. Woe are we who endure these pains and wish there were some other way! Surely some kind soul will deliver us from this blogging purgatory, this persecution of play reports, the secret, sorrowful soliloquy of our social shares, this —
<head> and you’re good to go.
- Wrap your narrative bits in
- Set die rolls apart, inline or block, with the
- Hide mechanics and more behind expanding
A fork of Shortcode.js, which does all the heavy lifting, ap_shortcodes.js is simply a definition and styles for tags to meet the most common actual play formatting needs.
- Include references to shortcode.js, ap_shortcodes.js, and ap_shortcodes.css in your page’s
<script src="https://cdn.rawgit.com/sdsalyer/ap_shortcodes.js/master/js/shortcode.js"></script> <script src="https://cdn.rawgit.com/sdsalyer/ap_shortcodes.js/master/js/ap_shortcodes.js"></script> <link rel="stylesheet" href="https://cdn.rawgit.com/sdsalyer/ap_shortcodes.js/master/css/ap_shortcodes.css">
- (Optional) If you downloaded the files, alter ap_shortcodes.js to add/edit shortcodes. Alter ap_shortcodes.css to add/edit the associated styles.
- Use the shortcodes in your actual play report, then ooh and ahh at the results!
What is an Actual Play and Why Should I Care?
An “actual play” report, or AP, is a blog or forum post sharing the details of a pen and paper role-playing adventure for others to enjoy online. These posts typically involve the expected blog-style setup and commentary amidst a mixture of narration and game play elements. It’s not always easy or straightforward for blog authors to distinctly style (or obfuscate, if you’re trying to avoid spoilers) these separate elements to better distinguish them for readability, aesthetics, or even dramatic effect.
What are Shortcodes and Why Should I Care?
The term “shortcode” is attributed to WordPress, but if you’ve ever posted on an internet forum or message board then you’ve probably seen or used BBCode — those tags in square brackets that allow you to format your post, insert a link, or create an enormous chain of animated gif emoticons to troll your pals.
Same idea here, but we’re focused on a drop-in solution for most any blog or website which is tailor-made to actual play posts.
Check it out on GitHub
The project is licensed under the MIT License, inherited from shortcode.js.
An Actual Play Example
Wisps of Time is a WordPress site, and I actually already have plugins installed that use the [dice] and [spoiler] tags, so it’s a bit difficult to post the actual play example here. You can check out the example.html that’s in the GitHub repo, or head over to this Blogger site I created, just for this very purpose!Check it out on Blogger!