From 82dfec7ed1e702211982cfc09a7cea15459eb657 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Sat, 11 May 2024 23:28:17 +0200 Subject: [PATCH] Add info about custom animations to animations page --- docs/general/animations.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/general/animations.md b/docs/general/animations.md index b19680f..118b590 100644 --- a/docs/general/animations.md +++ b/docs/general/animations.md @@ -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 : @@ -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 ` / 3 * 2`. ```command <#ANIM:scroll>Text - ``` \ No newline at end of file + ``` + +## 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).