b5af714c53
As mentioned in discord, the current build of the docs loses jQuery functionality. This is due to sphinx being upgraded to version 6 in which they removed jQuery and created a stand-alone package for it. Additionally, in the process of doing that, I noticed the previously mentioned fix (in the comments) for the `melos doc-setup` about removing the single quotes to keep it clean didn't make into the final code. I have updated that as it was previously confirmed to work on all platforms in: https://github.com/flame-engine/flame/pull/2401 I noticed that the copyright that was in the `conf.py` was locked at 2021 and so I made it go to 2023 as well. This can be removed if not desired, but thought maybe this had just been overlooked. Finally, there was an error regarding a duplicate instantiation of a constant. This had to do with the fact the basic theme provided with sphinx, the next version after which the docs were based, had a bug fix implemented: https://www.sphinx-doc.org/en/master/changes.html#release-5-1-0-released-jul-24-2022. In their fix, it also broke the way the flames theme works. On a side note, the docs are using a very outdated version of the basic theme and should likely be overhauled, but that is outside the scope of this pr. None the less, after I finally figured out how the basic theme is inherited and where that lived on my machine, I was able to resolve the discrepancies and eliminate the conflicting names between the two themes. In short, all errors have been resolved and I have confirmed that mobile, web, search, highlighting, menus, etc. all work - at least on my machine.
A Flutter-based game engine.
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:
- The official Flame site.
- Examples 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.
- To access the code for each example, press the
- Tutorials - A simple tutorial to get started.
- API Reference - The generated dartdoc API reference.
- awesome-flame - A curated list of Tutorials, Games, Libraries and Articles.
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, to make sure 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 for AudioPlayers: Play multiple audio files simultaneously.
- flame_bloc for Bloc: A predictable state management library.
- flame_fire_atlas for FireAtlas: Create texture atlases for games.
- flame_forge2d for Forge2D: A Box2D physics engine.
- flame_lint -
Our set of linting (
analysis_options.yaml) rules. - flame_oxygen for Oxygen: A lightweight Entity Component System (ECS) framework.
- flame_rive for Rive: Create interactive animations.
- flame_svg for flutter_svg: Draw SVG files in Flutter.
- flame_tiled for Tiled: 2D tile map level editor.
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:
[](https://flame-engine.org)
[](https://flame-engine.org)
[](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 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.
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 out in the community.