Skip to content

Commit bace7ce

Browse files
Credit the third-party tools used for ground truth research
research/ground_truth/README.md now cites Sekiro-Debug-Patch (yuiamoroll, with Enlisted and Pav) and DS Anim Studio (Meowmaritus), with their license terms, a note not to redistribute them from this repository, and the rule to record tool versions with every dataset. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 8dd767f commit bace7ce

2 files changed

Lines changed: 16 additions & 1 deletion

File tree

‎research/ground_truth/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ It is kept separate from the production application: nothing here is read by the
1010
- Every observation carries its ruleset (`vanilla`, `resurrection`).
1111
- Do not commit proprietary game assets: game binaries, extracted archives, animation bundles, models or textures. Commit scripts, metadata, mappings, identifiers, hashes and annotations only.
1212

13+
## Third-party tools
14+
15+
The research relies on these community tools. They are run locally and are **not** included in this repository; get them from their own pages.
16+
17+
| Tool | Author | Used for | License / terms |
18+
|---|---|---|---|
19+
| [Sekiro-Debug-Patch](https://github.com/yuiamoroll/Sekiro-Debug-Patch) | yuiamoroll (overlay with help from Enlisted; sub-option patches found by Pav) | Enables Sekiro's developer debug menu, whose overlay shows the boss's current animation ID during recorded fights | No license file. The README describes it as a modder's resource that may be used freely, and asks to be contacted before it is packaged with another mod that is sold. Do not redistribute it from this repository. |
20+
| [DS Anim Studio](https://github.com/Meowmaritus/DSAnimStudio) | Meowmaritus | Opening and inspecting character animation files (TAE events, AtkParam references, animation previews) | GPL-3.0 |
21+
22+
Every recording and extracted dataset records the tool versions it was made with, for example the Sekiro-Debug-Patch commit (latest is `88d51093de`, 2021-11-06, as there are no tagged releases) and the DS Anim Studio version (2.4.1 at the start of V4).
23+
1324
## Contents
1425

1526
| Path | What it holds |

‎research/ground_truth/genichiro-plan.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,11 @@ PR 和 release 的说明文字都已经写好,在对话记录里。
7979

8080
1. 从 `dev` 创建分支 `feature/ground-truth-genichiro`。
8181
2. 补齐研究目录:`rulesets/`、`characters/`、`engine/`、`observations/`、`annotations/`。
82-
3. 写 `rulesets/vanilla.json`,记录游戏版本。
82+
3. 写 `rulesets/vanilla.json`,记录游戏版本,以及用到的工具版本:
83+
- [Sekiro-Debug-Patch](https://github.com/yuiamoroll/Sekiro-Debug-Patch) 的 commit;
84+
- DS Anim Studio 的版本号。
85+
86+
工具的作者、许可证和使用约定见 `README.md` 的 "Third-party tools" 一节。这些工具都不提交到本仓库。
8387
4. 新建本地配置文件 `research/ground_truth/local.config`,里面写解包目录和录像目录的路径。这个文件加入 `.gitignore`,不提交。
8488
5. `.gitignore` 里排除游戏原始文件(hkx、tae、anibnd 等)和录像文件。
8589
6. 为研究脚本单独建一个 Python 环境,和后端的环境分开,然后安装 ffmpeg、OpenCV、numpy。**安装前会先征得你的同意。**

0 commit comments

Comments
 (0)