DnD Beyond Importer for Atlas

by young-george
5
4
3
2
1
Score: 50/100

Description

Import any public D&D Beyond character sheet into Obsidian as a ready to use statblock for Atlas VTT

Reviews

No reviews yet.

Stats

0
stars
144
downloads
0
forks
8
days
2
days
4
days
1
total PRs
0
open PRs
0
closed PRs
1
merged PRs
0
total issues
0
open issues
0
closed issues
23
commits

Latest Version

4 days ago

Changelog

  • Fix issue with reaction spells not appearing.
  • Fix an issue with spells upcasting all the way to level 9.
  • Fix an issue with healing spells not showing dice rolls.
  • Warn the user when the 5e (2024) Character Sheet template is out of date, offering to update it.
  • Fix issue with weapon behaviours and damage dice not showing correctly for versatile weapons.

README file from

Github

DnD Beyond Importer for Atlas VTT is a community extension. It is not made, endorsed or supported by Atlas VTT or Atlas Online.

D&D Beyond Importer for Atlas VTT

Import any public D&D Beyond character sheet into Obsidian as a ready to use statblock for Atlas VTT.


Installation

  1. Open Settings

  2. Go to Community plugins

  3. Click Browse

  4. Search "DnD Beyond Importer for Atlas"

  5. Click Install, then Enable

  6. Configure plugin settings (optional)

  7. (Recommended) Install the Force note view mode plugin. The importer makes use of this plugin to default to 'Reader' view, showing the embedded D&D Beyond page.

Manual

  1. Download the latest release zip from the Releases page (or build from source below)
  2. Unzip into your vault's plugin directory:
    <YourVault>/.obsidian/plugins/dndbeyond-importer-for-atlas/
    
    The folder needs main.js, manifest.json, and styles.css
  3. Go to Obsidian → Settings → Community Plugins and enable D&D Beyond Importer for Atlas

Build from source

git clone https://github.com/young-george/DnD-Beyond-Importer-for-Atlas.git
cd dndbeyond-importer-for-atlas
npm install
npm run build

This produces main.js in the project root.

Run tests with vitest and accept any valid changes to the snapshots.


Usage

Importing a character

Ribbon: click the import D&D Beyond character icon in the left sidebar.

Command palette: Ctrl/Cmd + P → DnD Beyond Importer for Atlas: Import character from D&D Beyond

Any of these input formats work:

  • Full URL — https://www.dndbeyond.com/characters/131905892/Gk8rBed
  • Short URL — https://www.dndbeyond.com/characters/131905892
  • Character ID — 131905892

The character sheet must be set to Public on D&D Beyond. Private sheets can't be fetched.

Override Statblock Template

The default character sheet statblock template can be overridden using the Atlas interface, or by specifying the template in the statblock note frontmatter. This change will be remembered for future imports of the same character.


Commands

DnD Beyond Importer for Atlas: Import character from D&D Beyond: Import a character sheet from D&D Beyond into Obsidian as a statblock note for Atlas VTT.

DnD Beyond Importer for Atlas: Sync all imported characters: Re-sync all previously imported character sheets with D&D Beyond.


Settings

Setting Default Description
Output folder Characters Vault folder where character notes are saved (leave blank for vault root).
Image output folder ~/Images/ Where character images are saved in your vault. Defaults to Images/ relative to the imported sheet. Prefix the folder with ~ to specify a relative path.
Include detailed descriptions true Include detailed descriptions of features, traits, and spells in the character note, linked in the statblock. The descriptions can be viewed by hovering over the links in the statblock.
Embed D&D Beyond page true Embed the D&D Beyond character sheet page in the statblock note. This allows you to view the original sheet without leaving Obsidian. Obsidian edit mode can be used to view the actual note content.
Automatcally sync... when Obsidian opens true Automatically re-sync all character sheets with D&D Beyond when Obsidian starts.
Automatically sync... when opening sheet true Automatically sync character sheet when opening & viewing the note in Obsidian. This will not sync the sheet when viewing the statblock in Atlas.
Don't import skill modifiers false Don't import skill modifiers when syncing character sheets, use Atlas' automatically calculated modifiers instead. This might cause Atlas' skill modifiers to differ from D&D Beyond's if you have items, feats, homebrew rules or other modifiers applied.

A note on the D&D Beyond API

The plugin fetches from an unofficial internal endpoint:

https://character-service.dndbeyond.com/character/v5/character/{ID}

This isn't officially documented or supported by D&D Beyond / Wizards of the Coast and could change or break without warning. The plugin is read-only — it never writes anything back to D&D Beyond.


Support

If you have any issues, please open a GitHub issue, or post a here in the Atlas VTT Discord server. Please include the character ID so that the imported sheet can be replicated and debugged.