A minimalistic Flutter game engine.
English | 简体中文 | Polski | Русский
About 1.0.0
Our goal is to release v1 soon. We are periodically launching RCs (release candidates) as we evolve the code, and we are already quite happy with where we are (but there might still be further changes).
Please use this version to get a preview of the new Flame version and also to give the team feedback about the new structure and/or features.
The main branch is the bleeding edge of the v1 migration. The master-v0.x branch is the latest
v0 release (where we are still merging some patches and crucial fixes).
The current v1 release is
Documentation
Note that the documentation in the main branch of this repo is newer than the latest released version.
Here you can find the documentation for different versions:
- Latest stable version: Flame-engine website
- Latest stable version: GitHub docs
- Latest v1.0.0 version: GitHub docs
The complete documentation can be found here.
We provide many examples of different features which can be tried out from your browser here. You can also check the examples source code here.
The official site for Flame, which also contains the documentation can be found here.
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
- a physics engine (Forge2D, available through flame_forge2d)
- 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:
[](https://flame-engine.org)
[](https://flame-engine.org)
[](https://flame-engine.org)
Contributing
Warning: We are working on bringing Flame to its first stable version, updates on 0.x versions
are frozen, except for crucial bug fixes. If you want to contribute to that version, please be
mindful of that, and use the master-v0.x branch. For contributions for v1, your PR must point to
the main branch. If in doubt, make sure to talk about your contribution to the team, either via an
issue or Discord.
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 orrect branch (see above) and follow the checklist which will appear when you open the PR.
Getting started
A collection of guides can be found here. Note that these tutorials are based on the main branch. To make sure you are looking at the tutorials that work with your current version, select the correct version tag.
This collection of guides is a work in progress, more guides and tutorials will be added soon.
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.
Credits
- The Flame Engine team, who are continuously working on maintaining and improving Flame.
- All the friendly contributors and people who are helping in the community.