Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Include information about the Flame DevTools extension in example readme #3288

Merged
merged 3 commits into from
Aug 27, 2024
Merged

docs: Include information about the Flame DevTools extension in example readme #3288

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
155a0c0
Update example app README.md to include information about DevTools ex…
kenzieschmoll Aug 27, 2024
7549548
Add new lines.
kenzieschmoll Aug 27, 2024
64275e5
Fix headings
kenzieschmoll Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions packages/flame/example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,35 @@
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.