SDK Overview

flutter pub add gameframework

flutter pub add gameframework_unity

flutter pub add gameframework_unreal

import 'package:flutter/material.dart';
import 'package:gameframework/gameframework.dart';
import 'package:gameframework_unity/gameframework_unity.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  UnityEnginePlugin.initialize();
  runApp(MyApp());
}

class GameScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: GameWidget(
        engineType: GameEngineType.unity,
        config: GameEngineConfig(
          runImmediately: true,
        ),
        onEngineCreated: (controller) {
          controller.sendMessage('GameManager', 'Start', 'level1');
        },
        onMessage: (message) {
          print('From engine: ${message.data}');
        },
      ),
    );
  }
}

graph TB
    subgraph FlutterApp[Flutter Application]
        GameWidget[GameWidget]
        Controller[GameEngineController]
    end
    
    subgraph CoreSDK[gameframework]
        Registry[GameEngineRegistry]
        Platform[Platform Interface]
    end
    
    subgraph Plugins[Engine Plugins]
        UnityPlugin[gameframework_unity]
        UnrealPlugin[gameframework_unreal]
    end
    
    subgraph Native[Native Bridges]
        UnityNative[Unity Native]
        UnrealNative[Unreal Native]
    end
    
    GameWidget --> Controller
    Controller --> Registry
    Registry --> Platform
    Platform --> UnityPlugin
    Platform --> UnrealPlugin
    UnityPlugin --> UnityNative
    UnrealPlugin --> UnrealNative

GameWidget(
  engineType: GameEngineType.unity,
  config: GameEngineConfig(
    runImmediately: true,
    fullscreen: false,
  ),
  onEngineCreated: (controller) {},
  onMessage: (message) {},
)

// Send messages
controller.sendMessage('Target', 'Method', 'Data');

// Lifecycle
controller.pause();
controller.resume();
controller.dispose();