Flutter Steamworks集成插件flame_steamworks的使用

Flutter Steamworks集成插件flame_steamworks的使用

flame_steamworks简介

flame_steamworks 是一个允许在Flutter中通过Steam API开发游戏的包。它结合了 steamworks 和 flame，使得开发者可以轻松地将Steam功能集成到Flutter游戏中。

注意事项

⚠️ 目前由于Dart SDK的一个问题，此包仅支持Windows平台。不过，你可以通过使用 steamworks_gen 生成特定平台的API来绕过这个问题。

功能

该库的目标是尽可能全面地覆盖Steam API的功能。Steam API的功能可以分为以下三类：

• 初始化和通用API
• 异步回调
• 异步调用结果

你可以从Steam官方文档中获取这些功能的详细信息。

要求

你需要 steam_api.dll 和 steam_api.lib 文件才能使用此包。你可以通过登录Steam合作伙伴页面下载SteamWorks SDK，或者直接使用示例项目中的文件。如果你选择从Steam下载，这些文件位于 redistributable_bin 文件夹下。

使用方法

Flame Game实例

首先，我们需要创建一个游戏实例。以下是创建游戏实例的代码：

import 'package:flame/game.dart';
import 'package:flame/keyboard.dart';
import 'package:flame_steamworks/flame_steamworks.dart';

class GameInstance extends FlameGame with KeyboardEvents, HasSteamClient {
  GameInstance() {
    init();  // 初始化Steam API
  }
}

注册回调

HasSteamClient 混入提供了一个简单的API来注册回调。你可以在代码的任何地方注册回调。例如，注册未读聊天消息更改的回调：

class GameInstance extends FlameGame with KeyboardEvents, HasSteamClient {
  GameInstance() {
    init();
    registerCallback<UnreadChatMessagesChanged>((data) {
      // 处理未读聊天消息更改
    });
  }
}

注册调用结果

HasSteamClient 混入还提供了一个简单的API来注册调用结果。调用结果与回调不同，在订阅调用结果之前，你需要先发起请求并订阅该请求的结果。例如，当按下空格键时，请求用户统计数据并订阅其结果：

class GameInstance extends FlameGame with KeyboardEvents, HasSteamClient {
  [@override](/user/override)
  KeyEventResult onKeyEvent(
    RawKeyEvent event,
    Set<LogicalKeyboardKey> keysPressed,
  ) {
    bool isKeyDown = event is RawKeyDownEvent;
    bool isSpace = keysPressed.contains(LogicalKeyboardKey.space);

    if (isSpace && isKeyDown) {
      CSteamId steamId = steamClient.steamUser.getSteamId();
      SteamApiCall callId = steamClient.steamUserStats.requestUserStats(steamId);

      registerCallResult<UserStatsReceived>(
        callId,
        (ptrUserStatus, hasFailed) {
          print("User stats received");
          print("GameId: ${ptrUserStatus.gameId}");
          print("SteamIdUser: ${ptrUserStatus.steamIdUser}");
        },
      );

      return KeyEventResult.handled;
    }
    return KeyEventResult.ignored;
  }
}

已发布的游戏

以下是使用此包在Steam上发布的部分游戏：

• Omnichess

完整示例Demo

以下是一个完整的示例Demo，展示了如何使用 flame_steamworks 创建一个简单的Flutter游戏，并集成Steam API。

main.dart

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

void main() {
  runApp(GameWidget(game: GameInstance()));
}

game.dart

import 'package:flame/game.dart';
import 'package:flame/keyboard.dart';
import 'package:flame_steamworks/flame_steamworks.dart';

class GameInstance extends FlameGame with KeyboardEvents, HasSteamClient {
  GameInstance() {
    init();  // 初始化Steam API
  }

  [@override](/user/override)
  KeyEventResult onKeyEvent(
    RawKeyEvent event,
    Set<LogicalKeyboardKey> keysPressed,
  ) {
    bool isKeyDown = event is RawKeyDownEvent;
    bool isSpace = keysPressed.contains(LogicalKeyboardKey.space);

    if (isSpace && isKeyDown) {
      CSteamId steamId = steamClient.steamUser.getSteamId();
      SteamApiCall callId = steamClient.steamUserStats.requestUserStats(steamId);

      registerCallResult<UserStatsReceived>(
        callId,
        (ptrUserStatus, hasFailed) {
          print("User stats received");
          print("GameId: ${ptrUserStatus.gameId}");
          print("SteamIdUser: ${ptrUserStatus.steamIdUser}");
        },
      );

      return KeyEventResult.handled;
    }
    return KeyEventResult.ignored;
  }

  [@override](/user/override)
  void onLoad() {
    super.onLoad();
    // 注册未读聊天消息更改的回调
    registerCallback<UnreadChatMessagesChanged>((data) {
      print("Unread chat messages changed: ${data.unreadCount}");
    });
  }
}