From 155a0c051e6fdf67b24d360c261a4e1108ca9f2d Mon Sep 17 00:00:00 2001 From: Kenzie Davisson <43759233+kenzieschmoll@users.noreply.github.com> Date: Tue, 27 Aug 2024 14:49:19 -0700 Subject: [PATCH 1/3] Update example app README.md to include information about DevTools extension --- packages/flame/example/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/packages/flame/example/README.md b/packages/flame/example/README.md index e43515547a0..5933c5f9615 100644 --- a/packages/flame/example/README.md +++ b/packages/flame/example/README.md @@ -3,3 +3,33 @@ A sample Flame game showcasing the basic game structure and the use of PositionComponents. There are a lot more more [examples](../doc/examples) and [docs](../doc). + +# Running the sample app + +Before running the sample app, be sure you have run `melos bootstrap` from the root +of the `flame` repository. + +Then, run the sample app from your IDE or by running `flutter run` from this directory. + +# Try using the Flame developer tools when running this app + +`package:flame` provides developer tooling as a Flutter DevTools extension. When you +are running an app that depends on `package:flame` from Pub, you will see the Flame +DevTools extension automatically in Flutter DevTools and within your Flutter-supported +IDE. + +**However, if you'd like to try the Flame developer tools while running this sample +app, you will need to take one additional step.** Because the sample app depends +on `package:flame` from source (not Pub), the Flame DevTools extension assets will +need to be generated manually. These are normally generated on publish of the `flame` +package, but they are not checked into source control on Github. + +To generate the assets for the Flame DevTools extension, run the following from the +root of the `flame` repository: + +```sh +melos devtools-build +``` + +Now, when you run this sample app, you can open Flutter DevTools in your IDE or in +your browser to try out the Flame developer tools. From 75495489254cd3d48f11c24d27832683df193e83 Mon Sep 17 00:00:00 2001 From: Kenzie Davisson <43759233+kenzieschmoll@users.noreply.github.com> Date: Tue, 27 Aug 2024 14:53:39 -0700 Subject: [PATCH 2/3] Add new lines. --- packages/flame/example/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/flame/example/README.md b/packages/flame/example/README.md index 5933c5f9615..c37b72c2e9f 100644 --- a/packages/flame/example/README.md +++ b/packages/flame/example/README.md @@ -4,6 +4,7 @@ A sample Flame game showcasing the basic game structure and the use of PositionC There are a lot more more [examples](../doc/examples) and [docs](../doc). + # Running the sample app Before running the sample app, be sure you have run `melos bootstrap` from the root @@ -11,6 +12,7 @@ of the `flame` repository. Then, run the sample app from your IDE or by running `flutter run` from this directory. + # Try using the Flame developer tools when running this app `package:flame` provides developer tooling as a Flutter DevTools extension. When you From 64275e56a3a14655b31fc57b289a4367068aff5a Mon Sep 17 00:00:00 2001 From: Kenzie Davisson <43759233+kenzieschmoll@users.noreply.github.com> Date: Tue, 27 Aug 2024 14:56:57 -0700 Subject: [PATCH 3/3] Fix headings --- packages/flame/example/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/flame/example/README.md b/packages/flame/example/README.md index c37b72c2e9f..aa5ea394e80 100644 --- a/packages/flame/example/README.md +++ b/packages/flame/example/README.md @@ -5,7 +5,7 @@ A sample Flame game showcasing the basic game structure and the use of PositionC There are a lot more more [examples](../doc/examples) and [docs](../doc). -# Running the sample app +## Running the sample app Before running the sample app, be sure you have run `melos bootstrap` from the root of the `flame` repository. @@ -13,7 +13,7 @@ of the `flame` repository. Then, run the sample app from your IDE or by running `flutter run` from this directory. -# Try using the Flame developer tools when running this app +## Try using the Flame developer tools when running this app `package:flame` provides developer tooling as a Flutter DevTools extension. When you are running an app that depends on `package:flame` from Pub, you will see the Flame