mirror of
https://github.com/flame-engine/flame.git
synced 2025-10-29 07:56:53 +08:00
5e8ecf5450
While taking a stroll through our pub.dev publishers, I noticed that all our bridge packages were sorely inconsistent w.r.t their README files. While some were just special in their own way, a lot of them were just broken, incorrect, outdated, or otherwise unsuitable. I found: * broken GitHub badges * links to the old, non-monorepo versions of the packages * hardcoded old versions of packages * lacking bare minimum of details * references to flame v1/pre v1 But the main thing bugging me was the inconsistency. So, instead of pursuing fixing each individual mistake, I thought it would be much more valuable and professional to keep them under a standard template. This is my proposal, based on the current monorepo main README (which is shared with the main `flame` package):  It includes: * the flame logo if we have it for a package we own (can be replaced by a more-specific logo, like for the flame_forge2d package) * brief 1/2-liner describing what this bridges to, including at least one link to the relevant library (GitHub preferred) and ending with "to Flame games" where Flame links to the monorepo main * badges: * * pub version _of that package_ (not `flame`) * * build of the monorepo (not old repos) * * discord (all the same) * * melos (all the same) * a horizontal line * package name written as `flame_x` in a 1-header (`# flame_x`) * rest of the description * other subsections as 2-headers
Flame repository structure
The Flame repository is a monorepo which contains both the main Flame package and other so-called bridge packages.
Bridge packages
Bridge packages are packages which:
- Provides Flame with an interface to another external package (e.g.
flame_audiowhich is Flame + Audioplayers,flame_tiled, which is Flame + tiled). - Packages with features that are somehow very context specific and doesn't have a place inside the
core package (e.g.
flame_splash_screen).
While most of the officially supported bridge packages live in this monorepo, a few can be found under Flame Engine's GitHub organization. There are also many bridge packages developed and maintained by other members of the community.