iPlugin | Add GIF Animations

GIF animation resources can be used to display custom graphics, textures, and interface elements

The Xerr plugin automatically converts GIF animations into dynamic PNG sequences visible in-game.

Create Animation Assets Directory

Create a namespace and basename under the plugins/Xerr/core/assets/image/[namespace]/[basename] directory.

For example, if the namespace is haha and the basename is world, the full path will be plugins/Xerr/core/assets/image/haha/world.

Add Animations

Place .gif animation files into the plugins/Xerr/core/assets/image/haha/world/animation directory.

Create Configuration File

Create a bitmap configuration file config.yml in the plugins/Xerr/core/assets/image/haha/world/ directory.

Example directory structure:

a1.gif

config.yml

Edit Configuration File

In the config.yml file, specify display parameters for each animation, including path, height, width, duration, etc.

Example configuration:

# Animation Configuration
img:  
  # tete:
  #   path: a1
  #   height: 150
  #   width: 64
  #   # Mapped character for text-based display
  #   symbol: 濔
  #   # Vertical ascent (only effective with symbol). Supports negative values.
  #   ascent: 16
  example3:  
    # GIF file path (without extension)
    path: a1  
    height: 16  
    width: 16  
    # Enable GIF animation
    animation: true  
    # Animation duration in seconds
    duration: 5.0

Note

The maximum value for height is 256. For taller displays, split the animation into segments.

Reload Configuration

Resource packs will auto-generate and configurations will reload automatically after saving changes.

Test Animation Configuration

Use the following command to verify animations:

/xerr print img <namespace> <basename> <graphic-id>

Example

/xerr print img ha_ui haha tete

Command supports tab autocompletion.