From e284cea4dae5d8255f724e539f3da5e711035740 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?100=E3=81=AE=E4=BA=BA?= <100@pokemori.jp> Date: Sun, 8 Nov 2020 17:08:46 +0900 Subject: [PATCH] =?UTF-8?q?README=E3=82=92=E7=B5=B1=E4=B8=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Assets/VitDeck/README.URL | 2 + .../{README.txt.meta => README.URL.meta} | 0 Assets/VitDeck/README.txt | 66 ------------------ docs/README.md => README.md | 0 docs/_config.yml | 5 -- {docs/images => images}/Expoter.gif | Bin {docs/images => images}/TemplateLoader.gif | Bin {docs/images => images}/Updater.png | Bin {docs/images => images}/Validator.gif | Bin .../images => images}/VitDeck_icon_square.png | Bin {docs/images => images}/about_vitdeck.png | Bin 11 files changed, 2 insertions(+), 71 deletions(-) create mode 100644 Assets/VitDeck/README.URL rename Assets/VitDeck/{README.txt.meta => README.URL.meta} (100%) delete mode 100644 Assets/VitDeck/README.txt rename docs/README.md => README.md (100%) delete mode 100644 docs/_config.yml rename {docs/images => images}/Expoter.gif (100%) rename {docs/images => images}/TemplateLoader.gif (100%) rename {docs/images => images}/Updater.png (100%) rename {docs/images => images}/Validator.gif (100%) rename {docs/images => images}/VitDeck_icon_square.png (100%) rename {docs/images => images}/about_vitdeck.png (100%) diff --git a/Assets/VitDeck/README.URL b/Assets/VitDeck/README.URL new file mode 100644 index 00000000..f92158a6 --- /dev/null +++ b/Assets/VitDeck/README.URL @@ -0,0 +1,2 @@ +[InternetShortcut] +URL=https://github.com/VitDeck/VitDeck-for-vket \ No newline at end of file diff --git a/Assets/VitDeck/README.txt.meta b/Assets/VitDeck/README.URL.meta similarity index 100% rename from Assets/VitDeck/README.txt.meta rename to Assets/VitDeck/README.URL.meta diff --git a/Assets/VitDeck/README.txt b/Assets/VitDeck/README.txt deleted file mode 100644 index 9b91bfc4..00000000 --- a/Assets/VitDeck/README.txt +++ /dev/null @@ -1,66 +0,0 @@ -# VitDeckについて -VitDeckは多人数で特定のルールに沿ったUnityのアセットを同時に制作するプロジェクトを支援するツールです。 -以下の機能を持っています。 -- テンプレートから作成： - - 管理者が事前に準備したテンプレート（フォルダ構成やモデル、シーンファイル等）を複製し、提出用アセットの作成を開始する -- ルールチェック： - - シーン内のオブジェクトが管理者が構成したルールに沿っているかチェックする -- 提出パッケージ作成： - - 提出用のUnitypackageを作成する -- ツールアップデート： - - テンプレートやルールの最新版を管理者のサーバーからダウンロードして更新する - -作業管理者が事前にテンプレートおよびチェック用のルールを構成した上で作業者に配布することを前提にしています。 - -# インストール方法 -[最新のリリース](https://github.com/vitdeck/VitDeck/releases/latest)のunitypackageをダウンロードし、VitDeckを使用したいUnityプロジェクトにインポートしてください。 -正しくインポートされるとUnityのメニューバーに`VitDeck`が表示されます。 - -# 各機能の使い方 -## テンプレートから作成 (Load template) -テンプレートを選んで必要事項を入力し、Loadボタンを押すとプロジェクトのAssetsフォルダ直下にテンプレートの複製が作成されます。 - -## ルールチェック (Check rule) -検証用のルールセットとベースフォルダ（提出用のルートフォルダ）を指定してCheckボタンを押すとベースフォルダ内のシーンファイルがチェックされます。（※複数シーンファイルには対応していません） - -## 提出パッケージ作成 (Export Booth) -提出用のベースフォルダを指定してExportボタンを押すと運営が設定したルールに沿っているか検証した後、フォルダ以下のアセットを全て含むunitypackageが作成されます。 - -## ツールアップデート -管理者がアップデートを構成している場合、Unityメニューバーの`VitDeck＞Info`からアップデートがあるか確認できます。 - - -# ツール構成方法 -VitDeckを配布する前に管理者が各機能を構成する方法は以下を参照してください。 -- [テンプレートの作成方法](https://github.com/vitdeck/VitDeck/wiki/MakingTemplate) -- [ルールセットの作成方法](https://github.com/vitdeck/VitDeck/wiki/MakingRuleSet) -- [エクスポート設定の作成方法](https://github.com/vitdeck/VitDeck/wiki/MakingExportSetting) -- [アップデート通知の構成](https://github.com/vitdeck/VitDeck/wiki/ConfiguringUpdateNortification) - -# 検証可能なルール -VitDeckでは検証したいルールの組み合わせとその設定をルールセットと呼ばれる単位で管理します。 -以下のルールが最初から利用でき、独自ルール（C#で記述）も定義可能です。 -- 指定のUnityバージョンで動作しているか検証 -- アセット名の使用禁止文字の検出 -- 特定のGUIDを持つアセットの検出 -- アセットの長すぎるパスの検出 -- 特定の拡張子を持つアセットの検出 -- ブースがBounds内に収まっているかの検証 -- コンポーネントのホワイトリスト検証 -- コンポーネントのブラックリスト検証 -- エラーシェーダーの検出 -- Noneになっているメッシュの検出 -- missingになっている参照の検出 - -# アンインストール方法 -プロジェクトの`Assets`フォルダ内の`VitDeck`フォルダをまるごと削除してください。 - -# 動作環境 -以下の環境でテストしています。 -- Windows 10 -- Unity 2017.4.28f1 - -# License -Copyright (c) 2019 VitDeck - -Released under the MIT license. diff --git a/docs/README.md b/README.md similarity index 100% rename from docs/README.md rename to README.md diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 6daa619c..00000000 --- a/docs/_config.yml +++ /dev/null @@ -1,5 +0,0 @@ -theme: jekyll-theme-minimal -title: VitDeck -description: -logo: /images/VitDeck_icon_square.png -show_downloads: false diff --git a/docs/images/Expoter.gif b/images/Expoter.gif similarity index 100% rename from docs/images/Expoter.gif rename to images/Expoter.gif diff --git a/docs/images/TemplateLoader.gif b/images/TemplateLoader.gif similarity index 100% rename from docs/images/TemplateLoader.gif rename to images/TemplateLoader.gif diff --git a/docs/images/Updater.png b/images/Updater.png similarity index 100% rename from docs/images/Updater.png rename to images/Updater.png diff --git a/docs/images/Validator.gif b/images/Validator.gif similarity index 100% rename from docs/images/Validator.gif rename to images/Validator.gif diff --git a/docs/images/VitDeck_icon_square.png b/images/VitDeck_icon_square.png similarity index 100% rename from docs/images/VitDeck_icon_square.png rename to images/VitDeck_icon_square.png diff --git a/docs/images/about_vitdeck.png b/images/about_vitdeck.png similarity index 100% rename from docs/images/about_vitdeck.png rename to images/about_vitdeck.png