Skip to content

Commit

Permalink
Add info about custom animations to animations page
Browse files Browse the repository at this point in the history
  • Loading branch information
Andre601 authored May 11, 2024
1 parent 683718c commit 82dfec7
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/general/animations.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ icon: material/animation-play

DecentHolograms supports two types of animations: Premade and custom.

Custom animations can be configured in files and the process of doing so is explained in more detail on [this page](configuration/animation.md).

## Format

:
Expand Down Expand Up @@ -70,4 +68,11 @@ There are some premade animations you can use, that will work with any text.
: Scrolls through the provided text. The length is set to `<text length> / 3 * 2`.
```command
<#ANIM:scroll>Text</#ANIM>
```
```

## Custom Animations

Custom animations are made by creating a YAML file inside the plugin's `animations` folder and can be used using the same format as [premade animations](#premade-animations).
However, unlike premade animations can you not use extra options to customize the animation. The only thing you can do is using the `{text}` placeholder inside the animation file to display the text put in-between the `<#ANIM>` tags.

An example animation file is created on the plugin's first startup, but can also be found [on this page](configuration/animation.md).

0 comments on commit 82dfec7

Please sign in to comment.