2023-08-31 13:46:10 +02:00
|
|
|
<!-- markdownlint-disable MD013 -->
|
|
|
|
|
<p align="right">
|
|
|
|
|
<a href="https://docs.flutter.dev/packages-and-plugins/favorites">
|
|
|
|
|
<img alt="Flutter favorite" width="100px" src="https://github.com/flame-engine/flame/assets/744771/aa5d5acd-e82b-48bc-ad81-2ab146d72ecb">
|
|
|
|
|
</a>
|
|
|
|
|
</p>
|
|
|
|
|
|
2022-09-19 23:17:50 +02:00
|
|
|
<!-- markdownlint-disable MD013 -->
|
2020-12-08 23:42:01 +00:00
|
|
|
<p align="center">
|
|
|
|
|
<a href="https://flame-engine.org">
|
|
|
|
|
<img alt="flame" width="200px" src="https://user-images.githubusercontent.com/6718144/101553774-3bc7b000-39ad-11eb-8a6a-de2daa31bd64.png">
|
|
|
|
|
</a>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
2021-12-08 18:34:46 +01:00
|
|
|
A Flutter-based game engine.
|
2020-12-08 23:42:01 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
2023-02-14 16:36:21 +01:00
|
|
|
<a title="Pub" href="https://pub.dev/packages/flame"><img src="https://img.shields.io/pub/v/flame.svg?style=popout"/></a>
|
2025-10-02 16:01:57 -05:00
|
|
|
<a title="Shorebird CI" href="https://console.shorebird.dev/ci"><img src="https://api.shorebird.dev/api/v1/github/flame-engine/flame/badge.svg"/></a>
|
2025-03-04 08:45:57 +01:00
|
|
|
<a title="Test" href="https://github.com/flame-engine/flame/actions?query=workflow%3Acicd+branch%3Amain"><img src="https://github.com/flame-engine/flame/actions/workflows/cicd.yml/badge.svg?branch=main&event=push"/></a>
|
2023-02-14 16:36:21 +01:00
|
|
|
<a title="Discord" href="https://discord.gg/pxrBmy4"><img src="https://img.shields.io/discord/509714518008528896.svg"/></a>
|
2021-12-16 07:16:34 -08:00
|
|
|
<a title="Melos" href="https://github.com/invertase/melos"><img src="https://img.shields.io/badge/maintained%20with-melos-f700ff.svg"/></a>
|
2020-12-08 23:42:01 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
---
|
2022-09-19 23:17:50 +02:00
|
|
|
<!-- markdownlint-enable MD013 -->
|
2018-05-26 22:47:51 -03:00
|
|
|
|
2022-09-19 23:17:50 +02:00
|
|
|
<!-- markdownlint-disable-next-line MD002 -->
|
2020-11-28 14:39:22 +01:00
|
|
|
## Documentation
|
|
|
|
|
|
2021-12-16 15:59:21 -05:00
|
|
|
The full documentation for Flame can be found on
|
2021-12-08 18:34:46 +01:00
|
|
|
[docs.flame-engine.org](https://docs.flame-engine.org/).
|
2020-11-28 14:39:22 +01:00
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
To change the version of the documentation, use the version selector noted with `version:` in the
|
|
|
|
|
top of the page.
|
2020-11-28 14:39:22 +01:00
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
**Note**: The documentation that resides in the main branch is newer than the released documentation
|
|
|
|
|
on the docs website.
|
2020-11-28 14:39:22 +01:00
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
Other useful links:
|
2022-09-19 23:17:50 +02:00
|
|
|
|
|
|
|
|
- [The official Flame site](https://flame-engine.org/).
|
2022-09-19 23:52:53 +02:00
|
|
|
- [Examples](https://examples.flame-engine.org/) of most features which can be tried out from your
|
|
|
|
|
browser.
|
|
|
|
|
- To access the code for each example, press the `< >` button in the top right corner.
|
2023-03-21 08:14:11 +01:00
|
|
|
- [Tutorials](https://docs.flame-engine.org/main/tutorials/tutorials.html) - Some simple tutorials
|
|
|
|
|
to get started.
|
2022-09-19 23:52:53 +02:00
|
|
|
- [API Reference](https://pub.dev/documentation/flame/latest/) - The generated dartdoc API
|
|
|
|
|
reference.
|
|
|
|
|
- [awesome-flame](https://github.com/flame-engine/awesome-flame) - A curated list of Tutorials,
|
|
|
|
|
Games, Libraries and Articles.
|
2020-11-28 14:39:22 +01:00
|
|
|
|
|
|
|
|
|
2019-01-02 12:52:45 -02:00
|
|
|
## Help
|
|
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
There is a Flame community on [Blue Fire's Discord server](https://discord.gg/5unKpdQD78) 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
|
2022-09-19 23:52:53 +02:00
|
|
|
[Flame tag](https://stackoverflow.com/questions/tagged/flame), to make sure that anyone following
|
|
|
|
|
the tag can help out.
|
2021-12-08 18:34:46 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
|
2021-12-16 15:59:21 -05:00
|
|
|
Some of the key features provided are:
|
2021-12-08 18:34:46 +01:00
|
|
|
|
2022-09-19 23:17:50 +02:00
|
|
|
- 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.
|
2021-12-08 18:34:46 +01:00
|
|
|
|
|
|
|
|
On top of those features, you can augment Flame with bridge packages. Through these libraries,
|
2021-12-16 15:59:21 -05:00
|
|
|
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:
|
2021-12-08 18:34:46 +01:00
|
|
|
|
2023-09-15 16:57:56 -03:00
|
|
|
- [flame_audio][flame_audio] for [AudioPlayers][audioplayers]: Play multiple audio files
|
|
|
|
|
simultaneously.
|
|
|
|
|
- [flame_bloc][flame_bloc] for [Bloc][bloc]: A predictable state management library.
|
|
|
|
|
- [flame_fire_atlas][flame_fire_atlas] for [FireAtlas][fireatlas]: Create texture atlases for games.
|
|
|
|
|
- [flame_forge2d][flame_forge2d] for [Forge2D][forge2d]: A Box2D physics engine.
|
2026-03-26 22:56:22 +01:00
|
|
|
- [flame_gamepads][flame_gamepads] - Support gamepad input in your game (bridge package for [gamepads][gamepads])
|
2023-09-15 16:57:56 -03:00
|
|
|
- [flame_isolate][flame_isolate] - Makes it easy to use [Flutter Isolates][flutter_isolates] in
|
|
|
|
|
a Flame game.
|
|
|
|
|
- [flame_lint][flame_lint] - Our set of linting (`analysis_options.yaml`) rules.
|
|
|
|
|
- [flame_lottie][flame_lottie] - Support for [Lottie][lottie] animation in Flame.
|
|
|
|
|
- [flame_network_assets][flame_network_assets] - Helpers to load game assets from
|
|
|
|
|
network.
|
|
|
|
|
- [flame_oxygen][flame_oxygen] for [Oxygen][oxygen]: A lightweight Entity Component System (ECS)
|
|
|
|
|
framework.
|
|
|
|
|
- [flame_rive][flame_rive] for [Rive][rive]: Create interactive animations.
|
|
|
|
|
- [flame_svg][flame_svg] for [flutter_svg][flutter_svg]: Draw SVG files in Flutter.
|
2025-12-17 19:02:54 +01:00
|
|
|
- [flame_texturepacker][flame_texturepacker]: Load and use sprite sheets generated with [TexturePacker][texturepacker]
|
2023-09-15 16:57:56 -03:00
|
|
|
- [flame_tiled][flame_tiled] for [Tiled][tiled]: 2D tile map level editor.
|
2020-05-30 00:09:08 +02:00
|
|
|
|
2017-10-22 01:33:20 -02:00
|
|
|
|
2021-10-20 09:53:26 -03:00
|
|
|
## Sponsors
|
|
|
|
|
|
|
|
|
|
The Flame Engine's top sponsors:
|
|
|
|
|
|
2025-09-10 10:04:10 -03:00
|
|
|
[](https://invertase.io/)
|
2021-10-20 09:53:26 -03:00
|
|
|
|
2023-03-21 08:14:11 +01:00
|
|
|
Do you or your company want to sponsor Flame?
|
|
|
|
|
Check out our [OpenCollective page](https://opencollective.com/blue-fire), which is also mentioned
|
|
|
|
|
in the section below, or contact us on [Discord](https://discord.gg/pxrBmy4).
|
2021-12-08 18:34:46 +01:00
|
|
|
|
2021-10-20 09:53:26 -03:00
|
|
|
|
2019-05-27 09:49:21 -03:00
|
|
|
## Support
|
2019-02-06 15:43:55 -02:00
|
|
|
|
2023-04-02 12:39:56 -04:00
|
|
|
The simplest way to show us your support is by giving the project a star! :star:
|
2020-05-29 23:45:33 +02:00
|
|
|
|
2023-03-21 08:14:11 +01:00
|
|
|
You can also support us monetarily by donating through OpenCollective:
|
2019-02-19 21:43:09 -03:00
|
|
|
|
2023-03-21 08:14:11 +01:00
|
|
|
<a href="https://opencollective.com/blue-fire/donate" target="_blank">
|
2023-04-02 12:39:56 -04:00
|
|
|
<img src="https://opencollective.com/blue-fire/donate/button@2x.png?color=blue" width=200 />
|
2023-03-21 08:14:11 +01:00
|
|
|
</a>
|
|
|
|
|
|
2023-04-02 12:39:56 -04:00
|
|
|
Through GitHub Sponsors:
|
2019-02-19 21:43:09 -03:00
|
|
|
|
2023-04-02 12:39:56 -04:00
|
|
|
<a href="https://github.com/sponsors/bluefireteam" target="_blank">
|
|
|
|
|
<img
|
|
|
|
|
src="https://img.shields.io/badge/Github%20Sponsor-blue?style=for-the-badge&logo=github&logoColor=white"
|
|
|
|
|
width=200
|
|
|
|
|
/>
|
|
|
|
|
</a>
|
2019-07-02 15:44:26 -03:00
|
|
|
|
2023-03-21 08:14:11 +01:00
|
|
|
Or by becoming a patron on Patreon:
|
|
|
|
|
|
2023-04-02 12:39:56 -04:00
|
|
|
<a href="https://www.patreon.com/bluefireoss" target="_blank">
|
|
|
|
|
<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" width=200 />
|
|
|
|
|
</a>
|
2019-07-02 15:44:26 -03:00
|
|
|
|
2021-03-31 00:02:39 +02:00
|
|
|
You can also show on your repository that your game is made with Flame by using one of the following
|
|
|
|
|
badges:
|
2019-05-27 09:49:21 -03:00
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
[](https://flame-engine.org)
|
|
|
|
|
[](https://flame-engine.org)
|
|
|
|
|
[](https://flame-engine.org)
|
2019-05-27 09:49:21 -03:00
|
|
|
|
2022-09-19 23:17:50 +02:00
|
|
|
```txt
|
2025-08-07 04:47:52 +02:00
|
|
|
[](https://flame-engine.org)
|
|
|
|
|
[](https://flame-engine.org)
|
|
|
|
|
[](https://flame-engine.org)
|
2019-05-27 09:49:21 -03:00
|
|
|
```
|
2019-10-12 17:32:17 -04:00
|
|
|
|
2020-10-05 20:59:00 -03:00
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
## Contributing
|
2020-05-29 23:45:33 +02:00
|
|
|
|
2021-03-31 00:02:39 +02:00
|
|
|
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.
|
2020-05-31 10:47:35 -03:00
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
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](.github/pull_request_template.md) which will
|
2021-03-31 00:02:39 +02:00
|
|
|
appear when you open the PR.
|
2019-05-27 09:49:21 -03:00
|
|
|
|
2024-06-06 06:10:41 -07:00
|
|
|
Also, before you start, make sure to read our [Contributing Guide](CONTRIBUTING.md).
|
|
|
|
|
|
2021-12-08 18:34:46 +01:00
|
|
|
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](https://discord.gg/pxrBmy4).
|
|
|
|
|
|
|
|
|
|
|
2017-10-22 01:33:20 -02:00
|
|
|
## Credits
|
|
|
|
|
|
2022-09-19 23:17:50 +02:00
|
|
|
- The [Blue Fire team](https://github.com/orgs/bluefireteam/people), who are continuously
|
2022-09-19 23:52:53 +02:00
|
|
|
working on maintaining and improving Flame and its ecosystem.
|
|
|
|
|
- All the friendly contributors and people who are helping out in the community.
|
2023-09-15 16:57:56 -03:00
|
|
|
|
|
|
|
|
[flame_audio]: https://github.com/flame-engine/flame/tree/main/packages/flame_audio
|
|
|
|
|
[audioplayers]: https://github.com/bluefireteam/audioplayers
|
|
|
|
|
[flame_bloc]: https://github.com/flame-engine/flame/tree/main/packages/flame_bloc
|
|
|
|
|
[bloc]: https://github.com/felangel/bloc
|
|
|
|
|
[flame_fire_atlas]: https://github.com/flame-engine/flame/tree/main/packages/flame_fire_atlas
|
|
|
|
|
[fireatlas]: https://github.com/flame-engine/fire-atlas
|
|
|
|
|
[flame_forge2d]: https://github.com/flame-engine/flame/tree/main/packages/flame_forge2d
|
|
|
|
|
[forge2d]: https://github.com/flame-engine/forge2d
|
2026-03-26 22:56:22 +01:00
|
|
|
[flame_gamepads]: https://github.com/flame-engine/flame/tree/main/packages/flame_gamepads
|
|
|
|
|
[gamepads]: https://github.com/flame-engine/gamepads
|
2023-09-15 16:57:56 -03:00
|
|
|
[flame_isolate]: https://github.com/flame-engine/flame/tree/main/packages/flame_isolate
|
|
|
|
|
[flutter_isolates]: https://api.flutter.dev/flutter/dart-isolate/Isolate-class.html
|
|
|
|
|
[flame_lint]: https://github.com/flame-engine/flame/tree/main/packages/flame_lint
|
|
|
|
|
[flame_lottie]: https://github.com/flame-engine/flame/tree/main/packages/flame_lottie
|
|
|
|
|
[lottie]: https://airbnb.design/lottie/
|
|
|
|
|
[flame_network_assets]: https://github.com/flame-engine/flame/tree/main/packages/flame_network_assets
|
|
|
|
|
[flame_oxygen]: https://github.com/flame-engine/flame/tree/main/packages/flame_oxygen
|
|
|
|
|
[oxygen]: https://github.com/flame-engine/oxygen
|
|
|
|
|
[flame_rive]: https://github.com/flame-engine/flame/tree/main/packages/flame_rive
|
|
|
|
|
[rive]: https://rive.app/
|
|
|
|
|
[flame_svg]: https://github.com/flame-engine/flame/tree/main/packages/flame_svg
|
|
|
|
|
[flutter_svg]: https://github.com/dnfield/flutter_svg
|
2025-12-17 19:02:54 +01:00
|
|
|
[flame_texturepacker]: https://github.com/flame-engine/flame/tree/main/packages/flame_texturepacker
|
|
|
|
|
[texturepacker]: https://www.codeandweb.com/texturepacker
|
2023-09-15 16:57:56 -03:00
|
|
|
[flame_tiled]: https://github.com/flame-engine/flame/tree/main/packages/flame_tiled
|
|
|
|
|
[tiled]: https://www.mapeditor.org/
|
