This file contains Frequently Asked Questions and their answers. Please feel free to make PRs to amend this file with new questions.
Flame only provides a thin wrapper over the audioplayers library. Please make extra sure the problem you are having is with Flame. If you have a low-level or hardware related audio problem, probably it's something related to audioplayers, so please feel free to head to that repository to search your problem or open your issue. If you indeed have a problem with the Flame wrap around audioplayers, then open an issue here.
In order to draw over the notch, you must add the following line to your styles.xml file:
<item name="android:windowLayoutInDisplayCutoutMode">shortEdges</item>For more details, please check this PR from impulse.
Since Flutter 1.10.x, when using some of Flame.util methods, like the methods for enforcing the device orientation, before the runApp statement, the following exception can happen:
E/flutter (16523): [ERROR:flutter/lib/ui/ui_dart_state.cc(151)] Unhandled Exception: ServicesBinding.defaultBinaryMessenger was accessed before the binding was initialized.
E/flutter (16523): If you're running an application and need to access the binary messenger before `runApp()` has been called (for example, during plugin initialization), then you need to explicitly call the `WidgetsFlutterBinding.ensureInitialized()` first.
E/flutter (16523): If you're running a test, you can call the `TestWidgetsFlutterBinding.ensureInitialized()` as the first line in your test's `main()` method to initialize the binding.
To prevent that exception from happening, add the following line before calling those utilities methods:
WidgetsFlutterBinding.ensureInitialized();
We have a few examples! The simplest of all is in the root example folder. This folder must be called example and contain a single project, so it's a very simple generic example game.
However there is an examples folder inside the docs that contains many more examples. Most newer features we are adding we are trying to add a specific example for that. Those are directed to specific features.
If you want a more full-fledged game, please check BGUG, FireSlime's open source fast paced side-scrolling platformer. It is mostly up-to-date with Flame and uses a good chunck of the featues offered by the engine. Other examples game are feroult's Haunt, which is outdated but showcases Box2D,renancaraujo's port of the trex chrome game in Flame, and also Bob Box, which is easy to grasp and a good display of our core features.
Game is the most barebones interface that Flame exposes. If you crete a Game, you will need to implement a lot of stuff. Flame will hook you up on the game loop, so you will get to implement render and update yourself. From scratch. If you wanna use the component system, you can, but you don't need to. You do everything yourself.
BaseGame extends Game and adds lots of functionality on top of that. Just drop your components, it works! They are rendered, updated, resized, automatically. You might still want to override some of BaseGame's methods to add custom functionality, but you will probably be calling the super method to let BaseGame do its work.
If you are using BaseGame, you have a camera attribute that allows you to off-set all non-HUD components by a certain amount. You can add custom logic to your update method to have the camera position be tracked based on the player position, for example, so the player can be always on the center or on the bottom.
For a more in-depth tutorial on how the camera works (in general & in Flame) and how to use it, check erickzanardo's excellent tutorial, published via FireSlime.
You can always use all the Widgets and features that Flutter already provide for that, but Flame wraps gesture detector callbacks on its base Game class so it can ben a little easier to handle those events, you can find more about it on the input documentation page:
https://flame-engine.org/docs/input.md
Didn't find what you needed here? Please head to FireSlime's Discord channel where the community might help you with more questions.