ソース コードの管理

このトピックでは、Stingray ソース コードのリポジトリについて説明し、これらを使用するための推奨ワークフローをいくつか示します。

リポジトリについて

Stingray 開発者として登録する」に記載されているすべての手順に従った場合は、GitHub で Autodesk Games チームのメンバーになるよう招待されているはずです。

次の URL にあるチームのホーム ページにアクセスしてください。

https://github.com/AutodeskGames

stingray という非公開のリポジトリを確認してください。このリポジトリは、Stingray ソース コードを使用する場合の主な出発点となります。このリポジトリには、エンジン、エディタ、およびその他の Stingray 編集ツールの完全動作バージョンを再ビルドする際に必要となるあらゆるものが含まれています。ソースにアクセス可能なすべてのお客様は、このリポジトリを開始点として使用してください。

サブモジュールについて

公式リリースとして出荷される Stingray のバイナリ バージョンには、表示したり使用したりする場合に特殊なアクセス権が必要となる追加コード モジュールもいくつか含まれています。これらのモジュールは、GitHub のメイン Stingray リポジトリにサブモジュールとしてリンクされている、独自のリポジトリに隔離されています。

お客様の組織がこれらのモジュールの 1 つまたは複数のコードにアクセスできる場合は、Autodesk Games チームの下に追加のリポジトリが表示されます。

オートデスクでは、このコードの Git サブモジュールを使用することにより、モジュールの相互同期を常に維持したままアクセスをコントロールするよう試みています。ただし、この試みが実現すると、リポジトリのクローンを作成して操作する場合の複雑さが増します。ゲームの前に少し時間をかけて、Git サブモジュールの仕組みについて理解することをお勧めします。

基本的に、各モジュールは別のリポジトリからの特定のコミットを示すポインタにすぎません。stingray リポジトリには、上記の各モジュールにそれぞれ対応する、これらのサブモジュールのポインタが 3 つ含まれています。サブモジュールのクローンを作成すると、この指定したコミットにおけるコードのクローンがリポジトリから作成され、メインの Stingray リポジトリのローカル クローンに格納されます。各サブモジュールは「ネストされた」リポジトリとみなすこともできます。

サブモジュールのその他の背景情報については、Git のドキュメントまたは GitHub ブログを参照してください。

これらの Stingray サブモジュールを使用するためのリポジトリを実際に設定する手順については、「ソースのクローンを作成してサブモジュールを管理する」も参照してください。

ブランチの規則

すべての Stingray リポジトリには、既に次のブランチが設定されています。

Web 上のこのドキュメントの内容の大部分には、master ブランチの現在の状態が反映されています。develop ブランチを操作する場合は、リポジトリのルートにある readme.md ファイルに目を通して、必要なソフトウェアの更新およびビルド プロセスを確認してください。

リポジトリの分岐

アクセス可能な Stingray リポジトリごとに独自の分岐を作成することを強くお勧めします。

独自のバージョン管理システムで Stingray ソースを操作する場合は、Autodesk Games ブランチのクローンを直接作成するか、あるいはコードベースの zip をダウンロードする方法の方が、簡単で、時間がかからない可能性があります。ただし、独自の分岐を使用する方法には、いくつかの利点があります。

独自の分岐が作成されたら、ソース コードのローカル コピーのクローンを作成して、操作するコンピュータに保存することができます。

プライベート分岐にアクセスする

独自の分岐を作成する場合は、これらの分岐にアクセスできるユーザを把握する必要があります。

Autodesk Games リポジトリから行った分岐に対する変更をプッシュする場合は、その変更をオートデスクが表示できるようになっていること、および組織外のユーザが表示できる可能性があることに注意する必要があります。したがって、Stingray コミュニティに送信し直す変更、または機密事項や知的財産権が含まれていない変更のみを送信することをお勧めします。

独自のソース コントロール システムの操作

組織内にソース コードのバージョン管理システムが既に配置されていて、使い続けたいことがあります。オートデスクから Stingray コードのリビジョンを取得した後に、stingray リポジトリの分岐内で日常的な開発を継続するための要件はありません。このコードを独自のバージョン管理システム内に配置し、独自のツール セットを使用して、新しいリビジョンを既存のコード ベースに合成することができます。

この設定で使用する GitHub の役割は、オートデスクの変更内容を選択して、変更点をオートデスクに投稿するためのメカニズムに限定されています。

ただし、このコードへのアクセスを保護するのはユーザの役割です。Stingray ソースを独自の公開リポジトリ内や、ライセンスを持たない組織外のユーザがアクセスできる場所に配置しないでください。