diff --git a/docs/docs/faq.md b/docs/docs/faq.md index dfacdd7c..ac473ea4 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -5,27 +5,6 @@ sidebar_label: FAQ # FAQ -## Can Modular Avatar be installed using the VCC? - -There is currently experimental support for installing using the VRChat Creator Companion. -You will first need to install the [VPM CLI tool](https://vcc.docs.vrchat.com/vpm/cli/), then run the following command: - -``` -vpm add repo https://vpm.nadena.dev/vpm.json -``` - -Close the VCC, if it's open already, then reopen it. You should now see a new package repository labeled `bd_` from which you can -install and update Modular Avatar. - -To install prerelease versions, use this command instead (or in addition): - -``` -vpm add repo https://vpm.nadena.dev/vpm-prerelease.json -``` - -VCC installations will become the recommended method for installing Modular Avatar once the VCC supports adding custom repositories -from the GUI. - ## Is it possible to use this to export to other formats, like VRM? While Modular Avatar does not automatically apply its transformations when you e.g. export using UniVRM or other similar tools, diff --git a/docs/docs/intro.md b/docs/docs/intro.md index ce2f1892..7e6bbe9e 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -11,13 +11,33 @@ With Modular Avatar, adding a new outfit or gimmick to your avatar is as easy as Modular Avatar's features are packaged as individual components, which can be added as needed. You can opt-in to just the features you want to use. It can automatically merge outfits onto your avatar, build an animator out of multiple components, and much more. -To install Modular Avatar, download and import the `unitypackage` file from the "Assets" section on [the latest release](https://github.com/bdunderscore/modular-avatar/releases). +## Installation -Then, check out one of the tutorials below: +The recommended way to install Modular Avatar is using the VRChat Creator Companion. After installing the VCC, click here: +* [Add Modular Avatar to VCC](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm.json) + +Then, go to "manage project" for your project, and click the + next to Modular Avatar. + +![VCC UI](vcc-install.png) + +To update to the latest version, just click the green arrow in the "Latest Version" column. + +Once you've installed MA, check out one of the tutorials below: * [Simple clothing setup](/docs/tutorials/clothing) * [Advanced clothing setup](/docs/tutorials/adv_clothing) * [Toggle an object](/docs/tutorials/object_toggle/) +* [Edit menus](/docs/tutorials/menu/) -You can also check out some of the [detailed reference documentation](/docs/reference) on individual components. +## Manual installation -Finally, if you are developing your own prefabs using Modular Avatar, check out the [page on prefab distribution](/docs/distributing-prefabs). +You can also manually install Modular Avatar from unitypackages. The latest packages can be found at the [GitHub releases page](https://github.com/bdunderscore/modular-avatar/releases). +Note that in some cases it may be necessary to delete the Modular Avatar folder before upgrading. + +## Prerelease versions + +To make prerelease versions available in the VCC, [click here](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm-prerelease.json) + +The documentation for the prerelease branch can be [found here](https://modular-avatar.nadena.dev/dev). + +Prerelease versions may contain bugs, and/or may have compatibility breaks as development progresses. Please leave +feedback and bug reports at the [github issues page](https://github.com/bdunderscore/modular-avatar/issues). \ No newline at end of file diff --git a/docs/docs/vcc-install.png b/docs/docs/vcc-install.png new file mode 100644 index 00000000..39036a92 Binary files /dev/null and b/docs/docs/vcc-install.png differ diff --git a/docs/i18n/ja/code.json b/docs/i18n/ja/code.json index c66614f6..55519be1 100644 --- a/docs/i18n/ja/code.json +++ b/docs/i18n/ja/code.json @@ -257,8 +257,8 @@ "Documentation": { "message": "説明書" }, - "Download": { - "message": "ダウンロード" + "Download (using VCC)": { + "message": "VCCでダウンロード" }, "Modular Avatar": { "message": "モジュラーアバター" diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/ja/docusaurus-plugin-content-docs/current/faq.md index 5f54ef71..d1467a64 100644 --- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/faq.md +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/faq.md @@ -5,25 +5,6 @@ sidebar_label: FAQ # FAQ -## VCCを使ってModular Avatarを導入できますか？ - -VRChat Creator Companionを使ってModular Avatarをインストールすることに当たって実験的に対応しています。 -まずは[VPM CLIを導入して](https://vcc.docs.vrchat.com/vpm/cli/)から、以下のコマンドを実行してください。 - -``` -vpm add repo https://vpm.nadena.dev/vpm.json -``` - -開いていればVCCを一度閉じて、再度開いてください。`bd_`というリポジトリーが追加されて、そこからModular Avatarをインストール・更新できます。 - -ベータ版の導入は以下のコマンドを実行してください。 - -``` -vpm add repo https://vpm.nadena.dev/vpm-prerelease.json -``` - -GUIからカスタムリポジトリを追加する対応がVCCに追加されたら、推奨インストール方法とする予定です。 - ## VRMなど、他の形式へのエクスポートでも使えますか？ UniVRMなどを使った場合は自動的に変換しませんが、手動で変換して、それでできた普通のアバターをエクスポートすることがかのうです。 diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md index 7e28069d..dc3ef5a8 100644 --- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/intro.md @@ -9,13 +9,33 @@ Modular Avatarを使えば、D&Dだけでアバターに新しい衣装やギミ Modular Avatarの機能はそれぞれコンポーネントとして提供され、必要に応じて必要な機能だけ追加できます。自動的に衣装を統合したり、複数のアセットからアニメーターを構築したり、様々な面で製作を補助します。 -Modular Avatarをインストールするには、[最新リリース](https://github.com/bdunderscore/modular-avatar/releases)のAssets項目から`unitypackage`ファイルをダウンロードして、インポートしてください。 +## インストール -その後の手順に関しては以下のチュートリアルを見てください -* [簡単な衣装セットアップ](/docs/tutorials/clothing) -* [複雑なCloth衣装セットアップ](/docs/tutorials/adv_clothing) -* [オブジェクトを出し入れしよう](/docs/tutorials/object_toggle/) +VRChat Creator CompanionでModular Avatarをインストールすることをお勧めします。VCCをインストールしたら、こちらをクリックしてください： +* [Modular AvatarをVCCに追加](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm.json) -コンポーネントごとの[詳細ドキュメンテーション](/docs/reference)もあります。 +その後、プロジェクトの"manage project"を開き、Modular Avatarの+をクリックしてください。 -また、Modular Avatarを応用したアセットを開発する場合は、[アセット配布のアドバイス](/docs/distributing-prefabs)もご確認ください。 \ No newline at end of file +![VCC UI](vcc-install.png) + +最新版にアップデートするには、"Latest Version"の緑色の矢印をクリックしてください。 + +インストール後は以下のチュートリアルを参照してください。 +* [簡単な衣装設定](/docs/tutorials/clothing) +* [複雑な衣装設定](/docs/tutorials/adv_clothing) +* [アニメーターでトグル作成](/docs/tutorials/object_toggle/) +* [簡易メニュー作成](/docs/tutorials/menu/) + +## 手動導入 + +unitypackageからModular Avatarを手動でインストールすることもできます。最新版のunitypackageは[GitHubリリースページ](https://github.com/bdunderscore/modular-avatar/releases). +にあります。アップデートする際には、Modular Avatarフォルダを削除する必要がある場合があります。 + +## テスト版 + +VCCでテスト版をインストールできるようにするには、[こちらをクリック](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm-prerelease.json) + +テスト版のドキュメントは[こちら](https://modular-avatar.nadena.dev/dev)にあります. + +テスト版は開発中のため、バグがあったり、互換性のない変更を加える可能性があります。 +バグ報告やフィードバックは[GitHubのissueページ](https://github.com/bdunderscore/modular-avatar/issues)へお願いします。 \ No newline at end of file diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/vcc-install.png b/docs/i18n/ja/docusaurus-plugin-content-docs/current/vcc-install.png new file mode 100644 index 00000000..39036a92 Binary files /dev/null and b/docs/i18n/ja/docusaurus-plugin-content-docs/current/vcc-install.png differ diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 4776f7c2..ac7d3167 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -35,8 +35,8 @@ function HomepageHeader() { - Download + to="vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm.json"> + Download (using VCC)