Introduction

The Beacon SDK is a Software Development Toolset (SDK) designed to allow web developers create digital TTRPG character sheets for Roll20 using modern web development tools.

The Beacon SDK provides a framework to create dynamic, responsive, and fully integrated character sheet for both Roll20 Tabletop and Roll20 Characters.

What is the Beacon SDK?#

The Beacon SDK gives you tools to easily access character data on Roll20 in your local web environment. This allows you hook up your local host to development sandboxes in Roll20 Tabletop and Roll20 Characters so you develop and test your characters in Roll20 using actual compendium and character data.

Beacon SDK also gives you more tools to create and manage attributes that define your sheet’s data structure. It helps to bypass problematic callback functions, and completely removes the need for sheetworkers from the custom sheet development method.

Key Features#

• Develop Sheets Your Way: Beacon allows you to use the modern web development frameworks of your choice essentially making digital character sheets out of a web applications.
• Roll Mechanics: Integrate complex roll formulas and display roll results directly within Roll20 Tabletop or Roll20 Characters.
• Macros: Create attributes that give players control to make macros for automated actions and roll calculations without giving them too much asses to attributes that could break their character sheet.
• Event Handling: Utilize a comprehensive set of handlers to manage various events and interactions within Roll20 Tabletop.
• Legacy Support: Convert and integrate legacy macros and roll templates with the new Beacon architecture.
• Customization: Define custom actions, computed attibutes, and handle specific roll templates tailored to your game’s needs.

Getting Started#

To get started with the Beacon SDK, you must initialize the relay, set up your character sheets, and define the necessary actions, handlers, and computed attributes.

This documentation provides detailed guides and examples to help you through each step of the process.

By leveraging the Beacon SDK, you can create rich, interactive, fully integrated characters sheet in Roll20 Tabletop and Roll20 Characters that enhance gameplay and streamline game management for players and GMs.

Whether adapting existing character sheets or building new ones from scratch, the Beacon SDK offers the tools and flexibility to bring your game to life.