Search Results for

    Show / Hide Table of Contents

    官方美术资源

    中文 | English

    官方载具、地图等生产资源在私有仓库 WindyVerse/Panzer-War-Mods。旧 GitLab 的通用仓库、音效仓库和地图仓库已冻结,只作历史参考。本页说明授权贡献者的工作方式;下载并试用 SDK 不需要仓库权限,见下文“公开 SDK 与官方资源”。

    获取访问权限

    访问官方资源仓库需要授权。把 GitHub 账号发给开发者,由开发者开通仓库访问权限,再用收到通知的账号登录 Git。

    公开的模组 SDK 不需要申请,可直接下载。

    公开 SDK 与官方资源

    公开 SDK 从 GitHub 发行页下载。按项目初始化打开其中的 UnityProject。Git 克隆的步骤见项目下载参考。 公开 SDK 发行页

    SDK 与官方资源是两个不同的仓库:SDK 用来搭工程、测试和打包,官方生产资源在私有仓库里。看到 SDK 发行页可以直接下载,不代表官方资源仓库也对外公开。

    准备工程

    1. 准备 Git 与 Git LFS,见安装 Git。使用图形界面时再安装 TortoiseGit。

    2. 只改某个包时,可在干净检出中从 Git Bash 按包拉取依赖。下面以 Vehicles/German 为例。

      GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/WindyVerse/Panzer-War-Mods.git
      cd Panzer-War-Mods
      python Tools/ci.py prepare Vehicles/German
      git lfs pull --include="<上一步打印的 lfs 路径>"
      

      prepare 会改写该包对应工程的 Packages/manifest.json。提交前用 git diff -- Projects/Vehicles/Packages/manifest.json 确认该文件只有这次裁剪的变化,然后恢复验证时改动的文件。

      git restore -- Projects/Vehicles/Packages/manifest.json
      
    3. 用 Unity 2022.3.62f1 打开 Projects/<Group>,照常编辑并本地试打包。

    4. 资产位置:一个模组包对应 Packages/<Group>/<Pack> 下的一个本地 UPM 包,BuildPipeline 与包独有的资源都在其中;多个包共用的资源放 Packages/<Group>/Shared。SDK 的创建工具仍会把新建文件生成到工程壳的 Assets/Res/...、Assets/ModManager/,创建完成后在 Project 窗口里把它们拖进所属的包,移动会保留 GUID。

    5. 编辑器里的个人设置(例如 Steam 游戏路径)存在 Assets/EditorStorage.json,该文件不提交。没有这个文件时从 Projects/<Group>/EditorStorage.template.json 读起。

    资源搬迁和重新导出时保留原有路径与 .meta 文件,以保持 GUID 与引用关系。命名与导出要求见美术资源命名与上传规范。

    做一项连贯的改动

    一个分支只包含一项相关改动,便于开发者审查与合并。不要把无关的清理、格式化和重导出混进同一个分支。

    本地试打包会改写 ModPackage 资产里的构建记录(文件清单、createdTime)。只是试包时不要提交这些改动。

    创建分支、提交与推送

    命令行的完整流程:

    git switch main
    git pull
    git switch -c <topic>-mod
    git status
    git add <本次改动的文件>
    git commit -m "<改动说明>"
    git push -u origin <topic>-mod
    

    然后在 GitHub 上从该分支向 main 发起 Pull Request,说明改了哪个包、改了什么、如何验证。

    用 TortoiseGit 时,在项目文件夹的右键菜单里依次完成同样的步骤:

    1. TortoiseGit → Create branch 创建分支。分支名用 <topic>-mod,例如改哪辆坦克、改了它的什么内容。
    2. 切换到该分支后再改动。
    3. 右键 TortoiseGit → Commit。提交对话框中只勾选自己改过的文件;看到不是自己改的文件就不要勾,也不要用“全部添加”。
    4. 右键 TortoiseGit → Push,确认分支名称后推送,再到 GitHub 发起 Pull Request。

    分支上可以继续追加提交。只有在提交里包含自己改的文件,才不会把同工作树里其他人的改动一起带上。

    验证

    提交前运行静态检查,它会补上漏声明的包依赖并报告其他问题:

    python Tools/check.py --fix
    

    改了包的内容时,先用与 CI 相同的入口在本机出当前平台的包并校验,产物在 Artifacts/local/:

    python Tools/ci.py build Vehicles/German
    

    本机通过后再走 CI 的 Build modpack:在模组仓库的 GitHub Actions 中运行,填写受影响的 packs 与目标 platform,验收构建时 publish=none。工作流会裁剪依赖、拉取对应 LFS、构建并校验。流程与产物核对见持续构建模组,平台差异见多平台打包。

    下载产物后核对平台、GUID、modVersion、清单文件及同名 .modpack.json sidecar,再在对应平台的游戏里加载初始载具、地图、音效、材质与配置。CI 构建成功只说明产物本身通过了校验,不等于已在实际游戏中运行过。

    发布到工坊是另一条流程:publish=sandbox 先试发布,publish=production 只允许 main。已发布包的内容改变时先递增 modVersion。

    合并后同步

    分支被合入 main 后,切回 main 并拉取最新工程,其中已包含自己和别人的改动:

    git switch main
    git pull
    

    需要继续改动时,从最新的 main 重新创建分支。

    拉取报错时,先只暂存自己的改动,再拉取,然后恢复:

    git stash push -m "本分支未提交的改动" -- <自己的文件>
    git pull
    git stash pop
    

    只暂存自己的文件,不要把工作树里其他人的改动一起 stash。恢复后再次运行 git status,确认没有遗留的冲突标记。

    工程里出现 Missing 的引用时,记录具体文件路径或 GUID 并反馈给开发者;不要自行删除或重新创建该资产。check.py 报告的缺失路径同样按原样反馈。

    历史资料

    以下内容来自旧版页面,界面文字、仓库地址和界面截图可能与当前版本不同,步骤以正文为准。

    旧 GitLab 仓库(需与通用仓库放在同一父目录):

    • 通用仓库:https://lab.windyverse.net/modder/panzer-war-community-mods
    • 音效仓库:https://lab.windyverse.net/modder/Panzer-War-Fmod
    • 地图仓库:https://lab.windyverse.net/modder/ShanghaiWindyMaps
    • 公用资源:https://lab.windyverse.net/modder/ShanghaiWindyPublicResources

    旧版视频教程(录制于旧界面,仅作背景参考):

    • 模组工程项目下载、使用与提交修改教程
    • 模组工程编写自定义脚本以及调整载具数值

    旧版用截图描述的“主要项目文件位于 Assets/Res/Vehicles/Ground/Data”指的是工程壳里的资源;当前包资源在 Packages/<Group>/<Pack> 中。旧版在编辑器内用 Git 工具建分支、提交和拉取的做法,与上面 TortoiseGit 的步骤一致。

    In this article
    Back to top Panzer War Document