Flutter纹理打包插件flame_texturepacker的使用

flame_texturepacker

TexturePacker 是一个用于创建高效精灵表的工具。此插件允许您将由 Gdx Texture Packer 和 Code & Web Texture Packer 生成的精灵表导入到您的 Flame 游戏中。

安装

通过 Pub 安装：

flutter pub add flame_texturepacker

使用方法

资源存储

将生成的图集文件和精灵表图像放入 assets/images/ 文件夹，并在 pubspec.yaml 文件中链接这些文件：

 assets:
   - assets/images/atlas_map.atlas
   - assets/images/sprite_sheet1.png

导入插件：

import 'package:flame_texturepacker/flame_texturepacker.dart';

加载 TextureAtlas，传递精灵表图集文件的路径：

final atlas = await atlasFromAssets('atlas_map.atlas');

文件存储

如果您使用的是文件存储，则可以这样获取图集文件：

final documentsPath = (await getApplicationDocumentsDirectory()).path;
final atlas = await atlasFromStorage('$documentsPath/atlas_map.atlas');

可以通过名称获取精灵列表，并用它来生成动画：

final spriteList = atlas.findSpritesByName('robot_walk');

final animation = SpriteAnimation.spriteList(
  spriteList,
  stepTime: 0.1,
  loop: true,
);

还可以通过名称获取单个精灵：

final jumpSprite = atlas.findSpriteByName('robot_jump')!;
final fallSprite = atlas.findSpriteByName('robot_fall')!;
final idleSprite = atlas.findSpriteByName('robot_idle')!;

支持的功能

示例代码

以下是一个完整的示例代码，演示如何使用 flame_texturepacker 插件：

import 'package:flame/components.dart';
import 'package:flame/game.dart';
import 'package:flame_texturepacker/flame_texturepacker.dart';
import 'package:flutter/material.dart';

void main() {
  final myGame = MyGame();
  runApp(
    GameWidget(
      game: myGame,
    ),
  );
}

class MyGame extends FlameGame {
  @override
  Future<void> onLoad() async {
    super.onLoad();

    // Load the atlasMap.
    final atlas = await atlasFromAssets('atlas_map.atlas');

    // Get a list of sprites ordered by their index
    final walkingSprites = atlas.findSpritesByName('robot_walk');

    // Create animation with the list of sprites
    final walkingAnimation = SpriteAnimation.spriteList(
      walkingSprites,
      stepTime: 0.1,
    );

    // Get individual sprites by name
    final jumpSprite = atlas.findSpriteByName('robot_jump')!;
    final fallSprite = atlas.findSpriteByName('robot_fall')!;
    final idleSprite = atlas.findSpriteByName('robot_idle')!;

    // Get the list of all sprites in the sprite sheet
    final allSprites = atlas.sprites; // ignore: unused_local_variable

    add(
      SpriteComponent(
        sprite: jumpSprite,
        position: Vector2(200, 100),
        size: Vector2(72, 96),
      ),
    );

    add(
      SpriteComponent(
        sprite: fallSprite,
        position: Vector2(300, 100),
        size: Vector2(72, 96),
      ),
    );

    add(
      SpriteComponent(
        sprite: idleSprite,
        position: Vector2(400, 100),
        size: Vector2(72, 96),
      ),
    );

    add(
      SpriteAnimationComponent(
        animation: walkingAnimation,
        position: Vector2(300, 200),
        size: Vector2(72, 96),
      ),
    );
  }
}

这个示例展示了如何加载图集、创建动画以及添加单个精灵到游戏中。希望这能帮助您更好地理解和使用 flame_texturepacker 插件。