Back to Flame

flame_devtools

packages/flame_devtools/README.md

1.37.02.1 KB
Original Source
<!-- markdownlint-disable MD013 --> <p align="center"> <a href="https://flame-engine.org"> </a> </p> <p align="center"> A Flutter-based game engine. </p> <p align="center"> <a title="Pub" href="https://pub.dev/packages/flame"></a> <a title="Test" href="https://github.com/flame-engine/flame/actions?query=workflow%3Acicd+branch%3Amain"></a> <a title="Discord" href="https://discord.gg/pxrBmy4"></a> <a title="Melos" href="https://github.com/invertase/melos"></a> </p>
<!-- markdownlint-enable MD013 -->

flame_devtools

A DevTools extension for Flame games. To use it you just have to run your Flame game in debug mode and open the DevTools in your browser, and it should ask you if you want to add the Flame DevTools extension as a separate tab.

Development

To run it locally, make sure to run melos devtools-build to build the extension so that it can be loaded in the browser (the build files are not committed to the repository).

After you have done any changes, make sure to run melos devtools-build to build and copy the changes to packages/flame/extension/build.

To develop things from the Flame side, create a new DevToolsConnector which registers the new extension end points so that you can communicate with Flame from the devtools extension. Don't forget to add the new connector to the list of connectors in the DevToolsService class.

If you want to run with the devtools extension with the simulated mode for faster development, you can use melos devtools-simulator to start the simulated environment and run the devtools extension in the browser. Remember that you have to manually enter the Dart VM Service Connection URI in the simulated devtools environment.