obitodarky/flame

A minimalist Flutter game engine

English | 简体中文 | Polski

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:

Or by making a single donation by buying us 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](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

• Create a Mobile Game with Flutter and Flame – Beginner Tutorial
• 2D Casual Mobile Game Tutorial – Step by Step with Flame and Flutter (Part 1 of 5)
• Game Graphics and Animation Tutorial – Step by Step with Flame and Flutter (Part 2 of 5)
• Views and Dialog Boxes Tutorial – Step by Step with Flame and Flutter (Part 3 of 5)
• Scoring, Storage, and Sound Tutorial – Step by Step with Flame and Flutter (Part 4 of 5)
• Game Finishing and Packaging Tutorial – Step by Step with Flame and Flutter (Part 5 of 5)

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.