# flame **Repository Path**: GuitarTom/flame ## Basic Information - **Project Name**: flame - **Description**: flame1.1.1 - **Primary Language**: Dart - **License**: MIT - **Default Branch**: master - **Homepage**: https://gitee.com/GuitarTom/flame - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2022-04-24 - **Last Updated**: 2022-04-24 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

flame

A Flutter-based game engine.

Test

--- [English](/README.md) | [简体中文](/i18n/README-ZH.md) | [Polski](/i18n/README-PL.md) | [Русский](/i18n/README-RU.md) | [Español](/i18n/README-ES.md) | [日本語](/i18n/README-JA.md) --- ## Documentation The full documentation for Flame can be found on [docs.flame-engine.org](https://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: - [The official Flame site](https://flame-engine.org/). - [Examples](https://examples.flame-engine.org/) of most features which can be tried out from your browser. - [Tutorials](https://tutorials.flame-engine.org/) - A simple tutorial to get started. - [API Reference](https://pub.dev/documentation/flame/latest/) - The generated dartdoc API reference. ## Help 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 [Flame tag](https://stackoverflow.com/questions/tagged/flame), 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: - [flame_audio](https://github.com/flame-engine/flame/tree/main/packages/flame_audio) for [AudioPlayers](https://github.com/bluefireteam/audioplayers): Play multiple audio files simultaneously. - [flame_bloc](https://github.com/flame-engine/flame/tree/main/packages/flame_bloc) for [Bloc](https://github.com/felangel/bloc): A predictable state management library. - [flame_fire_atlas](https://github.com/flame-engine/flame/tree/main/packages/flame_fire_atlas) for [FireAtlas](https://github.com/flame-engine/fire-atlas): Create texture atlases for games. - [flame_forge2d](https://github.com/flame-engine/flame/tree/main/packages/flame_forge2d) for [Forge2D](https://github.com/flame-engine/forge2d): A Box2D physics engine. - [flame_lint](https://github.com/flame-engine/flame/tree/main/packages/flame_lint) - Our set of linting (`analysis_options.yaml`) rules. - [flame_oxygen](https://github.com/flame-engine/flame/tree/main/packages/flame_oxygen) for [Oxygen](https://github.com/flame-engine/oxygen): A lightweight Entity Component System (ECS) framework. - [flame_rive](https://github.com/flame-engine/flame/tree/main/packages/flame_rive) for [Rive](https://rive.app/): Create interactive animations. - [flame_svg](https://github.com/flame-engine/flame/tree/main/packages/flame_svg) for [flutter_svg](https://github.com/dnfield/flutter_svg): Draw SVG files in Flutter. - [flame_tiled](https://github.com/flame-engine/flame/tree/main/packages/flame_tiled) for [Tiled](https://www.mapeditor.org/): 2D tile map level editor. ## Sponsors The Flame Engine's top sponsors: [![Very Good Ventures](/media/unicorn_two_toned.png)](https://verygood.ventures/) [![Cypher Stack](/media/logo_cypherstack.png)](https://cypherstack.com/) 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: [![Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/bluefireoss) Or by making a single donation by buying us a coffee: [![Buy Me A Coffee](https://user-images.githubusercontent.com/835641/60540201-fcd7fa00-9ce4-11e9-87ec-1e98568e9f58.png)](https://www.buymeacoffee.com/bluefire) 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-272727.svg)](https://flame-engine.org) [![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5-272727.svg?style=flat-square)](https://flame-engine.org) [![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5-272727.svg?style=for-the-badge)](https://flame-engine.org) ``` [![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 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](.github/pull_request_template.md) 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](https://discord.gg/pxrBmy4). ## Getting started A simple tutorial to get started can be found on [tutorials.flame-engine.org](https://tutorials.flame-engine.org) and examples of most features in Flame can be found on [examples.flame-engine.org](https://examples.flame-engine.org). To access the code for each example, press the `< >` button in the top right corner. ### Highlighted community tutorials - @Devowl's Flutter & Flame series: - [Step 1: Create your game](https://medium.com/flutter-community/flutter-flame-step-1-create-your-game-b3b6ee387d77) - [Step 2: Game basics](https://medium.com/flutter-community/flutter-flame-step-2-game-basics-48b4493424f3) - [Step 3: Sprites and inputs](https://blog.devowl.de/flutter-flame-step-3-sprites-and-inputs-7ca9cc7c8b91) - [Step 4: Collisions & Viewport](https://blog.devowl.de/flutter-flame-step-4-collisions-viewport-ff2da048e3a6) - [Step 5: Level generation & camera](https://blog.devowl.de/flutter-flame-step-5-level-generation-camera-62a060a286e3 ) - Other tutorials: - @Vguzzi's article [Building Games in Flutter with Flame](https://www.raywenderlich.com/27407121-building-games-in-flutter-with-flame-getting-started) - @DevKage's YouTube series with the [Dino run tutorial](https://www.youtube.com/playlist?list=PLiZZKL9HLmWOmQgYxWHuOHOWsUUlhCCOY) We offer a curated list of Games, Libraries and Articles over at [awesome-flame](https://github.com/flame-engine/awesome-flame). Note that some of the articles might be slightly outdated, but can still be useful. ## Credits - The [Blue Fire team](https://github.com/orgs/bluefireteam/people), who are continuously working on maintaining and improving Flame and its ecosystem. - All the friendly contributors and people who are helping in the community.