flame 1.0.0-rc4

A minimalist Flutter game engine, provides a nice set of somewhat independent modules you can choose from.

A minimalistic Flutter game engine.

---

English | 简体中文 | Polski | Русский

---

About 1.0.0

This is a release candidate for version 1.0.0 of Flame. This is not ready for production use and the documentation found here is not completely updated according to the code, also everything here can be changed before the full release.

Use this version to get a preview of how the new Flame version will be and also to give the team feedback about the new structure and/or features.

Checkout the branches develop-v0.x and master-v0.x for the current last 0.x version. However no new updates will be added to v0 except for bugfixes.

The current v1 release is 1.0.0-rc4 on pub. The last stable version so far is 0.28.0. Feel free to choose the one that better suits your need.

---

Documentation

Note that the documentation in the master 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.

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.

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:

[![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

Warning: We are working on bringing Flame to its first stable version, updates on 0.x versions are frozen, except for bugs. If you want to contribute on that version, by sure that it is a bugfix. For contributions for the stable version, your PR must point to the v1.0.0 branch and by sure to talk about your contribution to the team, which is accessible on 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 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.

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.