README.md

Warning This package is deprecated and no longer supported. Please use flame_rive instead.

Adds support for Flare animations to your Flame games.

---

flame_flare

Integrate awesome Flare animations to your Flame game.

⚠️ Flare is deprecated and no longer supported. Please consider upgrading to Rive.

Install

Add flame_flare as a dependency in your pubspec.yaml file (what?).

Import the package:

import 'package:flame_flare/flame_flare.dart';

Usage

This lib exposes a set of tools to integrate a flare animation into a flame game, they are:

• FlareActorAnimation: A simple animation object that wraps a FlareActorRenderBox.
• FlareActorComponent: A Flame's PositionComponent sub class that receives and render a FlareActorAnimation.
• FlareParticle: A Flame's Particle sub class that receives and renders a FlareActorAnimation as a particle.

Simple usage

class MyAnimationController extends FlareControls {
  void playSomeAnimation() {
    play('Some animation');
  }
}

class MyAnimationComponent extends FlareActorComponent {
  final MyAnimationController animationController;

  MyAnimationComponent(this.animationController)
      : super(
        FlareActorAnimation(
          'assets/my_animation.flr',
          controller: animationController,
          fit: BoxFit.contain,
          alignment: Alignment.bottomCenter,
          size: Vector2(306, 500),
        ),
      );
}

See the example app for a slightly more complex usage.

Support

The simplest way to show us your support is by giving the project a star.

You can also support us by becoming a patron on Patreon:

Or by making a single donation by buying us a coffee: