Skip to content

Commit

Permalink
Merge pull request #33 from Roll20/Andrew_Friday_Edits
Browse files Browse the repository at this point in the history
Andrew Friday Edits
  • Loading branch information
acsearles committed Jun 28, 2024
2 parents 0149bb4 + 9267f0e commit 4e814f6
Show file tree
Hide file tree
Showing 18 changed files with 136 additions and 151 deletions.
6 changes: 3 additions & 3 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Welcome to Beacon SDK"
title: "The Beacon SDK by Roll20"
description: ""
lead: "Congrats on setting up a new Doks project!"
lead: "Roll20 Character Sheets with Modern Web Development Tools"
date: 2023-09-07T16:33:54+02:00
lastmod: 2023-09-07T16:33:54+02:00
draft: false
seo:
title: "Welcome to Beacon SDK" # custom title (optional)
title: "The Beacon SDK by Roll20" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
Expand Down
36 changes: 2 additions & 34 deletions content/docs/about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,40 +16,8 @@ seo:
noindex: false # false (default) or true
---

**Release Date**: 2022-03-17
**Release Date**: 2024-07-1

### New Features

- Initial release of the Beacon SDK.
- Support for Vue.js framework.
- Setup with Vite for rapid development.
- Basic and advanced sheet examples.

### Improvements

- Detailed comments added to example files for better understanding.
- Support for complex roll templates and rich sheet actions.

### Bug Fixes

- N/A (initial release).

## Version 2.0.0

**Release Date**: 2023-03-17

### New Features

- SCSS support for styling.
- Integration with Roll20 and VTT.
- Mock Relay for offline development.

### Improvements

- TypeScript integration for type checking and improved development experience.
- Unit testing with Vitest.
- End-to-End testing with Cypress.

### Bug Fixes

- N/A (initial release).
- Closed Beta Released. [Sign up to get access to Beacon SDK and Roll20 Sandboxes](https://docs.google.com/forms/d/e/1FAIpQLScwIAc38NhSTYBtZH04pkDj9O7APwysdgsRnVssFNhsoONOUw/viewform?usp=sf_link)
6 changes: 6 additions & 0 deletions content/docs/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ seo:
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

{{< details "**Q: How is Beacon better than the old way of building sheets (known as Custom Sheets)?**" >}}

It depends on your web development skill level. There are a number of benefits to the Beacon SDK if you know how to build web applications. If you don't know how to set up your own local environment, than the Beacon SDK might now be the first place you should start. [Learn more about sheet development using the custom sheet](https://help.roll20.net/hc/en-us/articles/360037773413-Intro-to-Sheet-Development).
Expand Down
6 changes: 6 additions & 0 deletions content/docs/about/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ seo:
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

## Background:
The background color of the alert box.

Expand Down
94 changes: 23 additions & 71 deletions content/docs/about/howtocontribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,88 +14,40 @@ seo:
noindex: false # false (default) or true
---

We appreciate your interest in contributing to the Beacon SDK project. Here are some guidelines to help you get started:
{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

## How to Contribute
Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

### Reporting Bugs

If you find a bug, please report it by opening an issue in the GitHub repository. Provide as much detail as possible to help us understand and reproduce the issue.

### Suggesting Features

We welcome suggestions for new features. Please open an issue in the GitHub repository with a detailed description of the feature you would like to see and why you think it would be useful.

### Code Contributions

1. **Fork the Repository**: Create a personal fork of the project on GitHub.

2. **Clone the Fork**: Clone your fork to your local machine.

```bash
git clone
```

3. **Create a Branch**: Create a new branch for your work.

```bash
git checkout -b feature-or-bugfix-description
```
We strive to make the Beacon SDK and its documentation a better tool for Community Sheet Developers like you! So before we get started, thank you for helping us make them the best they can be. It is no small task supporting all games with the best digital character sheets, but with your help, players around the world will can use awesome characeter sheets for their favorite games.

4. **Make Changes**: Make your changes to the codebase. Follow the existing code style and conventions.

5. **Run Tests**: Ensure that all tests pass before submitting your changes.

```bash
npm run ci-check
```

6. **Commit Changes**: Commit your changes with a descriptive commit message.

```bash
git commit -m "Description of your changes"
```

7. **Push Changes**: Push your changes to your fork.

```bash
git push origin feature-or-bugfix-description
```

8. **Create a Pull Request**: Open a pull request from your fork to the main repository. Provide a detailed description of your changes and why they should be merged.

### Running Tests

- **Unit Tests**: Run unit tests with Vitest.
### Reporting Bugs

```bash
npm run test:unit
```
If you find a bug with the Beacon SDK, and you want to report it, thank you. There are several ways you can go about reporting it. Feel free to choose the easiest for you. Most importantly, we want you to let us know so we can fix them.

- **End-to-End Tests**: Run End-to-End tests with Cypress.
1. You can create an issue on the [Beacon Documentation Github Repo](https://github.com/Roll20/beacon-docs/issues).
2. You can create an issue on the [Beacon Community Sheets Repo](https://github.com/Roll20/roll20-beacon-sheets/issues).
3. You can let us know in the [Community Sheet Developers Discord Channels](https://discord.gg/RollThru). Make sure to fill out a [Beta Sign up form(https://docs.google.com/forms/d/e/1FAIpQLScwIAc38NhSTYBtZH04pkDj9O7APwysdgsRnVssFNhsoONOUw/viewform?usp=sf_link)] before joining the Discord.
4. You can submit a [Roll20 Help Ticket](https://help.roll20.net/hc/en-us/requests/new?ticket_form_id=1500000234201) where our support staff and make sure we get the information.

```bash
npm run test:e2e
```
When you submit a bug report, it's most helpful for you to include steps that will reliably reproduce the bug. If you don't have those, that's fine too. The most important thing is to report it. We'll work with you to figure out how we can reproduce and fix the bug.

### Code Style
Ultimately, our team manages our sprint work with an internal tool. No matter which method you use to report the issue, we'll create a companion ticket in our internal tool and link it to your original report. This is why if we have questions, we can find your report, and when we're done, we can let you know that it has been fixed.

- Follow the existing code style and conventions.
- Use ESLint for linting.
### Suggesting Features

```bash
npm run lint
```
If you have an idea of a feature that we should add to make things easier for you or others, please let us know! Here are a few ways that you can choose from to let us know.

- Format code with Prettier.
1. You can create an issue on the [Beacon Documentation Github Repo](https://github.com/Roll20/beacon-docs/issues).
2. You can create an issue on the [Beacon Community Sheets Repo](https://github.com/Roll20/roll20-beacon-sheets/issues).
3. You can let us know in the [Community Sheet Developers Discord Channels](https://discord.gg/RollThru). Make sure to fill out a [Beta Sign up form(https://docs.google.com/forms/d/e/1FAIpQLScwIAc38NhSTYBtZH04pkDj9O7APwysdgsRnVssFNhsoONOUw/viewform?usp=sf_link)] before joining the Discord.
4. You can schedule a meeting with Andrew and/or Alice directly to talk about it and give him the opportunity to ask questions about it.

```bash
npm run format
```
Ultimately, we want to hear what is particularly painful and time consuming for you so we can work to make it easier for you to create awesome digtial character sheets for the games you love.

## Communication
### Code Contributions to the Beacon SDK Documentation

- **GitHub Issues**: Use GitHub issues for bug reports, feature requests, and questions.
- **Pull Requests**: Use GitHub pull requests to submit your code contributions.
Our goal it to build this site into the single source of information for Community Sheet Developers. The task of documenting everything will take time and iteration. If you find something in the documention that is wrong or needs to be updated, please let us know! You are also welcome to make a pull request of the [Beacon SDK Documentation Repo](https://github.com/Roll20/beacon-docs/pulls), update the files, and commit your changes. We'll review and publish them on a regular basis.

Thank you for contributing to the Beacon SDK project!
When you do submit a pull request, thank you for helping us make the Beacon SDK project better!
7 changes: 7 additions & 0 deletions content/docs/components/InitRelay.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ seo:
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

The Beacon SDK is composed of various methods and components that allow developers to create dynamic and interactive character sheets for virtual tabletop (VTT) games. `initRelay` is the main method that initializes the Beacon SDK communication channel with the host (Either the Roll20 tabletop or in Roll20 Characters). It should be initialized as soon as the sheet loads, as its `onInit` handler will be the earliest we can get access to that character's data.

```typescript
Expand Down
6 changes: 6 additions & 0 deletions content/docs/components/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ seo:
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

```typescript
initRelay({
//...other methods
Expand Down
6 changes: 6 additions & 0 deletions content/docs/components/computed.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ seo:
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

Sheet authors define computed properties that are accessed by the Roll20 Tabletop or Roll20 Characters. These computed properties can be used as attributes in macros and are available to assign as values to token bars - if the `tokenBarValue` property is set to true.

```typescript
Expand Down
7 changes: 7 additions & 0 deletions content/docs/components/dispatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ seo:
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

The dispatch is returned by the `initRelay` and provides methods for sending commands from the character sheet back to the host. Except when specified every method below will return a promise.

#### update
Expand Down
7 changes: 7 additions & 0 deletions content/docs/components/handlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ seo:
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

Handler methods allow the sheet to respond to data passed from the Roll20 Tabletop or Roll20 Characters (both refered to as host throughout this page) to the sheet. It is the main agrument that must be passed into `initRelay` or the sheet will never fully load.

```typescript
Expand Down
6 changes: 6 additions & 0 deletions content/docs/components/macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ seo:
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

When utilizing Macroswithin the Roll20 Tabletop or Roll20 Characters (both refered to as host throughout this page), there are instances where a legacy macro might need to be employed for a Beacon sheet.

This scenario commonly arises when transitioning from an existing legacy sheet to a Beacon sheet. During such transitions, it's possible that the attributes or roll templates called from the legacy macro may not align with the structure of attributes or the lack of roll templates in the Beacon Sheet.
Expand Down
7 changes: 7 additions & 0 deletions content/docs/components/roll.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ seo:
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

The Roll20 Tabletop and Roll20 Characters (both refered to as host throughout the rest of this page) have several new features that enhance the way rolls are handled and displayed. These features include attributes and elements that allow for dynamic roll results and interactivity within the host.
[Vist the Roll20 help center to learn more about Roll20's Dice Rolling system](https://help.roll20.net/hc/en-us/articles/360037773133-Dice-Reference)

Expand Down
5 changes: 5 additions & 0 deletions content/docs/gettingstarted/examplesheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ seo:
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

## Prerequisites

Expand Down
6 changes: 6 additions & 0 deletions content/docs/gettingstarted/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ seo:
noindex: false # false (default) or true
---

{{< callout context="tip" title="Join the Closed Beta" icon="outline/rocket" >}}
The Beacon SDK is currently in closed Beta. Please complete the [form](https://forms.gle/XXnj1SbfmYnUq8Hu9) to sign up for the closed beta.

Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, the community sheet developers in discord, and the new sheet developer Roll20 permissions.
{{< /callout >}}

This installation guide is designed for sheet developers with experience in web development, that want to start creating a character sheet from scratch or already have an existing project they wish to add Beacon to.

{{< callout context="tip" >}}
Expand Down
Loading

0 comments on commit 4e814f6

Please sign in to comment.