flame

A Flutter based game engine

Stars
6.73K
Forks
599
Open issues
87
Closed issues
545
Last release
7 months ago
Last commit
6 months ago
Watchers
6.73K
Total releases
20
Total commits
2.52K
Open PRs
13
Closed PRs
1.09K
Repo URL
Platform
License
Category
Technology
Offers premium version?
NO
Proprietary?
NO
About

A Flutter-based game engine.

English | 简体中文 | Polski | Русский | Español | 日本語

Documentation

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:

Help

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, so that anyone following the tag can help out.

Features

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:

Sponsors

The Flame Engine's top sponsors:

Want to sponsor Flame? Check our Patreon on the section below, or contact us on Discord.

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
Powered by Flame
Powered by Flame
Contributing

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.

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.

Getting started

A simple tutorial to get started can be found on tutorials.flame-engine.org and examples of most features in Flame can be found on examples.flame-engine.org. To access the code for each example, press the < > button in the top right corner.

Highlighted community tutorials

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

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

Credits

  • 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 in the community.
Alternative Projects

Subscribe to Open Source Businees Newsletter

Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.

We'll never share your email with anyone else.