Skip to content
BranchesTags

Repository files navigation

WDS Editor

World Dai Star 的跨平台制谱器。

安装

从 GitHub Releases 下载对应安装包，无需自行编译：

平台 文件 安装方式
Windows wds-win-x86_64.msi 双击安装（可选桌面 / 开始菜单快捷方式）
macOS (Apple Silicon) wds-macos-arm.dmg 打开 DMG，将 WDS Editor.app 拖入「应用程序」

运行前需要准备的外部依赖

平台 依赖 说明
两端 支持 Vulkan 的 GPU 驱动 NVIDIA / AMD / Intel 等最新驱动；无独立显卡时需系统提供可用 Vulkan ICD
Windows Vulkan Runtime（多数机器已有） 若启动报 Vulkan 相关错误，从 LunarG 安装 Runtime
macOS 无需单独装 Vulkan SDK 发行包已捆绑 MoltenVK；需要 Apple Silicon + Metal

macOS：首次打开被拦截时

从网络下载的 .app 可能带隔离属性，Gatekeeper 会阻止打开。在「应用程序」安装完成后执行一次：

xattr -cr "/Applications/WDS Editor.app"

从源码编译

仓库包含编译、打包与运行所需内容：源码、CMake/脚本、BASS、Vulkan 头、UI 字体/图标，以及运行时 skins/、effects/ 等。
本地路径请放在 scripts/env.local（已忽略），勿提交。

已验证的主机 / 目标组合：

构建主机 目标
Linux x86_64 win-x86_64（MinGW 交叉编译）
macOS Apple Silicon macos-arm（本机）

Windows 本地可使用 Qt 6 + Visual Studio/CMake 构建；发行门禁仍以 CI 配置为准。

机器相关路径请写入本地环境文件，不要写进示例文件：

cp scripts/env.example scripts/env.local
# 编辑 env.local

也可用 export WDS_ENV_FILE=/path/to/your.env。变量说明见 scripts/env.example；交叉细节见 cmake/CROSS_COMPILE.md。

A. Linux 主机 → Windows（win-x86_64）

环境准备

  1. 工具链：mingw-w64、cmake、ninja 或 Make、zip、curl
  2. MSI 打包（可选但推荐）：msitools（wixl / wixl-heat / msiinfo）
  3. vcpkg，triplet x64-mingw-static，安装例如： libpng zlib vulkan-loader
  4. 在 scripts/env.local 中设置： 
    WDS_VCPKG_ROOT="$HOME/path/to/vcpkg"
# 可选：WDS_MSITOOLS_PREFIX=...  WDS_PRODUCT_VERSION=1.0.0

编译与打包

./scripts/build-target.sh --check          # 探测 MinGW toolchain
./scripts/build-target.sh win-x86_64       # Release + MSI/zip → dist/
./scripts/build-target.sh win-x86_64 --debug --no-run   # Debug 树，不打包

产物：dist/wds-win-x86_64.msi、dist/wds-win-x86_64.zip。

B. macOS Apple Silicon → macos-arm

环境准备

xcode-select --install   # 若尚未安装
brew install cmake libpng glslang molten-vk vulkan-headers vulkan-loader qtbase qtsvg

编译与打包

./scripts/build-target.sh macos-arm              # Release → zip + dmg
./scripts/build-target.sh macos-arm --debug      # Debug，自动启动编辑器
./scripts/build-target.sh macos-arm --debug --no-run

产物：dist/wds-macos-arm.zip、dist/wds-macos-arm.dmg。

C. Windows 本机编译

当前跨平台脚本仍以 Linux 交叉 MinGW 为主路径。Windows 原生开发需准备：

  • Visual Studio 或 MinGW-w64、CMake
  • vcpkg（如 x64-windows 或 x64-mingw-static）提供 libpng / Vulkan
  • 将 CMAKE_PREFIX_PATH、Vulkan_LIBRARY 指向本机前缀

配置后可用标准 CMake workflow 构建 wds_editor；Qt 版 Release 打包入口为 scripts/package-qt-release.ps1。

构建模式速查

模式 目录 打包 日志
Release（默认） build-<target>/ 是 → dist/ 关闭
Debug (--debug) build-<target>-debug/ 否 详细 WDS_LOG

模块开关：WDS_BUILD_COMMON / CORE / AUDIO / RENDERER / INTERACTION / UI（默认均 ON）。 只关 RENDERER 会 FATAL（INTERACTION / UI 仍依赖它）。core-only 需同时 -DWDS_BUILD_RENDERER=OFF -DWDS_BUILD_INTERACTION=OFF -DWDS_BUILD_UI=OFF；只要 core、不要 audio 时再加 -DWDS_BUILD_AUDIO=OFF。 基准默认关、不进 CTest：WDS_CORE_BUILD_BENCHMARKS、WDS_RENDERER_BUILD_BENCHMARKS。

测试

当前产品门禁是 macOS 原生 CTest。CI macos-arm job 顺序为 --no-package → ctest → --package-only：

./scripts/build-target.sh macos-arm --no-package
ctest --test-dir build-macos-arm --output-on-failure
./scripts/build-target.sh --package-only macos-arm

默认全开模块时会注册：wds_common_tests、wds_core_tests、wds_split_index_tests、wds_audio_player_tests、wds_renderer_tests、wds_note_visual_policy_tests、wds_split_line_official_colors_tests、wds_interaction_tests、wds_ui_logic_tests、wds_note_draw_order_tests。

Linux 宿主交叉出的 Windows PE 不能在该宿主上运行。 不要对 build-win-x86_64 跑 ctest（部分测试目标仍可能被编译，但宿主执行的是 PE）。交叉策略见 cmake/CROSS_COMPILE.md。

Linux 上若只需跑 common + core 单测（不是产品构建），可用 scripts/run-host-core-tests.sh。这不能代替 macOS 门禁，也不等于 Windows 运行时验证。

Windows 本机跑测试尚未覆盖，本文不写未实测结论。

项目结构

wds-editor/
├── common/                 # 时间轴、日志等跨层原语
├── core/                   # 谱面数据、编辑、序列化、预览快照
├── renderer/               # DrawBatch + Vulkan 呈现 / 纹理
├── chart-render/           # 舞台几何、皮肤图集、音符条带
├── audio-player/           # BASS 混音与 Transport 时钟
├── interaction-interface/  # 输入、控件、快捷键、主题
├── ui/                     # Qt Dock 壳层、QPainter 编辑器 + Vulkan 预览
├── cmake/                  # 平台默认值与交叉 toolchain
├── scripts/                # 构建 / 打包 / 图标
└── skins/ effects/ icons/  # 运行时资源

依赖方向（下层不得反向依赖 ui）

ui → interaction → draw → common
ui → chart-render → renderer → draw → common
ui → audio-player → common
ui → core → common
模块 CMake 目标 命名空间 说明
common/ wds::common wds::common Timeline、时间单位、WDS_LOG
core/ wds::core wds::chart_editor 谱面内核（无 Vulkan / BASS / 窗口）
renderer/ wds::draw / wds::renderer wds::draw / wds::renderer CPU 绘制批 + Vulkan
chart-render/ wds::chart_render wds::renderer 谱面视觉辅助（无设备创建）
audio-player/ wds::audio_player wds::audio BASS + Transport
interaction-interface/ wds::interaction wds::interaction UI 控件与输入
ui/ wds::ui + wds_editor wds::ui Qt Dock 编辑器壳

各模块 README 含职责、目录结构与主要接口。

Include 约定

#include <wds/common/timeline.hpp>
#include <wds/core/chart_editor_engine.hpp>
#include <wds/audio/audio.hpp>
#include <wds/interaction/widgets/button.hpp>
#include <wds/ui/regions/preview/chart_preview_panel.hpp>
#include <wds/renderer/draw_batch.hpp>

资源归属

资源 路径
皮肤 PNG skins/
打击音效 effects/
着色器 renderer/shaders/
BASS audio-player/third_party/bass/{macos-arm,win-x86_64}/
应用图标源 logo.png → scripts/generate-app-icons.sh

Qt 应用图标通过 ui/wds_resources.qrc 内嵌；可替换主题、字体以及 Vulkan/BASS 需要真实文件路径的 skins/、effects/ 由打包脚本放在发行目录中。详见 ui/README.md。

预览每帧数据流

interaction action
  → audio Transport request_*
  → TimelineSnapshot = transport.poll(delta)
  → ChartEditorEngine::apply_timeline(snap)
  → ChartPreviewPanel / PlaybackPreviewView::render(snapshot)
  → DrawBatch → Vulkan present

预览区滚轮与编辑区共用同一套时间轴手势（scrub / Option+滚轮调可见范围），见 ui/README.md。

开发诊断（默认关闭，不依赖 WDS_ENABLE_LOGGING）：环境变量 精确 WDS_FRAME_DIAG=1 写帧耗时日志，见 ui/README.md。异步上传 / descriptor 块链见 renderer/README.md；音频恢复退避与 pending SFX sync（10s / 4096）见 audio-player/README.md。

About

A Chart Editor For World Dai Star

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages