Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsnee/vscode-dmbinder
Visual Studio Code extension for managing campaign documents.
https://github.com/jsnee/vscode-dmbinder
dm-tools dnd-tools dnd5e dungeons-and-dragons dungeonsanddragons pathfinder-rpg rpg tabletop-gaming tabletop-rpgs
Last synced: about 1 month ago
JSON representation
Visual Studio Code extension for managing campaign documents.
- Host: GitHub
- URL: https://github.com/jsnee/vscode-dmbinder
- Owner: jsnee
- License: gpl-3.0
- Created: 2019-02-01T20:28:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T09:00:48.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T05:11:32.944Z (5 months ago)
- Topics: dm-tools, dnd-tools, dnd5e, dungeons-and-dragons, dungeonsanddragons, pathfinder-rpg, rpg, tabletop-gaming, tabletop-rpgs
- Language: TypeScript
- Size: 4.52 MB
- Stars: 56
- Watchers: 4
- Forks: 6
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vscode-dmbinder
Visual Studio Code extension for managing campaign documents.
## Documentation
Documentation of how to use vscode-dmbinder has now moved to our [wiki](https://github.com/jsnee/vscode-dmbinder/wiki)!
## Installation
Requires [Visual Studio Code](https://code.visualstudio.com/download). Once VSCode is installed, search for the extension or install it from [here](https://marketplace.visualstudio.com/items?itemName=jpsnee.vscode-dmbinder).
## 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](https://github.com/jsnee/vscode-dmbinder/issues).
## 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:
``` json
{
"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](https://github.com/jsnee/generator-dmbinder) for a yeoman generator to help bootstrap a campaign binder.
See [Changelog](CHANGELOG.md) for release notes.
-----------------------------------------------------------------------------------------------------------
## Icon Sources
- [Material Design Icons](https://materialdesignicons.com/)
- Official icons (various icons from Microsoft's vscode repo)
- [GitHub's Octicons](https://github.com/primer/octicons/tree/master/lib/octicons_node) using [Microsoft's vscode icon tool](https://github.com/microsoft/vscode-octicons-font)
## Related Projects
- [Homebrewery](https://github.com/naturalcrit/homebrewery)
- [homebrewery-vscode](https://github.com/OfficerHalf/homebrewery-vscode)