Txiaochen 4959487a71 docs(README): 补全主脚本用法,新增 netdelivery 章节
- 新增「主脚本一览」总表(副作用 / 是否需要二维码)
- upsert.py:独立成章,--extra-data 归位
- buy_ticket.py:补参数表 + 三道安全检查说明
- use_ticket.py:补参数表 + 真机消耗票券的报文依据
- reincarnate.py:补参数表 + 流程/分批/续关/playlog 合成原理
- netdelivery.py:新增章节(ALL.Net DLI,查/下 .app 与 .opt)
- 新增「常见坑与注意事项」(二维码 / 账号状态 / 功能票 / 副作用 /
  日志 / 网络 / 不入库清单)
- 「将来」改为「已完成 / 将来」,列出 v0 全部交付
- 项目框架补上 netdelivery.py 与 download/
2026-10-07 01:22:38 +08:00
2026-10-06 19:22:13 +08:00

WaHappy

舞萌DX 的游戏助手
宗旨:让舞萌DX的玩家能够更好地游玩游戏,获得快乐。

AI真的很好用你知道吗


这是什么

WaHappy 是一个用 Python 纯网络方式与舞萌DX(SDGB 国服)游戏服务器交互的工具集。

它不修改游戏、不注入进程,只是把游戏客户端做的事用脚本重做一遍: 扫码登录 → 取数据 → 上传成绩 → 登出。

协议实现全部来自反编译源码与真机网络日志的双向验证, 每个关键常量在代码注释里都标了源码行号。


当前状态:v0,未完工

v0 目前只是一个占位版本,请以「能不能用」而不是「有多少代码」来判断它。

脚本 状态
upsert.py ✅ 可用 —— 扫码登录 → 上传一局成绩 → 落库回查 → 登出
buy_ticket.py ✅ 可用 —— 购买功能票(2026-10-06 真机验证通过)
use_ticket.py ✅ 可用 —— 读取当前持有的功能票并用 UpsertUserAll 消耗掉(已实跑)
reincarnate.py 🔧 已实现(未实跑)—— 账号数据迁移(转生),每包 ≤4 首 + 续关登录
netdelivery.py ✅ 可用 —— 查 / 下 .app / .opt 更新包(ALL.Net DLI,只读,无副作用)
api/ 下 40+ 个接口模块 🔧 已实现并通过零网络自检,但未全部在真机上验证过
文档 📄 在 docs 分支(mai 分支不含)—— 开发过程、踩坑记录、实跑验证,内容比代码本身还多

关于购买功能票(已解决)

UpsertUserChargelogApi 曾经一直返回 returnCode=0。根因是 请求头多发了 Accept 与 Connection —— 真机(Unity Mono 的 HttpWebRequest)不发这两个头:

number / Content-Type / User-Agent / charset / Mai-Encoding / Content-Encoding / Cookie

删掉之后一次通过(stock 0 → 1,落库确认)。完整排查过程见 购买功能票流程。


一个教训:别把一件事分段交给 AI

v0 的开发过程中,我反复把同一个目标拆成小段丢给 AI,结果:

项目 Token 消耗
v0 有效开发 384M+
含中途废弃的分支项目 1137.5M

这 1137.5M 里有一大半是浪费掉的。

真正的教训是:

不要把一个东西分段交给 AI,而是直接设定一个目标,然后让它自己跑完。

分段交接会让 AI 反复丢失上下文、重复劳动、在已经解决的问题上打转 —— 而一个清晰的目标 + 足够长的执行窗口,反而更快也更省。


项目框架

WaHappy/
├── config.py            运行时可配置项(密钥 / 机台 / 歌曲数据 / 日志级别)★ 需自建
├── config.py.example    配置模板(机台与店铺标识留空待填)
├── upsert.py            ★ 主脚本:扫码登录 → 上传成绩 → 登出
├── buy_ticket.py        主脚本:购买功能票
├── use_ticket.py        主脚本:消耗当前持有的功能票
├── reincarnate.py       主脚本:账号数据迁移(转生)
├── netdelivery.py       主脚本:查 / 下 .app / .opt 更新包(ALL.Net DLI)
├── selftest.py          零网络自检(238 项,判据 = 源码 + 真机日志)
│
├── api/                 ★ 所有与服务器交互的模块(一个接口一个脚本)
│   ├── __init__.py      统一导出 + 日志自动跟踪
│   ├── maimai_net.py    网络核心(AES / deflate / URL 混淆 / Cookie)
│   ├── log_setup.py     日志(INFO / DEBUG 双模式)
│   ├── upsert_user_all.py      上传成绩(36 节点 / 110 字段 / 差分)
│   ├── get_need_user_data.py   结算快照编排 + 落盘 data/<userId>.json
│   └── ...                     40+ 个接口脚本
│
├── data/                每账号一份用户数据快照(<userId>.json)★ 不入库
├── download/            netdelivery.py 下载的 .app / .opt ★ 不入库
├── logs/                日志输出(latest.log + 日期.log)★ 不入库
└── source/              反编译源码 ★ 不入库,需自备

设计约定:api/ 里每个脚本 = 一个接口,对外暴露一个能传参的函数。 主脚本只负责编排,日志和协议细节都在 api/ 内部。

命名约定:服务端 API 名里带 Get 的,脚本名与函数名一律带 get / Get (不要模棱两可)。所以取数脚本全是 get_*.py,函数是 GetXxx。

docs/ 在 docs 分支,source/ 与 logs/ 不入库。

source/ 是反编译源码,需要自备。

分支说明

分支 内容
mai 主分支 —— 代码(api/ / upsert.py / config.py / selftest.py / gamehook/)
docs 孤儿分支 —— 只有 docs/,开发文档与踩坑记录

两个分支没有共同的提交历史,各自独立。


快速开始

1. 装依赖

pip install requests pycryptodome

2. ★ 先填 config.py

仓库里只有模板 config.py.example,先复制一份:

cp   config.py.example config.py      # Linux / macOS
copy config.py.example config.py      # Windows

然后必须填好 config.py 第二节「机台与店铺标识」的 6 个值:

变量 填什么
KEYCHIP_ID 你的机台 Keychip(完整形式,带连字符,形如 XXXX-XXXXXXXXXXX)
CLIENT_ID Keychip 短值(去掉连字符取前 11 位)
REGION_ID 你所在区域 ID
PLACE_ID 你所在店铺 ID
PLACE_NAME 店铺名(游戏服务器不返回,只能手填)
REGION_NAME 区域名

⚠️ 这 6 个值留空或填错,发出去的请求带的就是别人的机台身份,服务端会直接拒绝。

config.py 已在 .gitignore 里 —— 它是你的私有配置,不要提交。

3. 跑自检

python selftest.py        # 零网络自检,应该 238 项全绿(不依赖你的 config)

主脚本一览

脚本 干什么 副作用 需要二维码
upsert.py 上传一局成绩 ★ 有 ✅
buy_ticket.py 购买功能票 ★ 有 ✅
use_ticket.py 消耗当前持有的功能票 ★ 有 ✅
reincarnate.py 账号数据迁移(转生) ★ 有 ✅(目标号;源号可选)
netdelivery.py 查 / 下 .app / .opt 更新包 只读 ❌
selftest.py 零网络自检 无 ❌

所有有副作用的脚本默认都不发包:不传 --send 时只构造报文(dry-run)。 想看报文而不产生任何后果,先跑一次不带 --send 的。


upsert.py —— 上传一局成绩

# 预检:登录 + 抓快照 + 组包,不发包(零副作用,建议先跑这个)
python upsert.py "<二维码>"

# 真实上传一局成绩(★ 有副作用,不可撤销)
python upsert.py "<二维码>" --send

# 常用开关
python upsert.py "<二维码>" --send --debug        # 日志里带完整收发报文
python upsert.py "<二维码>" --send --cooldown 0   # 跳过发包前 60 秒冷却
python upsert.py "<二维码>" --send --no-verify    # 跳过上传后的落库回查

换歌 / 换成绩只改 config.py 的 PLAY_*,不用动任何代码。

二维码从机台的「扫码登录」界面获取,有效期 10 分钟。

额外塞节点:--extra-data

真机报文的 36 个节点绝大多数能由快照 + 本局演算自动推出来, 但偶尔想手工覆盖某几个(比如本局拿到的新 KaleidxScope 门),就用 --extra-data:

# ① 从文件读(★ 推荐 —— 不用跟 shell 引号搏斗)
python upsert.py "<二维码>" --send --extra-data extra.json

# ② 直接写 JSON 字符串
python upsert.py "<二维码>" --send --extra-data '{"isNewMapList":"1"}'

# ③ 多个来源,后给的覆盖先给的
python upsert.py "<二维码>" --send --extra-data base.json --extra-data patch.json

extra.json 长这样:

{
  "userKaleidxScopeList": [
    {"gateId": 1, "isGateFound": true, "isKeyFound": true, "isClear": false,
     "totalRestLife": 0, "totalAchievement": 0, "totalDeluxscore": 0,
     "bestAchievement": 0, "bestDeluxscore": 0,
     "bestAchievementDate": "", "bestDeluxscoreDate": "",
     "playCount": 0, "clearDate": "", "lastPlayDate": "", "isInfoWatched": false}
  ],
  "isNewKaleidxScopeList": "1"
}
规则 说明
键 必须是 upsertUserAll 的 36 个节点之一(含 11 条 isNew* 位串),写错会报错并列出可用节点名
值形态 按节点形态强制转换,传错立刻报错
位串 给了数组没给位串 → 按长度补 "0" 并提示。新增条目请显式传 "1"("0" = 存量更新)
优先级 最高,覆盖快照演算结果
校验时机 ★ 扫码之前就校验 —— JSON 写错直接退出,不浪费二维码

⚠ 在 PowerShell / CMD 里写内联 JSON 很容易被吞掉双引号, 建议一律用文件(--extra-data extra.json)。


buy_ticket.py —— 购买功能票

python buy_ticket.py "<二维码>" --list                    # 只列当前票券和可买的票
python buy_ticket.py "<二维码>" --charge-id 2             # 预检:只看报文
python buy_ticket.py "<二维码>" --charge-id 2 --send      # ★ 真实购买
参数 默认 说明
--charge-id N 5 买哪张票
--list — 只列票券与可购买清单,不做任何写操作
--send 关 ★ 真实发包
--debug 关 日志里带完整收发报文
--skip-entry 关 跳过登录后的「入场全量下载」
--wait-before N 30 买票前等待秒数(真机 login→买票是 26 秒)
chargeId 票 上报的 price(= 票的 creditNum)
2 2倍チケット 1
3 3倍チケット 2
4 4倍チケット 3
5 5倍チケット 4
6 6倍チケット 5

它做了哪些安全检查

  1. 买之前先查 GetGameChargeApi —— 目标票不在当前可购买清单里就直接退出, 连登录都不做(不浪费二维码)。依据 TicketManager.cs:137-150。
  2. 跑前查一次 GetUserChargeApi:账号已经持有功能票时直接拒绝购买 (重复购买有封号风险)。想清掉手里的票用下面的 use_ticket.py。
  3. 跑后再查一次,确认票券状态符合预期。

⚠️ 不同店铺上架的票不一样。买之前先 --list 看一眼, 你所在的机台可能只卖其中几种。


use_ticket.py —— 消耗当前持有的功能票

读取账号持有的功能票,然后用 UpsertUserAll 表达「用这张票打了一局」把它消耗掉。

python use_ticket.py "<二维码>" --list                  # 只列当前持有的票
python use_ticket.py "<二维码>" --ticket-id 2           # 预检:只看报文
python use_ticket.py "<二维码>" --ticket-id 2 --send    # ★ 真实消耗
参数 默认 说明
--ticket-id N 第一张持有的 消耗哪一张
--list — 只列票券,不做任何写操作
--send 关 ★ 真实发包
--music-id N / --level N config.PLAY_MUSIC_ID / PLAY_MUSIC_LEVEL 「这一局」打的歌
--skip-entry 关 跳过入场全量下载
--debug 关 日志里带完整收发报文

原理

GetUserChargeApi 与 UpsertUserAllApi 里的 userChargeList 格式完全相同,所以只要把该节点里目标票的 stock 减 1, 再让 playlog 带上 useTicketId / playCredit,服务端就认为这张票被这一局用掉了。

真机实证(2026-10-06 22:23 那局正好用了 2 倍券):

userChargeList: chargeId=2  stock 1 -> 0        ← 票被消耗
userGamePlaylogList[0].useTicketId = 2          ← 用了哪张票
userGamePlaylogList[0].playCredit  = 2
userPlaylogList[0].playCredit      = 2
userData.lastPlayCredit            = 2

playCredit 的算法(VOExtensions.cs:838-845):

playCredit = 投币数(普通局 = 1) + 票的 creditNum

典型用途:账号手里挂着票时 buy_ticket.py 会拒绝再买; 想再买一张就先把它用掉。也可以直接在机台上打一局并选用它。


reincarnate.py —— 账号数据迁移(转生)

把一个账号(源 A)的数据克隆到另一个账号(目标 B)。

# 源数据来自二维码(会联网抓 A 的数据并落盘到 data/<A>.json)
python reincarnate.py --dst-qr "<B的二维码>" --src-qr "<A的二维码>"

# 源数据来自已保存的 JSON(离线,推荐:不用反复消耗 A 的二维码)
python reincarnate.py --dst-qr "<B的二维码>" --src-json data/12345678.json --plan
python reincarnate.py --dst-qr "<B的二维码>" --src-json data/12345678.json --send
参数 默认 说明
--dst-qr 必填 目标账号 B 的二维码
--src-qr / --src-json 二选一 源数据来源(二维码联网抓 / 读 data/<userId>.json)
--plan — 只列分批计划,不发包(建议先跑这个)
--send 关 ★ 真实发包
--limit N 0(全部) 只迁前 N 首(试跑用)
--per-packet N 4 每包曲目数,不能超过 4
--clone-identity 关 连 userName / accessCode 一起克隆(默认保留 B 自己的)
--no-continue 关 不续关,只发一包(调试用)
--debug 关 日志里带完整收发报文

流程

源账号 A:二维码 → GetNeedUserData(并落盘 data/<A>.json)
                或直接读 data/<A>.json
        ↓
目标账号 B:二维码 → UserPreview → UserLogin
        循环:
          UpsertUserAll(每包 ≤4 首 + 从曲目记录反推的 playlog)
          UserLogin(is_continue=True)   ← ★ 续关,换新 loginId
        收尾:UserLogout

为什么一次最多 4 首

真机一局(一个 credit)最多打 4 首,所以一条 UpsertUserAll 报文里的 userPlaylogList / userGamePlaylogList 最多 4 条。 本脚本把源账号的 userMusicDetailList 按 4 条一组切分,一组 = 一局。

为什么要「续关登录」

UpsertUserAll 的 playlogId 必须等于本次登录的 loginId。 一局结束后这个会话就被消费掉了,要继续上传必须重新登录 —— 真机走的就是「续关」(Process/ContinueProcess.cs:403):

new PacketUserLogin(userID, accessCode, isContinue: true, ...)

本工程对应 UserLogin(user_id, token, is_continue=True)。

playlog 从哪来

GetNeedUserData 抓不到 userPlaylogList(那是逐局记录,没有对应的 Get 接口), 所以本脚本从曲目记录反推合成:

UserMusicDetail(9 字段) → UserPlaylog(110 字段)
musicId / level musicId / level
achievement achievement
deluxscoreMax deluxscore
scoreRank scoreRank / isClear
comboStatus / syncStatus 同名
其余 config.PLAY_* 默认值

迁移范围

默认迁全部节点(整账号克隆)。第 1 包带全部非曲目节点,之后每包只带这一批曲目; 位串 isNew* 按 B 的基线逐条算(B 没有 → "1",已有 → "0")。

⚠️ 未实跑过。 建议先用 --plan 看计划,再 --limit 8 小批量试,确认无误再全量。


netdelivery.py —— 查 / 下 .app / .opt 更新包

机台做完 ALL.Net 认证后,AMDaemon 会再问一次「我该下什么包」—— 这就是 DLI(Download Instruction,配信指示書):

POST http://at.sys-allnet.cn/net/delivery/instruction
body = title_id=SDGB&title_ver=<版本>&client_id=<Keychip 短值>

→ result=1&uri=<patch 指示書>|<option 指示書>

指示書本身是个 INI,真正要下的包写在 INSTALLn= 里:

[COMMON]    INSTALL1=https://.../SDGB_1.56.00_..._1_1.55.01.app
[OPTIONAL]  INSTALL1=https://.../SDGB_A031_..._0.opt
            INSTALL2=https://.../SDGB_A005_..._0.opt

INSTALLn= 才是要下载的包;EXISTn= 是「本机应该已经有的文件」, 只是文件名,不是下载项。

python netdelivery.py                 # 用 config.py 里的机台查,然后**多选下载**
python netdelivery.py A63E01ABCDE     # 指定 Keychip
python netdelivery.py --list          # 只列清单 + 直链,不下载
python netdelivery.py --all           # 全下(不交互)
python netdelivery.py --only 1,3      # 只下第 1、3 项(不交互)
python netdelivery.py --ver 1.55      # 指定上报版本(默认 config.MAI_ENCODING)
python netdelivery.py --out D:\SDGB2026\update
python netdelivery.py --insecure      # 关掉 TLS 校验(CDN 证书有问题时用)

交互选择支持:逗号/空格分隔、区间(1-3)、a=全选、n=全不选、q=退出。 下载带断点续传(.part 临时文件 + Range,下完改名)与进度/速率显示。

实测(--ver 1.56):

  序号  类型  大小          来源段/键              文件名
  [ 1]  opt   7.25 MB       COMMON/INSTALL1       SDGB_A031_20260909101347_0.opt
  [ 2]  opt   3.00 MB       OPTIONAL/INSTALL1     SDGB_A005_20260610180958_0.opt

几点实测结论

结论 说明
title_ver 决定拿哪份指示書 1.55 → patch 1.56 + opt A005;1.56 → 仅 opt A031;≤1.54 → uri=null
包可以断点续传 返回 206 + Content-Range
已下架的历史包会回 504 这是华立 CDN 的状态,不是脚本的问题

默认下载到 download/(已加入 .gitignore,.app 动辄上 GB)。 需要同目录下的 authv1.py 提供 ALL.Net 协议层。


常见坑与注意事项

二维码

项 说明
有效期 10 分钟,过期后 aimedb 返回 errorID=2(不是按次数计量的,重新生成即可)
来源 机台的「扫码登录」界面
每个脚本各要一次 reincarnate.py 需要目标号的二维码;源号可以用 --src-json 免掉

账号状态

  • 一定要登出。账号卡在 isLogin=True 时,下次登录会 returnCode=100。 本工程所有主脚本都在 finally 里兜底登出,异常也不会漏。
  • 想确认状态可以看 GetUserPreviewApi 的 isLogin 字段。

功能票

  • 账号已经持有功能票时,buy_ticket.py 会拒绝购买(重复购买有封号风险)。
  • 想再买一张,先用 use_ticket.py 把手里那张用掉,或直接在机台上打一局选用它。
  • 不同店铺上架的票不一样,买之前先 --list。

副作用

命令 后果
不带 --send 只构造报文,不发包(安全,随便跑)
带 --send 真实写入服务器,不可撤销

日志

logs/latest.log        只含**当次**运行(下次覆盖)
logs/YYYY-MM-DD.log    当日全部日志(追加)

改 config.py 的 LOG_LEVEL:

值 效果
"info" 只展示 api 脚本的运行情况和结果
"debug" 额外展示向 api 发送的数据与 api 返回的数据

主脚本也可以加 --debug 临时开启,不用改 config.py。

网络

  • 服务器偶发超时 / 连接重置,重试即可(买票那次就是这么过的)。
  • 所有请求默认 timeout 10 秒,登录与结算用 60 秒。

不要提交的东西

config.py      你的机台身份,.gitignore 已忽略
data/          用户数据快照
download/      .app / .opt 更新包
source/        反编译源码(版权)
logs/          运行日志

⚠️ .gitignore 的行尾注释不是注释。写 data/ # 注释 会变成一条匹配不到任何东西的规则 —— 这条坑踩过一次(用户数据被误提交),已修。注释必须独占一行。


主脚本怎么写

核心原则:不要为每个 api 调用写日志。 日志已经在 api/ 里了。

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import sys
from api import (setup_logging, teardown_logging,
                 ParseQRCode, UserPreview, UserLogin, UserLogout, LogoutType,
                 UpsertUserAll)
from config import REGION_ID, PLACE_ID

def main() -> int:
    setup_logging("我的脚本")          # ← 只需要这一句
    session = {"user_id": 0, "token": "", "login_dt": 0, "logged_in": False}
    try:
        user_id, token = ParseQRCode(sys.argv[1])
        session.update(user_id=user_id, token=token)

        UserPreview(user_id, token)                        # 顶号保护
        login = UserLogin(user_id, token,
                          region_id=REGION_ID, place_id=PLACE_ID)
        session.update(login_dt=login.loginDateTime, logged_in=True)

        # ★ 一个函数跑完整条结算链路
        UpsertUserAll(user_id, login.loginId,
                      login_date_time=login.loginDateTime,
                      auth_date_time=login.dateTime,
                      token=token,
                      dry_run=False, confirm=True)
        return 0
    finally:
        if session["logged_in"]:                           # ★ 一定要保证登出
            UserLogout(session["user_id"], session["token"], session["login_dt"],
                       logout_type=LogoutType.TestIn,
                       region_id=REGION_ID, place_id=PLACE_ID)
        teardown_logging()

if __name__ == "__main__":
    sys.exit(main())

三条铁律:

  1. 不要写日志 —— 每个 api 函数会自动打印 === 函数名 开始运行 === / [运行结果]
  2. 一定要登出 —— 账号卡在 isLogin=True 时下次登录会 returnCode=100
  3. 写接口要显式开闸门 —— 只写 dry_run=False 不够,必须同时给 confirm=True

完整指南见 主脚本编写指南。


已完成 / 将来

已完成(v0)

  • ✅ 扫码登录 / 登出 / 心跳,完整会话链路
  • ✅ 上传一局成绩(36 节点 / 110 字段 / 差分 / 落库回查)
  • ✅ 购买功能票(真机验证通过)
  • ✅ 消耗持有的功能票(已实跑)
  • ✅ 账号数据快照落盘(data/<userId>.json)
  • ✅ 账号数据迁移(转生)
  • ✅ 查 / 下 .app / .opt 更新包(ALL.Net DLI)
  • ✅ 零网络自检 238 项
  • ✅ MelonLoader 抓包 Mod(gamehook/)

将来可能会加

  • 网页控制 —— 用浏览器代替命令行操作
  • 更多游戏功能(任务 / 地图 / 收藏夹 / 排行榜……)
  • 更完整的真机验证覆盖
  • reincarnate.py 的实跑验证

特别鸣谢

(还有什么以后补充)


免责声明

本项目仅供学习与协议研究使用。使用本工具产生的任何后果由使用者自行承担。 请遵守游戏服务条款,不要用于破坏游戏公平性。

S
Description
A assistance for 舞萌DX. Code by Deepseek V4.1 Flash ;)
Readme
1.6 MiB
Languages
Python 96.9%
C# 3.1%