Skip to content

Commit

Permalink
Merge pull request #1 from Roll20/acsearles-changes
Browse files Browse the repository at this point in the history
Wording Changes to intro.md
  • Loading branch information
acsearles authored Jun 25, 2024
2 parents edded31 + fb1d91c commit 80da7ad
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 28 deletions.
35 changes: 20 additions & 15 deletions content/docs/guides/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Installation"
description: "This guide will help you set up the Beacon SDK on your machine."
title: "Installing Beacon"
description: "This guide will help you set up the Beacon SDK in your javascript application."
summary: ""
date: 2024-04-07T16:04:48+02:00
lastmod: 2024-02-07T16:04:48+02:00
Expand All @@ -14,26 +14,29 @@ seo:
noindex: false # false (default) or true
---

This installation guide is designed for sheet developers that want to start creating a sheet from scratch or already have an existing project they wish to start from. To get started quickly with a boilerplate, you can download and start editing the [Quick Start Example Sheet](https://github.com/Roll20/roll20-beacon-sheets/tree/main/sheets/quickstart-example-sheet) which already has the Beacon SDK installed in a [Vue.js](https://vuejs.org/guide/introduction.html) project.

## Prerequisites

Before you can install the Beacon SDK, you'll need to have Node.js installed on your machine. If you don't have Node.js installed, use the following steps in the [official Node.js documentation](https://nodejs.org/en/download/package-manager).
Before you can install the Beacon SDK, you'll need to have the following completed.
- A local development environment with a code editor.
- Node.js installed on your machine. If you don't have Node.js installed, use the following steps in the [official Node.js documentation](https://nodejs.org/en/download/package-manager).
- A project with a javascript framework. We suggest [Vue.js](https://vuejs.org/guide/introduction.html) but you can choose whichever you are more comfortable with.

## Step 1: Accessing Beacon SDK
{{< callout context="note" >}}
These steps use the npm package manager but you are free to use any package manager you prefer.
{{< /callout >}}

```js
npm i @roll20-official/beacon-sdk
```
The following steps will guide you in installing the Beacon SDK in your application:

## Step 2: Install & Import

The following steps will guide you in installing the package in your application:
## Step 1: Add the package to your `package.json`.

1. **Add the package to your `package.json`:**

Under the `dependencies` object key of your `package.json`, add a new string key called `@roll20/beacon-sdk` with the version you want to install from our version history.
[You can find the latest version of the package on NPM registry.](https://www.npmjs.com/package/@roll20-official/beacon-sdk)

**For example**:
Under the `dependencies` object key of your `package.json`, add a new string key called `@roll20/beacon-sdk` with the version you want to install from our version history.

**For example**:

```json
{
Expand All @@ -43,7 +46,7 @@ The following steps will guide you in installing the package in your application

For more information about installing packages, refer to the [NPM documentation](https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file).

2. **Run `npm install`:**
## Step 2: Run `npm install`.

Open a terminal in the root of your application’s folder and run the following command:

Expand All @@ -53,7 +56,7 @@ The following steps will guide you in installing the package in your application

For more information about NPM commands, refer to the [NPM install documentation](https://docs.npmjs.com/cli/v6/commands/npm-install).

3. **Import the necessary package contents in your application:**
## Step 3: Import the necessary package contents in your application.

The package exports various utilities you can use in your application. For example, you will need to utilize the `initRelay` function from the package.

Expand All @@ -63,4 +66,6 @@ The following steps will guide you in installing the package in your application
import { initRelay } from '@roll20/beacon-sdk';
```

<!-- We need to add a link to learn more about the InitRelay -->

For more information about imports, refer to the [JavaScript import documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import).
26 changes: 13 additions & 13 deletions content/docs/guides/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,39 +20,39 @@ Whether you're a game master (GM), a developer, or a player, the Beacon SDK prov

## What is the Beacon SDK?

The Beacon SDK is a specialized software development kit for virtual tabletops.
The Beacon SDK (software development kit) is a toolset used to create digital character sheets on Roll20 for Roll20 Tabletop and Roll20 Characters.

Whether you're an experience developer, or just starting out, the Beacon SDK provides a framework to create dynamic, responsive, and fully integrated character sheet experiences.

It facilitates creating and managing interactive character sheets, roll templates, macros, and other VTT functionalities.

The SDK ensures easy communication between the VTT platform and the character sheets, allowing real-time updates and interactions.
The Beacon SDK also introduces a new way to develop characters sheets for Roll20. Beacon SDK allows you to connect your local development environment to sandboxes in Roll20 Characters and Roll20 Tabletop, giving you real-time updates as you develop.

## Key Features

- **Character Sheets**: Design and implement detailed character sheets with dynamic attributes and real-time updates.
- **Roll Mechanics**: Integrate complex roll formulas and display roll results directly within the VTT.
- **Macros**: Create and manage macros for automated actions and roll calculations.
- **Event Handling**: Utilize a comprehensive set of handlers to manage various events and interactions within the VTT.
- **Character Sheets**: Design and implement a web app character sheet with dynamic attributes and real-time updates.
- **Local Development**: Work where you are most comfortable and get real-time updates in sandboxes in Roll20.
- **Testing Sheets**: Release a testing sheet and give others special access to it before you push it live for everyone.
- **Roll Mechanics**: Integrate complex roll formulas and display roll results directly within the Roll20 Tabletop and Roll20 Characters.
- **Legacy Support**: Convert and integrate legacy macros and roll templates with the new Beacon architecture.
- **Customization**: Define custom actions computed properties and handle specific roll templates tailored to your game's needs.
- **Customization**: Define custom actions, computed attributes and handle specific roll templates tailored to your game's needs.

## Components Overview

The Beacon SDK is composed of several key components:

- **Actions**: Define and manage custom actions that can be triggered within the VTT.
- **Handlers**: Event handlers that process and respond to various VTT events and messages.
- **Computed Properties**: Define dynamically computed properties based on other attributes.
- **Computed Attributes**: Define dynamically computed attributes based on other attributes.
- **Macro Attributes**: Convert and manage legacy macro attributes for compatibility with the Beacon SDK.
- **Rolls**: Implement advanced roll mechanics and display results dynamically within the VTT.

For a comprehensive overview of these components, view the components section.

## 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 properties.
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.
This documentation provides detailed guides and example sheets to help you through each step of the process.

By leveraging the Beacon SDK, you can create rich, interactive, fully integrated VTT experiences that enhance gameplay and streamline game management.

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

0 comments on commit 80da7ad

Please sign in to comment.