Pruned the API. Moved RiverpodGameWidget out of the library and into …

…the example definition.

example/lib/main.dart

@@ -1,6 +1,7 @@
 import 'dart:async';
 
 import 'package:flame/components.dart' hide Timer;
+import 'package:flame/game.dart';
 import 'package:flame_riverpod/flame_riverpod.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
@@ -54,8 +55,10 @@ class FlutterCountingComponent extends ConsumerWidget {
   }
 }
 
-class RefExampleGame extends RiverpodAwareFlameGame {
-  RefExampleGame(super.ref);
+class RefExampleGame extends FlameGame with HasComponentRef {
+  RefExampleGame(WidgetRef ref) {
+    this.ref = ComponentRef(ref);
+  }
 
   @override
   onLoad() async {
@@ -65,6 +68,44 @@ class RefExampleGame extends RiverpodAwareFlameGame {
   }
 }
 
+class RiverpodGameWidget extends ConsumerStatefulWidget {
+  const RiverpodGameWidget.readFromProvider({super.key})
+      : uninitialisedGame = null;
+  const RiverpodGameWidget.initialiseWithGame(
+      {super.key, required this.uninitialisedGame});
+
+  final HasComponentRef Function(WidgetRef ref)? uninitialisedGame;
+
+  @override
+  ConsumerState<RiverpodGameWidget> createState() => _RiverpodGameWidgetState();
+}
+
+class _RiverpodGameWidgetState extends ConsumerState<RiverpodGameWidget> {
+  @override
+  void initState() {
+    WidgetsBinding.instance.addPostFrameCallback((timeStamp) {
+      if (widget.uninitialisedGame is HasComponentRef Function(
+          WidgetRef ref)) {
+        ref
+            .read(riverpodAwareGameProvider.notifier)
+            .set(widget.uninitialisedGame!(ref));
+      }
+    });
+    super.initState();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    final game = ref.watch(riverpodAwareGameProvider);
+
+    if (game is! Game) {
+      return Container();
+    }
+
+    return GameWidget(game: game!);
+  }
+}
+
 class RiverpodAwareTextComponent extends PositionComponent
     with RiverpodComponentMixin {
   // ComponentRef is a wrapper around WidgetRef and exposes

lib/flame_riverpod.dart

@@ -5,6 +5,4 @@ library flame_riverpod;
 
 export 'src/component_ref.dart';
 export 'src/game_provider.dart';
-export 'src/riverpod_aware_game.dart';
 export 'src/riverpod_component_mixin.dart';
-export 'src/riverpod_game_widget.dart';

lib/src/component_ref.dart

@@ -1,6 +1,11 @@
+import 'package:flame/game.dart' show Game;
 import 'package:flutter/cupertino.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
 
+mixin HasComponentRef on Game {
+  late ComponentRef ref;
+}
+
 /// A wrapper around [WidgetRef]. Methods that correspond to interactions with
 /// the widget tree, such as [WidgetRef.watch] are not exposed.
 class ComponentRef {

lib/src/game_provider.dart

@@ -1,18 +1,19 @@
-import 'package:flame_riverpod/src/riverpod_aware_game.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
 
-/// Simple provider that returns a [RiverpodAwareGame] instance.
+import 'component_ref.dart';
+
+/// Simple provider that returns a Riverpod-Aware Game instance.
 final riverpodAwareGameProvider =
-    StateNotifierProvider<RiverpodAwareGameNotifier, HasComponentReference?>(
+    StateNotifierProvider<RiverpodAwareGameNotifier, HasComponentRef?>(
         (ref) {
   return RiverpodAwareGameNotifier();
 });
 
 /// Simple [StateNotifier] that holds the current [RiverpodAwareGame] instance.
-class RiverpodAwareGameNotifier extends StateNotifier<HasComponentReference?> {
+class RiverpodAwareGameNotifier extends StateNotifier<HasComponentRef?> {
   RiverpodAwareGameNotifier() : super(null);
 
-  set(HasComponentReference candidate) {
+  set(HasComponentRef candidate) {
     state = candidate;
   }
 }