Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/isharryh/ark-unpacker

Arknights Game AB Assets Batch Unpacker | 明日方舟游戏资源批量解包器
https://github.com/isharryh/ark-unpacker

arknights spine unity

Last synced: about 14 hours ago
JSON representation

Arknights Game AB Assets Batch Unpacker | 明日方舟游戏资源批量解包器

Host: GitHub
URL: https://github.com/isharryh/ark-unpacker
Owner: isHarryh
License: bsd-3-clause
Created: 2022-06-26T10:21:54.000Z (over 2 years ago)
Default Branch: v3.x
Last Pushed: 2024-12-11T14:03:33.000Z (14 days ago)
Last Synced: 2024-12-18T10:02:51.562Z (8 days ago)
Topics: arknights, spine, unity
Language: Python
Homepage:
Size: 36.4 MB
Stars: 260
Watchers: 1
Forks: 11
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

Ark-Unpacker

Arknights Assets Unpacker | 明日方舟游戏资源批量解包器

v3.4

GitHub Top Language
GitHub License

_{This project only supports Chinese docs. If you are an English user, feel free to contact us.}

## 介绍 _Intro
#### 终止更新预告
本项目正在逐步升级和迁移到 [ArkStudio](https://github.com/isHarryh/Ark-Studio)，敬请关注。
ArkStudio 是正在开发阶段的，功能更加强大的《明日方舟》游戏资源集成式管理平台，开发完成后，当前项目将由于生命周期结束而终止更新，感谢各位一直以来的支持和喜爱。

#### 实现的功能
1. 批量解包《明日方舟》Unity AssetBundle(AB) 文件中的游戏资源对象。
1. 解包时可对基建小人、动态立绘和战斗小人的 Spine 模型文件进行区分；
2. 解包时可以将文件按源 AB 文件的名称分目录存放。
2. 批量合并 RGB 通道图和 Alpha 通道图。
3. 批量解码 FlatBuffers 数据文件。
4. 既提供交互式命令行界面进行操作，也支持直接通过命令行运行。

#### 支持的类型
| Unity类型 | 描述 | 导出格式 |
|:---|:---|:---|
| Sprite | 精灵图 | PNG图片 |
| Texture2D | 二维纹理图 | PNG图片 |
| AudioClip | 音频剪辑 | WAV音频 |
| TextAsset | 文本或字节数据 | 未指定 |

#### 相关文档
- 更新日志 > [点击查看](./CHANGELOG.md)
- 配置文件指引 > [点击查看](docs/ConfigFile.md)
- 游戏资源查找指南 > [点击查看](docs/AssetsGuide.md)

## 使用方法 _Usage

### 1.资源准备
无论您是想要使用我们的发行版本还是源代码来解包明日方舟的游戏资源，您都需要先获取到明日方舟的资源文件。明日方舟是基于Unity开发的游戏，它的游戏资源会全部打包到一种 **AssetBundle文件**（后缀名 `.ab`，下简称“AB文件”，但少数情况下后缀名是 `.bin`）中。

下面将以 **Android 安卓系统** 为例讲述**如何获取到明日方舟的 AB 文件**。明日方舟的游戏资源有 **2 个部分**：
- 一部分是通过**安装包**（`.apk`）提供的，从明日方舟[**官网**](https://ak.hypergryph.com)将其下载到本地后，使用压缩文件查看工具打开（后缀名改成 `.zip` 后打开），然后把里面的 `assets\AB\Android` 文件夹解压出来；
- 另一部分是通过**热更新**提供的，首先确保您的安卓手机上的明日方舟更新到了最新版本，然后（推荐使用 USB 数据线）将手机存储的 `Android\data\com.hypergryph.arknights\files\AB\Android` 文件夹（一般情况下是这个路径）复制到电脑上（重命名为 `Android(2)`）。至此，我们的目录结构大致如下：
> **你的目录**
> ├─Android
> └─Android(2)

最后，将 `Android(2)` 文件夹里的内容复制到 `Android` 中，并**覆盖**同名文件，就能得到完整的游戏资源。在这之后，您就可以使用我们的程序来解包其中的游戏资源了。

当然，您也可以将 `Android` 里的部分文件夹复制出来进行处理，以解包特定的资源。为了便于您找到特定资源的 AB 文件位置，我们整理并列出了各个子目录储存的资源的内容，浏览[此文档](docs/AssetsGuide.md)以查看详情。

### 2.下载ArkUnpacker
为了方便一般用户使用，我们推出了适用于 Windows 64位操作系统（暂不支持其他操作系统）的可执行文件。

请进入 Releases 页面下载 exe 文件 `ArkUnpacker-vx.x.x_x64.exe`：[前往下载](https://github.com/isHarryh/Ark-Unpacker/releases)

### 3.必备知识
在正式地使用本程序前，您最好对以下内容有初步了解：
- [RGB通道图和A通道图](docs/Essentials.md#rgb通道图和a通道图)
- [Spine动画小人](docs/Essentials.md#spine动画小人)

### 4.示例用法
首先，将需要解包的文件夹（可以是多个）放到与 exe 相同的目录下，至此，我们的目录结构大致如下：
> **你的目录**
> ├─Android (解包整个目录需要很久)
> ├─charpack (可以选择解包部分文件夹)
> └─ArkUnpacker.exe

然后运行 exe，弹出交互式命令行界面如下，依据其提示操作即可：
> 欢迎使用ArkUnpacker
> 模式选择：
> 1: 一键执行
> 2: 自定义资源解包
> 3: 自定义图片合并
> 4: 自定义文本资源解码
> 5: ArkModels提取与分拣工具
> 0: 退出
> 输入序号后按回车即可，如果您不清楚以上功能的含义，强烈建议您先阅读使用手册(README)

各模式的功能概述如下：
- “一键执行” 模式下，解包出的文件默认放置在 `Unpacked_xxxx` 文件夹中，合并完成的图片默认放置在 `Combined_xxxx` 文件夹中。
- 若您选择 “自定义资源解包” 或 “自定义图片合并”，还可以**自定义**需要解包的文件类型和保存位置等内容。
- 关于 “自定义文本资源数据解码”，请参阅[此文档](docs/TextAssetsDecoding.md)了解详情。
- 关于 “ArkModels提取与分拣工具”，请参阅[此文档](docs/ArkModelsRepoKit.md)了解详情。

此外，运行程序后，工作目录会生成配置文件 `ArkUnpackerConfig.json` 与日志文件 `ArkUnpackerLogs.log`。有关配置文件的字段说明，请参阅[此文档](docs/ConfigFile.md)了解详情。

### 5.命令行用法
除了上述示例用法展示的**交互式**命令行界面外，程序还支持**直接**通过命令行来运行，以便熟悉命令行调用的用户使用。相关参数如下：
```
usage: ArkUnpacker [-h] [-v] [-m {ab,cb,fb}] [-i INPUT] [-o OUTPUT] [-d] [--image] [--text] [--audio] [--spine] [-g] [-l {0,1,2,3,4}]

Arknights Assets Unpacker. Use no argument to run to enter the interactive CLI mode.

optional arguments:
-h, --help show this help message and exit
-v, --version show a version message and exit
-m {ab,cb,fb}, --mode {ab,cb,fb}
working mode, ab=resolve-ab, cb=combine-image, fb=decode-flatbuffers
-i INPUT, --input INPUT
source file or directory path
-o OUTPUT, --output OUTPUT
destination directory path
-d, -delete delete the existed destination directory first
--image in resolve ab mode: export image files
--text in resolve ab mode: export text or binary files
--audio in resolve ab mode: export audio files
--spine in resolve ab mode: export spine asset files
-g, --group in resolve ab mode: group files into separate directories named by their source ab file
-l {0,1,2,3,4}, --logging-level {0,1,2,3,4}
logging level, 0=none, 1=error, 2=warn, 3=info, 4=debug
```

运行 `ArkUnpacker -h` 命令可以显示此帮助信息。如果您使用的命令不带任何参数，那么程序会以交互式命令行界面的模式启动。

## 注意事项 _Notice
1. 使用一键执行模式时，不会解包**直接**位于程序所在目录中的 AB 文件，只会解包子文件夹里的 AB 文件。
2. 程序会根据设备 CPU 核心数自动调整多线程策略，并且对设备性能（尤其是 CPU 和硬盘性能）有一定要求，配置过低的电脑在运行时可能会缓慢。
3. Windows 命令行基本常识：
1. 快捷键 `Ctrl+C` 用于强行终止程序，若想复制文本，请用鼠标选取文本后再按此快捷键。
2. 左键单击小黑窗会进入“文本选取”模式，此时主程序会暂停执行。
3. 右键单击小黑窗可以粘贴文本，也可用于退出“文本选取”模式。
4. 拖放文件到小黑窗可以快速粘贴其路径。
4. 如果您希望了解更多细节或参与贡献，请[查看开发者指引](docs/ForDevelopers.md)。

## 许可证 _Licensing
本项目基于 **BSD-3 开源协议**。任何人都可以自由地使用和修改项目内的源代码，前提是要在源代码或版权声明中保留作者说明和原有协议，且不可以使用本项目名称或作者名称进行宣传推广。