Skip to content

Commit

Permalink
Update wording of legacy sheet to Custom Sheet
Browse files Browse the repository at this point in the history
  • Loading branch information
Alicekb committed Jul 2, 2024
1 parent 130536e commit 4a3cee5
Show file tree
Hide file tree
Showing 54 changed files with 408 additions and 13,903 deletions.
6 changes: 3 additions & 3 deletions content/docs/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ Roll buttons are HTML elements with specific attributes that execute designated



{{< details "**Q: How are legacy attributes handled in Beacon?**" >}}
{{< details "**Q: How are Custom Sheet attributes handled in Beacon?**" >}}

Beacon gives you the ability to transition your legacy attributes to new attributes you create in Beacon. This means that when a user updates their sheet to the new Beacon sheet, their legacy attribute can be mapped to Beacon attributes using the `convertLegacyMacroAttributes` function. Sheet developers can define how to handle legacy attribute values to ensure compatibility with existing macros.
Beacon gives you the ability to transition your Custom Sheet attributes to new attributes you create in Beacon. This means that when a user updates their sheet to the new Beacon sheet, their Custom Sheet attribute can be mapped to Beacon attributes using the `convertLegacyMacroAttributes` function. Sheet developers can define how to handle Custom Sheet attribute values to ensure compatibility with existing macros.
{{< /details >}}


Expand All @@ -103,7 +103,7 @@ Tokens represent characters or objects on Roll20 Tabletop (VTT). Functions like

{{< details "**Q: What is the role of the convertLegacyMacroAttributesArgs type?**" >}}

The `convertLegacyMacroAttributesArgs` type defines the arguments used for handling legacy macro attributes. It includes the attribute name, character ID, and character data needed for mapping legacy attributes to the new sheet structure.
The `convertLegacyMacroAttributesArgs` type defines the arguments used for handling Custom Sheet macro attributes. It includes the attribute name, character ID, and character data needed for mapping Custom Sheet attributes to the new sheet structure.
{{< /details >}}


Expand Down
2 changes: 1 addition & 1 deletion content/docs/about/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ A digital or printed page used to track a character's attributes, abilities, and
Properties that have both get and set methods, which can be dynamically calculated.

## ConvertLegacyMacroAttributes:
A function to handle mapping legacy macro attributes to the new Beacon Sheet format.
A function to handle mapping Custom Sheet macro attributes to the new Beacon Sheet format.

## Dispatch:
A set of functions enabling the sheet to send commands back to the VTT.
Expand Down
16 changes: 8 additions & 8 deletions content/docs/components/InitRelay.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ These components are crucial for handling actions, computations, macros, and rol
{{< link-card
title="Actions"
description=" Actions define specific operations that can be performed by characters within the Roll20 Tabletop. These operations can range from simple tasks like rolling a dice to more complex interactions such as casting spells or activating abilities."
href="/docs/components/actions/"
href="/beacon-docs/docs/components/actions/"
target="_blank"
>}}
{{< link-card
title="Handlers"
description="Handlers are event listeners that manage communication between the Roll20 Tabletop and the character sheet. They respond to various events, such as changes in character attributes or settings, and trigger appropriate actions or updates."
href="/docs/components/handlers/"
href="/beacon-docs/docs/components/handlers/"
target="_blank"
>}}
{{< /card-grid >}}
Expand All @@ -63,13 +63,13 @@ These components are crucial for handling actions, computations, macros, and rol
{{< link-card
title="Computed"
description=" Computed properties are dynamic values derived from other character attributes. They allow for the creation of complex, calculated attributes that automatically update when their dependencies change."
href="/docs/components/computed/"
href="/beacon-docs/docs/components/computed/"
target="_blank"
>}}
{{< link-card
title="Macro Attributes"
description="Macro attributes handle the conversion of legacy macro attributes to the new format used in the Beacon SDK. This ensures compatibility with older character sheets and macros, allowing for a smooth transition to the new system."
href="/docs/components/handling-legacy-macro-attributes/"
title="Custom Sheet Macro Attributes"
description="Macro attributes handle the conversion of older Custom Sheet macro attributes to the new format used in the Beacon SDK. This ensures compatibility with older character sheets and macros, allowing for a smooth transition to the new system."
href="/beacon-docs/docs/components/custom-sheet-macro-attributes/"
target="_blank"
>}}
{{< /card-grid >}}
Expand All @@ -78,14 +78,14 @@ These components are crucial for handling actions, computations, macros, and rol
{{< link-card
title="Rolls"
description="The Rolls component allows for advanced dice-rolling mechanics within the Roll20 Tabletop. It supports both simple and complex rolls, providing flexibility in how roll results are displayed and computed."
href="/docs/components/rolls/"
href="/beacon-docs/docs/components/rolls/"
target="_blank"
>}}
{{< link-card
title="Dispatch"
description="The dispatch object provides methods for sending commands from the character sheet back to the host. Except when specified every method returns a promise."
href="/docs/components/dispatch/"
href="/beacon-docs/docs/components/dispatch/"
target="_blank"
>}}
{{< /card-grid >}}
12 changes: 6 additions & 6 deletions content/docs/components/macros.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Handling Legacy methods"
title: "Custom Sheet Macro Attributes"
description: ""
summary: ""
date: 2024-01-00T16:12:37+02:00
Expand All @@ -22,13 +22,13 @@ The Beacon SDK is currently in closed Beta. Please complete the [form](https://f
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.
When utilizing Macroswithin the Roll20 Tabletop or Roll20 Characters (both refered to as host throughout this page), there are instances where a older Custom Sheet 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.
This scenario commonly arises when transitioning from an existing older Custom Sheet to a Beacon sheet. During such transitions, it's possible that the attributes or roll templates called from the older Custom Sheet macros may not align with the structure of attributes or the lack of roll templates in the Beacon Sheet.

## convertLegacyMacroAttributes

The `convertLegacyMacroAttributes` method allows us to determine the mapping strategy for legacy attributes to the new Beacon Sheet.
The `convertLegacyMacroAttributes` method allows us to determine the mapping strategy for older Custom Sheet attributes to the new Beacon Sheet.

```typescript
initRelay({
Expand All @@ -46,11 +46,11 @@ This method is defined during the initial SDK initialization process and is invo
Advanced sheet actions typically will first search through the defined computed properties before resorting to the `convertLegacyMacroAttributes` method as a fallback.
{{< /callout >}}

The method's purpose is to return a value that will be substituted in the macro. However, it grants us the autonomy to devise the preferred approach for handling legacy attribute values.
The method's purpose is to return a value that will be substituted in the macro. However, it grants us the autonomy to devise the preferred approach for handling older Custom Sheet attribute values.

## handleLegacyRollTemplates

Since Beacon sheets no longer require or use roll templates as previously needed in older custom sheets, there will be times where a legacy macro might make include a reference to a legacy roll template. We can use the `handleLegacyRollTemplates` to determine how to handle these cases.
Since Beacon sheets no longer require or use roll templates as previously needed in older custom sheets, there will be times where a older Custom Sheet macro might make include a reference to a older Custom Sheet roll template. We can use the `handleLegacyRollTemplates` to determine how to handle these cases.

```typescript
initRelay({
Expand Down
4 changes: 2 additions & 2 deletions content/docs/components/roll.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet,
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)

The most command way to trigger a dice roll is through the dispatch object returned from the `initRelay`, but it could also be called from [actions](/docs/components/actions):
The most command way to trigger a dice roll is through the dispatch object returned from the `initRelay`, but it could also be called from [actions](/beacon-docs/docs/components/actions):
```typescript
dispatch.roll({
rolls: { [rollName: string]: string } // Ex. {attack: '1d20+4', damage: `3d6+2`}
Expand All @@ -45,7 +45,7 @@ The dispatch roll method and the actions roll section do not post to the chat, i

## Posting A Roll to the Chat

The roll method does not send or post any data to the chat on it's own. We instead have to use [dispatch's post](/docs/components/dispatch/#post) method to send our roll results along with any other content to the chat.
The roll method does not send or post any data to the chat on it's own. We instead have to use [dispatch's post](/beacon-docs/docs/components/dispatch/#post) method to send our roll results along with any other content to the chat.

```typescript
dispatch.post({
Expand Down
4 changes: 2 additions & 2 deletions content/docs/gettingstarted/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This will install the Beacon SDK package to your project's `package.json` file.

The Beacon package exports various utilities you can use in your application. The main one that needs to be setup to enable the connection between Beacon SDK and Roll20 is `initRelay`.

Ideally you would want to call this when your sheet is initalizing, and it is the function where you will define sheet actions, computed values, and how the sheet will response to or send character data changes. [visit the initRelay page for a more detailed breakdown.](/docs/components/initrelay/)
Ideally you would want to call this when your sheet is initalizing, and it is the function where you will define sheet actions, computed values, and how the sheet will response to or send character data changes. [visit the initRelay page for a more detailed breakdown.](/beacon-docs/docs/components/initrelay/)

Add the following to your project:
```javascript
Expand All @@ -77,7 +77,7 @@ const dispatch = initRelay({
})
```

`initRelay` returns a dispatch function that allows you to call methods or send changes from the sheet to Roll20. Check out the page on [dispatch](/docs/components/dispatch/) to learn more about the different methods.
`initRelay` returns a dispatch function that allows you to call methods or send changes from the sheet to Roll20. Check out the page on [dispatch](/beacon-docs/docs/components/dispatch/) to learn more about the different methods.

## Step 3: Settings up the Roll20 tabletop sandbox

Expand Down
Loading

0 comments on commit 4a3cee5

Please sign in to comment.