Files
songforge/README.md
T

2.9 KiB
Raw Blame History

songforge

本地 ACE-Step 生歌 CLI:锁定模型与声线 LoRA、铁律前奏注入、歌词密度硬校验、QC 验收。

独立项目:clone 到任意目录,写好 config/local.toml 指向本机 ComfyUI,即可生成。

文档 给谁 何时读
AGENTS.md Agent / Cursor / 自动化 做歌或改仓前必读(含「遇事先问」)
docs/使用手册.md 人类 命令与配置详解
config/local.toml.example 所有人 第一次连本机 ComfyUI

给 Agent:读完 AGENTS.md 再动手。缺 local.toml、Comfy 没起、风格/歌名不清、想改模型或阈值时——先问用户,不要猜。

换目录也能用(推荐)

cd D:\CodeFiles\ProProjects
git clone https://git.nnrc.ren/swl/songforge.git
# 或:git clone https://github.com/lsuen/songforge.git
cd songforge

.\scripts\setup_venv.ps1
copy config\local.toml.example config\local.toml
# 编辑 local.toml:
#   [engine] server = "http://127.0.0.1:8188"
#   [paths]  comfy_root / qc_python / music_dir

# 先启动本机 ComfyUI,再:
.\.venv\Scripts\python.exe songforge.py doctor

不必把本仓放进 ComfyUI 的 user/default/workflows。

两个 Python 环境

环境 用途
本仓 .venv CLI:doctor / check / gen / catalog
qc_python QC 音频栈(可继续用 ComfyUI 的 venv)

配置:TOML vs JSON

文件 作用
config/default.toml 算法 / 相对路径(相对本仓根)
config/local.toml 本机 Comfy 根、服务地址、QC Python(勿提交)
workflows/template.json workflow 图(JSON)
config/baseline/*.json QC 基线数据
.secrets/ 远程 token(勿提交)

优先级:命令行 > SONGFORGE_* > local.toml > default.toml > DEFAULTS

流水线

.\.venv\Scripts\python.exe songforge.py target --style pop --bpm 104 --dur 180
.\.venv\Scripts\python.exe songforge.py check --style pop --title 歌名 --lyrics-file input\lyrics\歌名.txt
.\.venv\Scripts\python.exe songforge.py gen   --style pop --title 歌名 --lyrics-file input\lyrics\歌名.txt
.\.venv\Scripts\python.exe songforge.py qc    --run gen-<时间戳> --baseline

qc 必须带 --baseline。完整 Agent 规则与「何时发问」见 AGENTS.md。

硬约束(摘要)

项 值
模型 ace_step_1.5_turbo_swl_fused + swl_voice_best_ep257(0.5/0.5)
采样 shift=5.5 / steps=28 / cfg=2.0 / temperature=0.68
时长 完整歌 150–200 秒
前奏 8 小节器乐 hook;CLI 自动注入

远程

License

MIT — 见 LICENSE。