Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 3.07 KB

README.md

File metadata and controls

66 lines (49 loc) · 3.07 KB
Raw

D&D Beyond to Alchemy Character Converter

ci deploy Contributor Covenant

This repository contains the code that converts a D&D Beyond character to JSON compatible with Alchemy. Alchemy uses this library directly during the D&D Beyond import process.

⚠️ This tool is in beta. Alchemy itself is still in early access. Importing a character from D&D Beyond requires an Alchemy Unlimited subscription.

Functionality

Currently, the converter works for these properties:

  • Ability scores
  • Actions
  • Age, height, weight, eyes, hair, skin
  • Armor class
  • Classes (names and levels only)
  • Experience points
  • Avatar/portrait image
  • Initiative bonus
  • Inventory items (including homebrew)
  • Inventory item actions
  • Currency
  • HP (current, max)
  • Movement modes/speed
  • Name
  • Proficiencies (weapon, armor, language, save, tool)
  • Race
  • Skills
  • Spells (SRD)
  • Spells (Expansions & homebrew — partial support)
  • Spell slots
  • Feats
  • Background, appearance, and other descriptive text

Usage Outside of Alchemy

This library is directly integrated into Alchemy, but if you're developing changes to this library, you can test them by downloading your character JSON from D&D Beyond, converting it to Alchemy JSON using the provided web converter, and then importing the Alchemy JSON into your character library.

Downloading your character from D&D Beyond

  1. View this bookmarklet and copy it to your clipboard
  2. Create a new bookmark and paste the bookmarklet into the URL field
  3. Go to https://www.dndbeyond.com/characters
  4. Click on the character you want to convert
  5. Open the bookmarklet you created; it should download the character as a JSON file

Uploading your character to Alchemy

  1. Visit the converter and upload the JSON file you downloaded in the previous step
  2. Click "convert"; it should download a new JSON file for use with Alchemy
  3. Visit the Library tab in Alchemy and go to "Characters"
  4. Click the dropdown next to "Create Character" and choose "Import JSON"
  5. Upload the file you downloaded in step 2

Contributing

We welcome contributions to this repository! The D&D Beyond conversion process is complex and ever-changing, so your help in keeping things working smoothly is greatly appreciated.

Please see CONTRIBUTING for more information on how to contribute.

License

MIT