flame README

The project's README from github.com/flame-engine/flame. As one markdown file: README.md.

Flutter favorite

flame

A Flutter-based game engine.


Documentation

The full documentation for Flame can be found on docs.flame-engine.org.

To change the version of the documentation, use the version selector noted with version: in the top of the page.

Note: The documentation that resides in the main branch is newer than the released documentation on the docs website.

Other useful links:

Help

There is a Flame community on Blue Fire's Discord server where you can ask any of your Flame related questions.

If you are more comfortable with StackOverflow, you can also create a question there. Add the Flame tag, to make sure that anyone following the tag can help out.

Features

The goal of the Flame Engine is to provide a complete set of out-of-the-way solutions for common problems that games developed with Flutter might share.

Some of the key features provided are:

On top of those features, you can augment Flame with bridge packages. Through these libraries, you will be able to access bindings to other packages, including custom Flame components and helpers, in order to make integrations seamless.

Flame officially provides bridge libraries to the following packages:

Sponsors

The Flame Engine's top sponsors:

Invertase

Do you or your company want to sponsor Flame? Check out our OpenCollective page, which is also mentioned in the section below, or contact us on Discord.

Support

The simplest way to show us your support is by giving the project a star! :star:

You can also support us monetarily by donating through OpenCollective:

Through GitHub Sponsors:

Or by becoming a patron on Patreon:

You can also show on your repository that your game is made with Flame by using one of the following badges:

Powered by Flame Powered by Flame Powered by Flame

[![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5-272727.svg)](https://flame-engine.org)
[![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5-272727.svg?style=flat-square)](https://flame-engine.org)
[![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5-272727.svg?style=for-the-badge)](https://flame-engine.org)

Contributing

Have you found a bug or have a suggestion of how to enhance Flame? Open an issue and we will take a look at it as soon as possible.

Do you want to contribute with a PR? PRs are always welcome, just make sure to create it from the correct branch (main) and follow the checklist which will appear when you open the PR.

Also, before you start, make sure to read our Contributing Guide.

For bigger changes, or if in doubt, make sure to talk about your contribution to the team. Either via an issue, GitHub discussion, or reach out to the team either using the Discord server.

Credits

flame (flame-engine/flame)

physics
Searching Database…

10.8K ·GitHub
What is this?Flame is a game engine built on top of Flutter, giving you a game loop, component system, collision detection, input handling, and sprite/animation tools so you can build 2D games using Dart and Flutter.
Is it a standalone engine or does it run inside Flutter apps?It's a library/engine layered on top of Flutter, not a standalone runtime - you add it to a Flutter project and build your game inside Flutter's widget and rendering pipeline.
How do I add Flame to a project?Add it as a package dependency to a Flutter project and follow the tutorials on the docs site to get a basic game running.
Do I need Flutter already set up first?Yes - Flame is built on Flutter, so you need a working Flutter/Dart development environment before using it.
What if I need audio, physics, or gamepad support?Those aren't built into core Flame - you add official bridge packages like flame_audio, flame_forge2d, or flame_gamepads for those features.
Which platforms can my Flame game ship to?Since it rides on Flutter, games built with Flame can target Android, iOS, web, Windows, macOS, and Linux.
What does the component system (FCS) give me?FCS is Flame's component/object system for structuring game entities, letting you compose behavior like position, size, and effects onto game objects without writing a custom architecture from scratch.
Can I try examples without installing anything?Yes, the official Flame site hosts browser-playable examples for most features, and you can view the source code for each one directly from there.
Is there a curated list of community tutorials and games?Yes, the awesome-flame list curates tutorials, games, libraries, and articles built with or for Flame.
What are similar projects?phaser, flutter_scene, ebiten, libgdx, cocos2d-x, engine, godot, MonoGame
Size
73.1 MB
Stars
10.8K
Age
8y
Commits · 90 Days