README-ZH.md

一款轻量的 Flutter 游戏引擎.

---

English | 简体中文 | Polski | Русский

---

关于 1.0.0

我们的目标是尽快发布 v1 版本。 随着开发工作的推进，我们将按照周期发布预览版本，并且目前来看我们的进度十分可观（但仍需要一些后续改动）。

我们希望你可以使用新版本的 Flame 进行体验，并且针对新的结构和功能给予我们团队反馈。

目前在 pub 上已发布的 v1 版本为 。 最新的稳定版本为 。 请根据你的需要选择合适的版本。

---

文档

请注意，主分支的文档要比已发布的版本更新。

你可以在此处找到各版本的文档：

• 最新稳定版:

  • Flame 引擎官网
  • GitHub 文档

• v1.0.0 版本：

  • GitHub docs

• 中文社区版文档（非官方，针对中文环境）：

  • Flame 中文网
  • Flame 中文文档

你可以在这里看到完整的 开发文档 。

你可以在浏览器中尝试 我们提供的一些示例。 你也可以在 这里 查看示例的源码。

Flame 的官方网站（包含文档），请 访问此处。

问题互助

国内无法使用 Discord 或希望快速学习 Flame 的用户， 欢迎加入 「Flame 交流」QQ 群 （非官方, 针对国内用户的讨论群）。

我们在 Discord 上有一个互助频道，点击加入。

我们也有 FAQ ， 所以在提问前，请先搜索是否有你需要的答案。

项目目标

该项目的目的是为使用 Flutter 开发的游戏会遇到的常见问题提供一套完整的解决方案。

目前项目提供了以下内容：

• 游戏循环 (game loop)
• 组件/对象系统
• 内置物理引擎（Forge2D，通过 flame_forge2d 提供）
• 音频支持
• 特效与粒子效果
• 手势和输入支持
• 图片、精灵图 (sprite) 以及精灵图组
• 基础 Rive 支持
• 一些简化开发的实用工具类

你可以按需使用它们，某种程度上来说它们是相互独立的。

支持我们

顺手点一颗 Star，就是你对我们的帮助！

你也可以成为赞助者，通过 Patreon 来支持我们：

或者通过 Buy Me A Coffee 捐赠我们：

你也可以在仓库中展示下面的其中一个徽章，表示游戏是通过 Flame 制作的，来支持我们:

[![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)

贡献

注意：我们目前在着手于发布 Flame 的第一个稳定版本，所以，除了严重的 BUG 修复以外，0.x 的版本更新将全部冻结。 如果你想贡献该版本，请确保你的提交是在修复 BUG。 若想贡献至稳定版本，请务必将你的 PR 指向 main 分支，并且与团队沟通你的贡献， 可以是 issue 方式，或在 Discord 上沟通。

我们感激你以任何形式帮助我们！评论、建议、提 issues、或是 PR (Pull Request)。

如果你找到了 bug 或对 Flame 有更好的建议，请创建一个 issue，我们将会尽快处理。

你想通过 PR 进行贡献吗？我们欢迎 PR，只要确保你的分支是 develop， 并遵循 PR 模板 即可。

立即开始

你可以在 这里 找到一系列教程。 注意这些教程都基于主分支。 如需查看你正在使用的版本的教程，请选择对应的版本标签。

系列内容仍然在更新中，会有更多的教程和指导内容加入。

我们还在 awesome-flame 项目上提供了一些精选的游戏、库和文章。

部分文章可能会有内容过时，但仍然是有用的内容。

感谢

• 一直在尽力维护和改善 Flame 框架的 Flame 引擎团队。
• 翻译：HarrisonQI、Alex Li。
• 所有友善的贡献者和在社区中提供帮助的人。