Pub Test Discord

English | 简体中文

A minimalistic Flutter game engine.

Help

We have a Flame help channel on Fireslime's Discord, join it here.

We also have a FAQ, so please search for your question there first.

Goals

The goal of this project is to provide a complete set of out-of-the-way solutions for the common problems every game developed in Flutter will share.

Currently it provides you with:

  • a game loop
  • a component/object system
  • bundles a physics engine (box2d)
  • audio support
  • effects and particles
  • gesture and input support
  • images, sprites and sprite sheets
  • basic Rive support
  • and a few other utilities to make development easier

You can use whichever ones you want, as they are all somewhat independent.

Support

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

You can also support us by becoming a patron on Patreon:

Patreon

Or by making a single donation by buying us a coffee:

Buy Me A Coffee

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-orange.svg)](https://flame-engine.org)
[![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5-orange.svg?style=flat-square)](https://flame-engine.org)
[![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5-orange.svg?style=for-the-badge)](https://flame-engine.org)

Contributing

Any help is appreciated! Comments, suggestions, issues, PRs.

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 be sure to create it from the develop branch and follow the checklist which will appear when you open it.

Getting started

Check out this great series of articles/tutorials written by Alekhin

We also offer a curated list of Games, Libraries and Articles over at awesome-flame.

Note that some of the articles might be slightly outdated, but they are still useful.

Documentation

The complete documentation can be found here.

Many examples of different features can be found here and a good starting example can be found here.

The official site for Flame, which also contains the documentation can be found here.

Credits

  • Fireslime, the team responsible for maintaining Flame.
  • All the friendly contributors and people who are helping in the community.
  • Luanpotter's (the Flame founder) audioplayers lib, which in turn is forked from rxlabz's.
  • The Dart port of Box2D.

Libraries

accelerated_particle
anchor
animation
animation_component
animation_particle
animation_widget
assets_cache
audio_pool
base_game
bgm
box2d_component
box2d_game
circle_particle
component
component_particle
composed_component
composed_particle
computed_particle
contact_callbacks
curved_particle
effects
embedded_game_widget
flame
flame_audio
flare_animation
flare_component
flare_particle
game
game
game_loop
game_render_box
gestures
has_game_ref
image_particle
images
keyboard
move_effect
moving_particle
nine_tile_box
nine_tile_box
nine_tile_box_component
paint_particle
palette
parallax_component
particle
particle_component
position
profiler
resizable
rotate_effect
rotating_particle
scale_effect
scaled_particle
sequence_effect
single_child_particle
sprite
sprite_batch
sprite_batch_component
sprite_button
sprite_particle
sprite_widget
spritesheet
svg
tapable
text_box_component
text_component
text_config
tiled_component
time
timer_component
translated_particle
util
viewport
widget_builder