创作者助手VCC详解

此图书已经可读,但还有待完善。       

VRChat Creator Companion(VRChat 创作者助手)是 VRChat 官方推出的用于辅助开发者的开发软件,是安装开发SDK的必需工具,也有安装和管理社区包等多种功能。

介绍

VRChat Creator Companion(VRChat 创作者助手)是 VRChat 推出的用于辅助开发者的开发软件,功能齐全,可以做到检测,安装和更新替换 Unity,SDK 等的多个功能,并且有着英文版的官网手册,开发工具,社区资源等。

1.png

阅读本教程可以帮助您正确配置创作者助手,在国内环境下运行并使用创作者助手。

如果您遇到了奇怪或者难以解决的问题,请优先参阅该章节下的 Q&A 页面,如果您发现您遇到的问题未出现在 Q&A页面 中,请将您遇到的问题以尽可能详细的形式发布在社区群聊中,并@任意管理员。

1. 下载和安装创作者助手

下载

点击此处下载创作者助手。

安装

双击安装程序开始安装,点击 Install for all users。

vrcentry-2-1-1.png

阅读 License Agreement,勾选 I accept the agreement,右下角点击下一步。 

vrcentry-2-1-2.png

点击下一步x2。 

vrcentry-2-1-3.png

点击下一步x3,等待片刻您的创作者助手就安装完成了!

vrcentry-2-1-4.png

2. 设置创作者助手

初始界面

安装好创作者助手后,初次打开会看见这么一个界面,点击中间的 Show Me Around 直接进入主界面。

vrcentry-2-2-1.png

您可以通过主界面的汉化配图对创作者助手功能有大致了解。

vrcentry-2-2-2.png

配置 VCC 下载加速

如遇任何使用问题,请首先阅读❓Q&A | VRCD 文档库,对比控制台窗口信息,查看对应解决办法。
如果以上措施无法解决问题,请关闭 CreatorCompanionPatcher.exe 与 VCC 应用程序,再移步到安装文件夹下的patcher-logs文件夹中,并联系我们,发送最新的日志文本文件。

加速官方包

一般情况下,您无法在国内网络环境下正常使用创作者助手的功能。您会需要通过一些特殊的加速手段来运行创作者助手,以便正常使用其功能。

  1. 下载并安装 .NET 6.0 Desktop Runtime在安装窗口中,选择 安装修复。

    组合 225.png

  2. 点击 此处 下载 CreatorCompanionPatcher.exe,这是一个用于完善 VRChat 创作者助手的补丁。
  3. CreatorCompanionPatcher.exe文件剪切或者复制到你的创作者助手安装文件夹下。

    您可以右键单击桌面上的CreatorCompanion快捷方式,并点击打开文件所在的位置,来找到创作者助手的安装文件夹
    image.png

  4. 双击启动 CreatorCompanionPatcher.exe ,观察并等待其命令行窗口加载完毕,并弹出创作者助手窗口后,关闭创作者助手与命令行窗口。
  5. 点击 此处 下载patcher.json,将这个文件复制粘贴到创作者助手文件夹中,并选择替换。
  6. 接下来您便可以正常使用创作者助手来下载和更新 VRChat SDK,自动装配 Unity 项目,当我们创建项目时,请保持CreatorCompanionPatcher.exe在后台运行。

请勿"以管理员身份运行”CreatorCompanionPatcher.exe,否则您可能会在 Unity 上遇到使用问题!

请注意,由于 VCC 应用程序目前的限制,更新 VCC 会导致CreatorCompanionPatcher.exe被删除,在我们解决这个问题之前,请您定时按以上流程覆盖重装CreatorCompanionPatcher.exe

加速第三方包

  1. 请首先按加速官方包流程配置好CreatorCompanionPatcher.exe
  2. 访问 vcc.vrczh.org,并在后台使用CreatorCompanionPatcher.exe开启 VCC 应用程序
  3. 查找您想订阅的 vpm 包,并点击添加到 VCC+号按钮
  4. 返回 VCC 界面,点击 I Understand, Add Repository

image.png

订阅第三方包时,请确保您已退订了同名/同功能的 vpm 包。
如这个例子,您应当取消订阅lilxyzwimage.png

image.png

image.png

前言

VRChat Creator Companion(VRChat 创作者助手)是目前来说要为项目安装SDK,也就是实际上要为VRC开发内容的必经之路,但是因为VCC糟糕的代码水平和VRC本身糟糕的服务器,导致使用它创建和管理项目的体验欠佳。

而且尤其是对于国内网络环境,在创建和管理项目时常常出现网络出错的状况,如果您正在国内网络环境使用VCC,我们建议您使用我们的VPM镜像站:

这是什么 - VPM Repos Synchronizer - 一个 VPM 镜像站 (vrczh.org)

image.png

百科中不包含VCC如何添加项目等基本操作,如果您想要学习如何使用VCC添加项目,请访问入门包《创建项目》

VCC仓库管理

仓库(Repository)是一种代码管理术语。

通俗来说,代码仓库是一个用于存储和管理代码的地方,您可以字面意义上将其想象为一个仓库,里面存放着各种资源用于完成和实现一个项目,您通过创作者助手调取的插件与资源便是储存在一个个仓库中的各式各类代码。

仓库中存放着包(Package)很合理吧,仓库中可以存放一个或多个包(Package),而包通俗来说就是一个大文件夹,塞满作者认为一个包里应该塞的东西并给到使用它的用户。

(术语表链接)

image.png

添加仓库

目前大部分热门的 VRChat 开发用插件与资产都可以通过 VPM 在创作者助手中进行配置管理,这极大方便了 VRChat 项目中插件的更新与管理,一些仓库可能会在他们的网站上提供一个 "添加到 VCC" 的按钮,即代表可自动添加仓库到创作者助手。

按钮有长这样的:(摘自 _pi_ 的 VCC 仓库

image (1).png

也有长这样的(摘自 VRCFury 官网):

image (2).png

如果您翻找半天却只找到了一个叫做 “VCC VPM URL” 的谜之网址,这意味着您需要手动添加该仓库,访问此类链接一般会导向一个谜之网页:vI4YO46hLUT3Hmp9-image.png

image (3).png

您需要将此网页链接复制并手动粘贴至创作者助手手动添加(摘自 vrm converter for vrchat BOOTH页面):

自动添加

  1. 点击网站准备的 "添加到 VCC" 按钮。
  2. 同意浏览器的跳转申请,跳转至创作者助手。

image (1).png

  1. 在创作者助手中点击右下角 I Understand, 

     

    Add Repository 即完成操作。

image (2).png

手动添加

  1. 点击右下角 Setting(设置),在上方选择 Package(包),点击右上角 Add Repository 按钮。

image (3).png

  1. 在冒出来的输入框中输入您想要添加的仓库 URL,并且点击右侧 Add 来添加。

image (4).png

移除仓库

您可以通过简单地点击 Community Repositories 列表右侧相应的圆形 “-” 按钮来移除仓库。

image (5).png

包配置

包管理器使在现有项目中更新包变得容易。

点击左上角 Projects(项目),点击 Manage Project(管理项目) 按钮。

image (6).png

在 Manage Package 界面中,您可以看见您添加的每一个包。

image (7).png

点击 + 即可添加最新版本的包至项目,点击 - 即可删除包。

您也可以通过 Installed Version 下拉栏添加指定版本的包,未安装的包将不会显示版本号,取而代之的是 Not Installed(未安装)字样。

包更新

如果您的项目已经未更新许久,在您通过创作者助手打开项目时,创作者助手将自动帮您更新包。

您也可以手动更新包,被标有绿色向上箭头的插件是需要更新的组件包,单击便可开始更新。

image (8).png

将Unity2019项目更新到Unity2022

步骤 1 - 安装新的 Unity 版本

关闭所有打开的项目。

检查当前支持的 Unity 版本并通过 Unity Hub 安装新版本的 Unity。

虽然我们在该页面上列出了独立安装程序,但我们 非常建议 您使用 Hub。在这些步骤中,我们假设您使用的是 Hub。

第 2 步 - 制作项目副本

在进行可能具有破坏性的重大修改之前,请务必创建项目备份。您可以复制一份临时项目,然后在临时项目中操作,而不是主项目。如果出现问题您就可以删除临时项目并重新开始。

如果您是高阶用户,知道如何使用版本控制(比如 git)那就一定要使用它。这样管理备份就变得轻而易举了。

第 3 步 - 打开项目

打开新版本中的临时项目。

您会收到一些升级警告。这并不代表出了什么问题!点击“是”,“确定”或其他有"肯定"含义的按钮。

等待一段时间后,迁移将自动完成。

第 4 步 - 更新 SDK

小版本升级并不总是需要 SDK 更新。但是如果需要,请更新 SDK。

迁移后关闭项目,然后使用 VCC 升级 SDK。

提示和其他信息

以下是一些额外的提示,可能会对您的工作有所帮助。

Unity 警告

在迁移过程中,可能会弹出一些 Unity 警告,您可以放心点击继续。以下是您可能会看到的一些警告。image (4).png

image (5).png

清理副本

如果项目很大,迁移可能需要很长时间。如果项目特别大,有几个文件夹不需要迁移。您可以从副本中安全地删除这些文件夹。

您可以安全地删除以下文件

/Library/
/Temp/
/Obj/
/Build/
/Builds/
/Logs/
/UserSettings/

版本警告

SDK 可能会警告您使用了错误的版本,即使您 知道 使用的是正确的版本。


如果您确定使用的是正确的版本,则可以忽略此消息。

image (6).png

VCC设置

文档正在施工中

Settings(设置)窗口允许您对 vcc 进行一些系统设置和调整。

以下为设置——常规页面的汉化页面,您可以将此翻译用作参考以帮助您实现更多的事情。

image.png

选择备份位置

在某些特殊情况下,创作者助手会将您的项目创建为备份并保存到您电脑的某处位置,您可以通过下方的设置修改备份文件的具体位置。

在 Backups 一栏选择右侧 Pick New Folder 选择您想放置备份的文件夹位置。

image (1).png

VCC工具-VRC Quick Launcher(VRC快速启动器)

入门包.png

当你需要测试虚拟形象,世界或满足部分其他需求时,可以使用这个工具:

image.png

Instance Info(房间信息)

那么看向下面的Instance Info,最上面的四个选项:
Create:创建一个房间,可以指定世界,房间号和用户ID(经过测试,似乎在一般状态下都不能指定,也就是在一般状态下与None相同,但具体什么情况下为非一般状态,可能需要询问官方人员)
Join:输入房间链接加入一个房间,需要本来就具有加入这个房间的许可
Local:加入一个本地测试世界
None:不做自定义,以默认状态登陆

在这其中,Create、Join、None都是以日常的在线模式登陆
而如果使用Local,则是以离线测试模式登陆,你可以:
1. 绕过Steam和小蓝熊登陆,极大加快VRC客户端启动速度
2. 如果已经登陆过账号,会自动登陆,不需要输入账号和密码
3. 离线测试不可以访问除了本地世界以外的世界,但是可以访问在线模型

不论是在线还是离线,你都可以在桌面模式下绕过Steam,而VR模式因为依赖于SteamVR,所以不可以绕过

Profiles(配置文件)

注:虽然按照理解,这里的Profile应该是指对Profiles区块之上的配置信息的保存,但是实际上经过测试,这个Profile似乎并没有保存配置文件信息的功能,如果您对此知道更多,可以向我们反馈

在第一次登陆时,你需要点击Add Profile,然后点击新增的Profile中的Launch来启动,你也可以在这里选择是否以VR模式启动

Debug

该区域待补充

您也可以访问我们的VRChat汉化文档中心,来查阅官方文档中对此工具的解释
VRC 快捷启动工具 (VRCQL) | VRChat 汉化文档中心 (vrczh.org)

❓Q&A

持续更新中。。。

我如何自定义创作者助手的安装路径?​

如果需要,您可以使用命令行运行带有 /DIR 参数的安装程序来设置其安装位置。例如,如果我想将 2.1.3 版本安装到我的 "F" 驱动器,我可以从存放 Setup 文件的文件夹运行以下命令:

VRChat_CreatorCompanion_Setup_2.1.3.exe /DIR = "F:/CreatorCompanion"

我们建议您在安装时避免选择过于复杂的安装路径,请注意文件路径中不能含有中文字符。

以下是我们对安装路径的建议:

  1. 您应该将创作者助手安装路径安排在距离根目录尽可能近的地方,最好是:盘符:/vcc/目标位置
  2. 如果您的某个盘储存吃紧,我们不建议您将安装路径导向此盘,Unity 文件无论是安装包,软件本身,还是项目文件都十分占用储存!

创作者助手本体问题

创作者助手告诉我 Unity Editor not found,我该怎么办?

vrcentry-2-3-1.png

很有可能您下载了错误的 Unity 编辑器版本,或未下载 Unity 编辑器,如果您的问题为以上情况,您需要回到步骤——下载和设置 Unity 编辑器中重新进行操作。

如果您确认您下载了正确版本的 Unity 编辑器,但反复尝试下依旧弹出此页面,请点击 Continue 后,继续点击 I already have Unity 并在资源管理器中找到您的正确版本 Unity 编辑器文件夹,并选择文件夹内的 Unity.exe 。

vrcentry-2-3-2.png

我看不见创作者助手快捷方式,该怎么办

以 win 11 系统为例

点击 win 键打开您的系统搜索框,输入 CreatorCompanion

vrcentry-2-3-3.png

点击右侧 打开文件位置

vrcentry-2-3-4.png

选择 CreatorCompanion 快捷方式并将其拖拽到桌面中即可。

vrcentry-2-3-5.png

创作者助手加速补丁与镜像站补丁问题

我的控制台窗口闪退了,怎么办?

或者:我的补丁控制台窗口卡在这里了,怎么办?

vrcentry-3-1-5.png

请关闭控制台窗口,下载并安装 .NET 6.0 Desktop Runtime在安装窗口中,选择 安装修复

vrcentry-3-1-12.png

vrcentry-3-1-13.png

完成 安装修复 后,再次启动 CreatorCompanionPatcher.exe 即可。

我的补丁控制台窗口卡在这里了,怎么办?

image.png

请删除你当前使用的 CreatorCompanionPatcher.exe,回到 设置创作者助手章节 ,重新下载 CreatorCompanionPatcher.exe 并打开。

我的补丁控制台窗口卡在其他地方了,怎么办?

请截图控制台,并按 设置创作者助手章节 发送日志文件给我们。

我用了补丁,下载不下来 SDK 怎么办?

image.png

请按照 设置创作者助手章节 重新下载,覆盖一次  patcher.json,您可能之前没有正确的下载覆盖文件。