.. Sync Engine documentation master file

=========================================
Sync — 开源节奏游戏引擎
=========================================

**版本 0.6.0** · MIT 许可证

Sync 是一套模块化的节奏游戏引擎，为 Godot 4.x 游戏开发者提供数据层、
编辑器组件与运行时，全部打包为**一个 GDExtension** （``addons/sync``，
19 个类，一个 DLL）。

.. important::

   Sync **不内置判定引擎**。``NoteKind`` 只保留 ``TAP`` 与
   ``HOLD`` 两种时间语义；游戏专属的音符种类（如 CATCH / VOID）由你
   写入 ``note.metadata`` 并在自己的 GDScript 里实现判定。引擎保证
   判定所需的全部数据都精确可用——详见 :doc:`sync/overview`。

.. grid:: 1 1 1 1
   :gutter: 3
   :padding: 2

   .. grid-item-card::
      :link: sync/index
      :link-type: doc

      **Sync**
      ^^^^^^^^

      * 单一 GDExtension（addons/sync）
      * 19 个类：数据层 + 编辑器组件 + 运行时
      * 核心层（sync::core，C++17）
      * **不带判定引擎**——你在自己的 GDScript 里判

**安装与使用**

0.5.0 起 Sync 不再拆分多个包：安装 **``addons/sync/`` 一个包即可**。
数据层（13 个共享数据类）、编辑器组件（SyncProgressManager /
SyncTimeline / SyncBeatGrid）、运行时（SyncChart / SyncChartPlayer）
与通用组件（SyncNodePool）全部由同一个 GDExtension 注册，无需考虑
包间依赖与加载顺序。

示例项目
--------

`godot-phigros-with-sync <https://github.com/222CM/godot-phigros-with-sync>`_
— a fork from CMYC4237/godot-phigros，展示 Sync 在真实游戏中的用法。

文档导航
--------

.. toctree::
   :maxdepth: 2
   :numbered:
   :caption: 目录

   introduction
   architecture
   installation
   quickstart
   sync/index
   tutorials/index
   advanced/index
   contributing

索引
----

* :ref:`genindex`
* :ref:`search`