本ツールは、フォーク元である VitDeck を、じゃぱんくえすた向けに改変したものです。
改変部分のライセンスについては MIT を継承しています。
以下は、フォーム元のREADMEです。
VitDeckは多人数で特定のルールに沿ったUnityのアセットを同時に制作するプロジェクトを支援するツールです。
以下の機能を持っています。
- テンプレートから作成：
- 管理者が事前に準備したテンプレート（フォルダ構成やモデル、シーンファイル等）を複製し、提出用アセットの作成を開始する
- ルールチェック：
- シーン内のオブジェクトが管理者が構成したルールに沿っているかチェックする
- 提出パッケージ作成：
- 提出用のUnitypackageを作成する
- ツールアップデート：
- テンプレートやルールの最新版を管理者のサーバーからダウンロードして更新する
作業管理者が事前にテンプレートおよびチェック用のルールを構成した上で作業者に配布することを前提にしています。
最新のリリースのunitypackageをダウンロードし、VitDeckを使用したいUnityプロジェクトにインポートしてください。
正しくインポートされるとUnityのメニューバーにVitDeckが表示されます。
テンプレートを選んで必要事項を入力し、Loadボタンを押すとプロジェクトのAssetsフォルダ直下にテンプレートの複製が作成されます。
検証用のルールセットとベースフォルダ（提出用のルートフォルダ）を指定してCheckボタンを押すとベースフォルダ内のシーンファイルがチェックされます。（※複数シーンファイルには対応していません）
提出用のベースフォルダを指定してExportボタンを押すと運営が設定したルールに沿っているか検証した後、フォルダ以下のアセットを全て含むunitypackageが作成されます。
管理者がアップデートを構成している場合、UnityメニューバーのVitDeck＞Infoからアップデートがあるか確認できます。
VitDeckを配布する前に管理者が各機能を構成する方法は以下を参照してください。
VitDeckでは検証したいルールの組み合わせとその設定をルールセットと呼ばれる単位で管理します。 管理者は最初にルールセットを構成してください。
namespace VitDeck.Validator
{
public class SampleRuleSet : BaseRuleSet
{
public override string RuleSetName
{
get { return "サンプルルールセット"; }
}
[Validation]
public IRule unityVersionRule = new UnityVersionRule("[U01]Unityバージョンルール", "2018.4.20f1");
[Validation]
public IRule assetNamingRule = new AssetNamingRule("[A01]アセット名の使用禁止文字ルール", @"[a-zA-Z0-9 _\.\-]+");
[Validation]
public IRule assetGuidBlacklistRule = new AssetGuidBlacklistRule("[A02]特定のGUIDを持つアセットの検出ルール",
new string[] { "740112f6e77ca914d9c26eef5d68accd", "ae68339621fb41b4f9905188526120ea" });
...以下のルールが最初から利用でき、独自ルール（C#で記述）も定義可能です。
- 指定のUnityバージョンで動作しているか検証
- アセット名の使用禁止文字の検出
- 特定のGUIDを持つアセットの検出
- アセットの長すぎるパスの検出
- 特定の拡張子を持つアセットの検出
- ブースがBounds内に収まっているかの検証
- コンポーネントのホワイトリスト検証
- コンポーネントのブラックリスト検証
- エラーシェーダーの検出
- Noneになっているメッシュの検出
- missingになっている参照の検出
プロジェクトのAssetsフォルダ内のVitDeckフォルダをまるごと削除してください。
以下の環境でテストしています。
- Windows 10
- Unity 2018.4.20f1
Copyright (c) 2019-2021 VitDeck
Released under the MIT license.