flame

英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

一个基于 Flutter 的游戏引擎。

文档

Flame 的完整文档可以在 docs.flame-engine.org 找到。

要更改文档的版本，请使用页面顶部标注为 version: 的版本选择器。

注意：主分支上的文档比文档网站上发布的文档更新。

其他有用的链接：

• Flame 官方网站。
• 示例 展示了大多数功能，可以在浏览器中尝试。
  • 要访问每个示例的代码，请点击右上角的 < > 按钮。
• 教程 - 一些入门的简单教程。
• API 参考 - 自动生成的 dartdoc API 参考。
• awesome-flame - 精选的教程、游戏、库和文章列表。

帮助

在 Blue Fire 的 Discord 服务器 上有一个 Flame 社区，你可以在这里询问任何与 Flame 相关的问题。

如果你使用 StackOverflow 更舒服，你也可以在那里创建一个问题。添加 Flame 标签，以确保任何关注该标签的人都可以提供帮助。

功能

Flame 引擎的目标是为使用 Flutter 开发的游戏可能遇到的常见问题提供一整套现成的解决方案。

提供的一些主要功能包括：

• 游戏循环。
• 组件/对象系统 (FCS)。
• 特效和粒子。
• 碰撞检测。
• 手势和输入处理。
• 图像、动画、精灵和精灵表。
• 用于简化开发的一般工具。

在这些功能之上，你可以通过桥接包增强 Flame。通过这些库，你将能够访问其他包的绑定，包括自定义的 Flame 组件和辅助工具，从而实现无缝集成。

Flame 官方提供以下包的桥接库：

• flame_audio 用于 AudioPlayers：可同时播放多个音频文件。
• flame_bloc 用于 Bloc：一个可预测的状态管理库。
• flame_fire_atlas 用于 FireAtlas：用于为游戏创建纹理图集。
• flame_forge2d 用于 Forge2D：一个 Box2D 物理引擎。
• flame_gamepads - 支持游戏中的游戏手柄输入（gamepads 的桥接包）
• flame_isolate - 在 Flame 游戏中轻松使用 Flutter Isolates。
• flame_lint - 我们的一套 lint 规则 (analysis_options.yaml)。
• flame_lottie - 在 Flame 中支持 Lottie 动画。
• flame_network_assets - 加载网络游戏资源的辅助工具。
• flame_rive 用于 Rive: 创建交互式动画。
• flame_svg 用于 flutter_svg: 在 Flutter 中绘制 SVG 文件。
• flame_texturepacker: 加载并使用由 TexturePacker 生成的精灵图集。
• flame_tiled 用于 Tiled: 2D 瓦片地图关卡编辑器。

支持

向我们展示支持的最简单方式是给项目加星！ :star:

你也可以通过 OpenCollective 进行捐赠来以金钱方式支持我们：

通过 GitHub 赞助者：

或者通过在 Patreon 上成为赞助人：

你还可以在你的仓库中展示你的游戏是使用 Flame 制作的，方法是使用以下徽章之一：

贡献

你发现了一个 bug 或者有关于如何改进 Flame 的建议吗？请提交一个问题，我们会尽快查看。

你想通过 PR 贡献吗？PR 总是受欢迎的，只要确保从正确的分支（main）创建，并遵循在你打开 PR 时出现的清单。

另外，在开始之前，请确保阅读我们的贡献指南。

对于较大的更改，或者如果有疑问，请确保与团队讨论你的贡献。可以通过提交 issue、GitHub 讨论，或者使用Discord 服务器联系团队。

鸣谢

• 蓝火团队，他们不断致力于维护和改进 Flame 及其生态系统。
• 所有友好的贡献者以及在社区中提供帮助的人。