D&D Beyond Importer

Integrate your dndbeyond.com characters into Foundry Virtual Tabletop.

This module: * Import your DDB characters into Foundry, and sync changes back! * Import a characters extras such as Wildshapes or beast companions. * Import spells and items. * Import Monsters and NPCs. * Patreon supporters can sync limited character changes back to DDB.

You can also:

• Use the built in dictionary to get a large icon coverage during import.
• Use supplied SRD items where available.
• Choose to use matching SRD icons.
• Attempt to auto-generate effects for items.

Video Tutorial

Watch a video to get started here!.

Documentation

See the documentation site

What's the catch?

Calls to dndbeyond are proxied to provide authentication and to bypass CORS checks.

The proxy calls dndbeyond with your credentials to fetch your data.

To get all your spells and do bulk importing you need to set the Cobalt Cookie setting to the value of your D&DBeyond CobaltSession cookie. See my helper Chrome extension to help.

Do NOT give your cookie to other people, this is like handing out a password to your dndbeyond account.

We do not store your cobalt cookie on the server.

To logout/invalidate these credentials log out of your D&DBeyond Session.

If you wish to host your own proxy, please see ddb-proxy, help is not available for this mode, and not all functionality is available.

Support

Where can you support me? See my Patreon.

You can log bugs here, or mention them in the Discord channel.

Pre-requisites and recommendations

There are NO pre-requisites for DDB Importer.

Below are some recommended modules.

I'd strongly recommend installing:

• Tokenizer 2 - Helps create pog style tokens from DDB art.
• DAE - Helps enrich some of the effects for things like speed bonuses.
• Active Token Effects - Helps allow effect bonuses to transfer to tokens.
• Vision/Detection Modes 5e - Adds some key missing vision and detection modes for 5e.

To learn more about automation visit the docs.

FAQ

See the FAQ!

Attributions

Some assets in this module are kindly provided by JB2A and are licensed by Attribution-NonCommercial-ShareAlike 4.0 International. You can find them under img/jb2a

Check them out at https://jb2a.com they have a free and patreon supported Foundry modules providing wonderful animations and assets for a variety of situations.

You can learn more about their Foundry modules here

DDB Importer Hook Events

The module emits the following Foundry hook events:

• ddb-importer.preCreateTattooFromSpell

  • Fired before creating tattoo item data from a spell.
  • Returning false from any listener cancels tattoo creation.
  • Arguments:
    • spell: source spell document.
    • config: tattoo creation config object.

• ddb-importer.createTattooFromSpell

  • Fired after tattoo data is created and before the item is returned.
  • Arguments:
    • spell: source spell document.
    • spellTattooData: final generated tattoo item data.
    • config: tattoo creation config object.

• ddb-importer.compendiumCreationComplete

  • Fired after auto-compendium creation completes.
  • Payload:
    • { compendiums: string[] } compendium ids

• ddb-importer.characterProcessDataComplete

  • Fired after character import processing completes.
  • Payload:
    • { actor, ddbCharacter }

• ddb-importer.monsterAddToCompendiumComplete

  • Fired after a monster is added/updated in the target compendium.
  • Payload:
    • { actor }

• ddb-importer.${type}CompendiumUpdateComplete

  • Fired when a compendium import run finishes for a given type.
  • Payload:
    • { results }
  • Known typed events include:
    • ddb-importer.spellsCompendiumUpdateComplete
    • ddb-importer.classCompendiumUpdateComplete
    • ddb-importer.summonsCompendiumUpdateComplete
    • ddb-importer.featuresCompendiumUpdateComplete
    • ddb-importer.vehiclesCompendiumUpdateComplete
    • ddb-importer.itemsCompendiumUpdateComplete

Example listener

Hooks.on("ddb-importer.characterProcessDataComplete", ({ actor, ddbCharacter }) => {
    console.log("Character import complete", actor?.name, ddbCharacter);
});