VNLEWIKI物語をつくる。世界をつなぐ。
日本語
VNLEガイド

GitHubで共同作業

所有者：作成と招待

  1. 自分のGitHubアカウントでログインし、ブラウザーでVNLEを認証します。各メンバーが一度行います。
  2. GitHubでREADME、ライセンス、.gitignoreを付けずに空のリポジトリを作成します。ここに戻り、VNLEのアクセスを許可して一覧を更新してください。共有リポジトリを作るのはプロジェクト所有者だけです。
  3. ローカルのストーリーを開き、チームを開きます。自分のGitHubアカウントでログインしてください。チームプロジェクトを新規作成を選び、ブラウザーで空のリポジトリを作ります。VNLEアプリにアクセスを許可し、VNLEに戻って一覧を更新して選択します。手順3で名前とメールアドレスを入力してストーリーを接続します。チームとの差分を確認し、GitHubに送信すると、他のメンバーがダウンロードできます。
  4. メンバーの招待はGitHubで別途行います。リポジトリを開き、Settings → Collaborators → Add peopleに進みます。GitHubのユーザー名またはメールアドレスで検索して招待を送信してください。招待された人は自分のアカウントで承諾します。組織のリポジトリでは、管理者がCollaborators and teamsでアクセスを管理します。変更の送信には書き込み権限が必要です。

メンバー：承諾とダウンロード

まずGitHubの招待を承諾します。VNLEの開始画面またはプロジェクトメニューからチームプロジェクトのダウンロードを開きます。自分のGitHubアカウントでログインし、VNLEを認証してください。手順2で共有リポジトリを選び、手順3でローカルフォルダー名を指定してダウンロードします。別のリポジトリを作る必要はありません。見つからない場合は一覧を更新し、所有者にVNLEアプリのアクセス設定を確認してもらってください。

所有者がこのリポジトリへのVNLEアプリのアクセスを許可する必要があります。招待されたメンバーはGitHubの招待も承諾してください。アプリへの許可はメンバーの招待やリポジトリの公開ではありません。その後、一覧を更新します。

GitHub: 所有者：作成と招待 · GitHub: GitHubにログイン

変更内容の説明は任意です。空欄なら、送信時にVNLEがUpdateを使います。

作業は自分のコンピューターで行い、共有版をGitHubに保存します。Saveはローカル保存、Compare with teamはチームの変更を確認して取り込む操作、Send to GitHubは準備した版を共有する操作です。オフラインで書き、後から共有することもできます。

始める前に

  1. github.comで無料アカウントを作ります。チームメンバーは各自のアカウントを使います。
  2. Windows版にはGitが含まれています。GitやGitHub Desktopを別途インストールする必要はありません。
  3. 非公開の物語にはPrivateのリポジトリを作ります。物語用のリポジトリと公開Wikiは分けてください。

1 · VNLE から GitHub にサインイン

  1. 左上のプロジェクト名をクリックし、Set up teamまたは現在のチーム状態を選び、Sign in with GitHubをクリックします。
  2. VNLEが短いコードを表示し、ブラウザーでGitHubを開きます。GitHubにログインし、コードを入力して接続を許可します。
  3. 確認後にVNLEへ戻ると、アカウント名が表示されます。VNLEにパスワードを入力する必要はありません。

  4. 所有者がこのリポジトリへのVNLEアプリのアクセスを許可する必要があります。招待されたメンバーはGitHubの招待も承諾してください。アプリへの許可はメンバーの招待やリポジトリの公開ではありません。その後、一覧を更新します。

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でそのフォルダーを開きます。プロジェクトメニューのチーム項目からGitHubにログインし、リポジトリへのアクセスを確認します。
  4. 編集前に同期します。担当シーンを編集し、終わったら再比較してSend to GitHubを選びます。

ステータスの把握

Set up teamは設定が未完了、Not sent yetは未送信の変更がある状態です。Team updates availableは他のメンバーが変更を送信済み、Up to dateは前回確認時に一致していた状態です。Status not checkedは、オフラインなどでGitHubを確認できていない状態です。設定済みのプロジェクトは約2分ごとに確認されます。

同じ内容を変更したとき

  1. Compare with teamを選びます。独立した変更はまとめられます。同じ内容が異なる形で編集されていれば、確認画面が表示されます。
  2. Your versionとTeam versionを比較し、各項目で残す版を選びます。
  3. Validate choices and syncをクリックします。VNLEは統合結果を検証してから作業版を置き換えます。その後、再度Compare with team、続いてSend to GitHubを選びます。
  4. 迷ったらDecide laterを選んでチームと相談します。保存済みの作業は残ります。

可能ならシーンごとに担当を決め、共有するキャラクター、変数、翻訳の変更も相談してください。チームの新版を適用するとプロジェクトが再読み込みされ、現在のプレビューとUndoの履歴は終了します。

同期が失敗した場合

まずインターネット接続を確認し、認証の期限が切れていれば再ログインします。VNLEアプリが対象リポジトリへアクセスでき、自分のアカウントに書き込み権限があるか確認してください。確認中にチームの版が変わった場合は、再取得して同期し直します。対処中もプロジェクトフォルダーは保管してください。