vscode-dmbinder

Visual Studio Code extension for managing campaign documents.

Documentation

Documentation of how to use vscode-dmbinder has now moved to our wiki!

Installation

Requires Visual Studio Code. Once VSCode is installed, search for the extension or install it from here.

Features

DMBinder view that helps organize campaign documents
Generation of Hombrewery elements using snippets and templating (Mustache, Handlebars or Pandoc)
Rendering of markdown files to PDF using Puppeteer
Randomly generate dungeon maps
Generation of content (like names, titles, locations, etc.) using randomized lists or Markov chains
Random generation of basic dungeon maps

Issues or Feature Requests

Please submit any issues or new feature requests to GitHub.

DMBinder Explorer

The extension looks for .dmbinder/campaign.json in your workspace folders, and displays all DMBinder campaigns in the sidebar.

DMBinder Explorer screenshot

Configuration Settings

dmbinder.generateGettingStartedEnabled
dmbinder.homebrewPreviewEnabled
dmbinder.autogenerateOnRender
dmbinder.treeViewStyle
dmbinder.chromeExecutablePath
dmbinder.defaultTemplatingEngine (Default: "handlebars")

campaign.json

Below is an example Campaign configuration file:

{
    "campaignName": "My Cool Campaign",
    "sourcePaths": [
        "./source/"
    ],
    "templatePaths": [
        "./templates/"
    ],
    "componentPaths": [
        "./components/"
    ],
    "generatorPaths": [
        "./generator-sources"
    ],
    "outDirectory": "./out/"
}

Planned Changes

When generating a dungeon map, save settings to a Markdown comment before the map

See generator-dmbinder for a yeoman generator to help bootstrap a campaign binder.

See Changelog for release notes.

Icon Sources

Material Design Icons
Official icons (various icons from Microsoft's vscode repo)
GitHub's Octicons using Microsoft's vscode icon tool

jsnee/vscode-dmbinder