refactor: 重构项目,现在使用ShulkerRDK作为构建工具

[LiPolymer]

非常抱歉拖了这么久 😭 实在没时间啊

这个PR对项目结构改动较大 请您在合并之前务必单独拉取这个分支进行测试, 觉得好用的话再合并 谢谢😋

项目具体的配置方法还请参阅下面的文档

复制自 ShulkerRDK.RPTemplate/README_zh.md

第一次构建

现在您可以使用以下命令来使用 ShulkerRDK 创建您项目

build

执行后, 检查 build 文件夹, 您应该可以看到您的项目已经被自动打包了

配置开发环境

借助 ShulkerRRT, 您可以使用 ShulkerRDK 监测文件变化, 并自动更新, 自动在 Minecraft 内重载资源包

不过在开始之前, 我们需要继续完善项目的设置

要使用自动重载, 您需要准备一个适配您项目的 Minecraft 客户端, 并在客户端安装 Mod ShulkerRRT (如果您使用 (Neo)Forge, 可以使用 Sinytra Connector 来加载这个Mod)

Tip

如果可能, 我们推荐您一并安装 Paxi, 它可以强制加载位于它配置中的资源包, 您无需担心正在开发的资源包被意外卸载

安装完成后, 请启动一次客户端并将其关闭, 打开Mod配置文件夹, 打开配置文件 shulkerRRT.json, 修改 isShulkerRDKManaged 项的值为 true

找到启动器的 导出启动脚本 功能 (此处以 HMCL 为例, 选中目标版本, 从主页面依次点击 版本管理 -> 管理 -> 生成启动脚本), 导出为 .ps1 (PowerShell 脚本格式) 到本仓库内容的 ./shulker/local/client.ps1

完成后, 打开 ./shulker/tasks/settings.lvt, 修改其中的 X:\Path\To\Your\Game 到您的游戏目录 (请注意检查版本隔离情况)

Note

如果您在前面的步骤中安装了 Paxi, 请将^gameRoot^\resourcepacks\debugging 修改为 ^gameRoot^\config\paxi\resourcepacks\debugging

完成后, 您可以尝试使用以下命令启动客户端

dev

根据本模板预置的 dev.lvt, 这会同时启动文件监视器, 您可以尝试修改 ./src/ 文件夹内的文件

在本模板中, ShulkerRDK 不对删除动作和缓存文件 (.psd~(Krita), .tmp(Photoshop)) 做出反应

并且如果 修改/新建的文件 或 重命名后的文件 为 .psd 格式, 将会对其进行格式转化和PBR抽取

Tip

上文末提到的PBR抽取, 是指 ShulkerRDK 自动从一个 .psd 文件中提取PBR贴图图层 (使图层名字以 s_, n_ 开头来标记), 合并后独立导出为 *_s.png, *_n.png

不过请注意, 这应该不会对提取出的图层应用任何高级的混合选项, 并且会无视图层隐藏

所以本模板使用普通方式转化普通纹理, 您如果要使用PBR抽取, 请在每次转化前 (最好为保存前) 确保PBR纹理图层为隐藏状态

好了, 到现在, 您已经完成 ShulkerRDK 的配置了!

(可选)内置版本管理

如果您想使用 ShulkerRDK 内置的版本管理来管理您的项目, 下面是相关的指令:

展示版本号

verm show

设置版本号 (这里假定您要设为 1.0.0)

verm set 1.0.0

如果您要继续使用 x.x.x 格式的话,还可以使用下面的指令

步进修复版本 (x.x.x. -> x.x.x+1)

verm sfix

步进小版本 (x.x.x. -> x.x+1.x)

verm sminor

步进大版本 (x.x.x. -> x+1.x.x)

verm smajor

碎碎念

首先感谢您选择 ShulkerRDK! 🤗

这个小玩意花费了我不少精力, 希望你喜欢! 😋

由于这个玩意可自定义程度极高, 特性较多, 文档可能还需要一段时间, 于是先做了这个模板仓库, 让大家能先用上这些核心功能 😚

如果您在使用中遇到任何问题, 欢迎前往Discussion, 我们会在能力范围内尽可能帮助你!

再次感谢您的使用!