flame-engine/flame

A Flutter-based game engine.

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:

• The official Flame site.
• Examples of most features which can be tried out from your browser.
  • To access the code for each example, press the < > button in the top right corner.
• Tutorials - Some simple tutorials to get started.
• API Reference - The generated dartdoc API reference.
• awesome-flame - A curated list of Tutorials, Games, Libraries and Articles.

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.

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:

• A game loop.
• A component/object system (FCS).
• Effects and particles.
• Collision detection.
• Gesture and input handling.
• Images, animations, sprites, and sprite sheets.
• General utilities to make development easier.

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:

• flame_3d_component for flutter_scene: Add 3D components to the component tree.
• flame_audio for AudioPlayers: Play multiple audio files simultaneously.
• flame_behavior_tree for behavior_tree: Drive game logic with behavior trees.
• flame_bloc for Bloc: A predictable state management library.
• flame_fire_atlas for FireAtlas: Create texture atlases for games.
• flame_forge2d for Forge2D: A Box2D physics engine.
• flame_gamepads for gamepads: Support gamepad input in your game.
• flame_isolate - Makes it easy to use Flutter Isolates in a Flame game.
• flame_kenney_xml for Kenney: Load Kenney XML sprite sheets.
• flame_lottie - Support for Lottie animation in Flame.
• flame_markdown for markdown: Render Markdown with Flame's text pipeline.
• flame_network_assets - Helpers to load game assets from network.
• flame_noise for fast_noise: Noise generation and noise based effects.
• flame_rive for Rive: Create interactive animations.
• flame_riverpod for Riverpod: A reactive caching and data-binding framework.
• flame_spine for Spine: Use Spine skeletal animations.
• flame_sprite_fusion for Sprite Fusion: Load tile maps exported from Sprite Fusion.
• flame_svg for flutter_svg: Draw SVG files in Flutter.
• flame_texturepacker for TexturePacker: Load and use sprite sheets generated with TexturePacker.
• flame_tiled for Tiled: 2D tile map level editor.
• flame_typled for Typled: Load Typled sprite atlases.

Other official packages that extend Flame:

• flame_3d - Experimental 3D rendering on top of Flame.
• flame_behaviors - Apply separation of concerns to game logic in the form of Entities and Behaviors.
• flame_console - An in-game console to debug and interact with your game.
• flame_splash_screen - Add the "Powered by Flame" splash screen.
• flame_steering_behaviors - Steering algorithms built on top of flame_behaviors.

Tooling:

• flame_cli - Inspect and control running Flame games from the terminal.
• flame_lint - Our set of linting (analysis_options.yaml) rules.
• flame_test - Helpers for testing Flame games.

The Flame Engine's top sponsors:

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.

The simplest way to show us your support is by giving the project a 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](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)

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.

• The Blue Fire team, who are continuously working on maintaining and improving Flame and its ecosystem.
• All the friendly contributors and people who are helping out in the community.