VNLEWIKI创作故事,连接世界。
简体中文
VNLE 使用手册

通过 GitHub 协作

更改说明可以留空,此时 VNLE 在发送更改时使用 Update。

你在本机工作,GitHub 在线保存团队共享版本。Save 只保存到本地;Compare with team 检查并合并团队更改;Send to GitHub 才会共享准备好的版本。你可以离线写作,之后再分享成果。

在你开始之前

  1. 在 github.com 注册免费账户。每位团队成员都使用自己的账户。
  2. Windows 版本已包含 Git,无需单独安装 Git 或 GitHub Desktop。
  3. 如果故事不公开,请创建私有仓库。该仓库用于存放故事;公开 Wiki 应放在另一个仓库中。

1 · 从 VNLE 登录 GitHub

  1. 点击左上角的项目名称,选择 Set up team 或当前团队状态,然后选择 Sign in with GitHub。
  2. VNLE 会显示一段短代码,并在浏览器中打开 GitHub。请在那里登录、输入代码并批准登录请求。
  3. 返回 VNLE。确认后会显示你的账户名,无需在 VNLE 中输入密码。
  4. 打开仓库访问授权链接,选择 Only select repositories 并选中你的故事仓库。点击 Install 或 Save 确认,再刷新 VNLE 中的仓库列表。

2 · 创建并共享新团队项目

  1. 在 GitHub 右上角选择 + → New repository。输入名称(例如 harbour-story),选择 Private。新仓库不要添加 README、.gitignore 或 License,然后点击 Create repository。
  2. 在 VNLE 中从列表选择仓库,或将仓库地址粘贴到 GitHub Repository。
  3. 输入要与版本记录关联的姓名和邮箱。可以使用 GitHub → Settings → Emails 中的 noreply 地址,然后点击 Connect locally。
  4. 简要说明更改,选择 Compare with team。VNLE 会保存项目、创建本地版本并检查团队版本。之后点击 Send to GitHub 共享成果。
  5. 在浏览器中打开仓库,确认 project.vnle.json 和项目文件夹已出现。通过 Settings → Collaborators 邀请团队成员。

3 · 加入已有项目

  1. 接受 GitHub 邀请。在 VNLE 启动界面选择 Download team project,然后登录 GitHub。
  2. 选择团队仓库和本地工作副本的保存位置,下载项目后在 VNLE 中打开。
  3. 使用 Open project 在 VNLE 中打开该文件夹。通过项目菜单中的团队入口登录 GitHub,并检查仓库访问权限。
  4. 编辑前先同步。完成场景修改后再次比较,再选择 Send to GitHub。

了解状态

Set up team 表示设置尚未完成。Not sent yet 表示本地更改尚未上传。Team updates available 表示队友已上传更改。Up to date 表示上次检查时双方一致。Status not checked 表示无法检查 GitHub,例如当前离线。VNLE 大约每两分钟检查一次已配置的项目。

两人修改了同一内容时

  1. 选择 Compare with team。不冲突的更改会自动合并;同一内容出现不同修改时,VNLE 会显示审查界面。
  2. 比较 Your version 和 Team version,为每个受影响条目选择要保留的版本。
  3. 点击 Validate choices and sync。VNLE 会先检查合并后的项目,再替换工作版本。之后再次选择 Compare with team,最后点击 Send to GitHub。
  4. 如果不确定,选择 Decide later 并与团队讨论。已保存的工作会保留。

尽量提前约定各场景由谁编辑,也要协调共享角色、变量和译文的修改。应用新的团队版本会重新加载项目,结束当前预览,并清空本次撤销记录。

如果同步失败

先检查网络连接。授权过期时请重新登录。确认 VNLE 应用有权访问这个仓库,且你的账户具有写入权限。如果审查期间团队版本又有变化,请重新获取并再次同步。排查问题时请保留项目文件夹。