Docs/add installation alcom prerelease (#1579)

* 📝ALCOMを使用したテスト版のインストール手順について記載

* 📝  alcomでのプレリリース版を選択する画像を追加
📝 インストール手順の構造を更新
This commit is contained in:
Kazuki Y. 2025-05-11 21:28:17 +09:00 committed by GitHub
parent 3f08117960
commit 20496a9f59
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 98 additions and 30 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 220 KiB

View File

@ -13,7 +13,10 @@ you want to use. It can automatically merge outfits onto your avatar, build an a
## Installation
### Install via VCC
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.
@ -22,30 +25,16 @@ Then, go to "manage project" for your project, and click the + next to Modular A
To update to the latest version, just click the green arrow in the "Latest Version" column.
## Prerelease versions
To make prerelease versions available in the VCC, [click here](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm-prerelease.json)
Then, in your VCC Settings -> Packages window, uncheck the `bd_` repository, check the `bd_ prerelease` repository, and enable `Show pre-release packages`.
![Pre-release settings](prerelease.png)
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).
## Installation via ALCOM
### Install via ALCOM
If you are using [ALCOM](https://vrc-get.anatawa12.com/en/alcom/) to install Modular Avatar, follow these steps:
1. Open "Packages" and select "ADD REPOSITORY".
2. Enter the following values under "Enter informatino about the repository" and click "ADD REPOSITORY":
- Stable: `https://vpm.nadena.dev/vpm.json`
- Prerelease: `https://vpm.nadena.dev/vpm-prerelease.json`
2. Enter the following values under "Enter information about the repository" and click "ADD REPOSITORY":
* `https://vpm.nadena.dev/vpm.json`
3. Confirm the following details are displayed, then click "Add VPM Repository":
- Repository Name: `bd_` or `bd_ (prereleases)`
- URL: The URL you entered.
* Repository Name: `bd_`
* URL: The URL you entered.
Afterward, open "Manage Project" for your project, click the + next to Modular Avatar, and then click `APPLY`.
@ -57,10 +46,52 @@ To update to the latest version, click the area with the version number and gree
![ALCOM Update UI](alcom-update.png)
## Prerelease versions
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).
### Install Prerelease versions via VCC
To make prerelease versions available in the VCC, [click here](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm-prerelease.json)
Then, in your VCC Settings -> Packages window, uncheck the `bd_` repository, check the `bd_ prerelease` repository, and enable `Show pre-release packages`.
![Pre-release settings](prerelease.png)
### Install Prerelease versions via ALCOM
If you are using [ALCOM](https://vrc-get.anatawa12.com/en/alcom/) to install Modular Avatar, follow these steps:
1. Open "Packages" and select "ADD REPOSITORY".
2. Enter the following values under "Enter information about the repository" and click "ADD REPOSITORY":
* `https://vpm.nadena.dev/vpm-prerelease.json`
3. Confirm the following details are displayed, then click "Add VPM Repository":
* Repository Name: `bd_ (prereleases)`
* URL: The URL you entered.
4. When you currenly uses stable version, In your ALCOM Packages window, uncheck `bd_` repo and check `bd_ (prereleases)` repo.
5. In your ALCOM Settings window, enable `Show Prerelease Packages`.
![ALCOM Change Repogitories UI](alcom-prerelease-repo.png)
![ALCOM enable Prerelease UI](alcom-prerelease-settings.png)
Afterward, open "Manage Project" for your project, click the + next to Modular Avatar, and then click `APPLY`.
![ALCOM Install UI](alcom-install.png)
![ALCOM Install Confirm UI](alcom-install-confirm.png)
To update to the latest version, click the area with the version number and green arrow, then click `APPLY`.
![ALCOM Update UI](alcom-update.png)
## What to read next
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/)

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 305 KiB

View File

@ -11,7 +11,10 @@ Modular Avatarの機能はそれぞれコンポーネントとして提供され
## インストール
### VCCでのインストール
VRChat Creator CompanionでModular Avatarをインストールすることをお勧めします。VCCをインストールしたら、こちらをクリックしてください
* [Modular AvatarをVCCに追加](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm.json)
その後、プロジェクトの"manage project"を開き、Modular Avatarの+をクリックしてください。
@ -20,33 +23,67 @@ VRChat Creator CompanionでModular Avatarをインストールすることをお
最新版にアップデートするには、"Latest Version"の緑色の矢印をクリックしてください。
### ALCOMでのインストール
[ALCOM](https://vrc-get.anatawa12.com/ja/alcom/)でModular Avatarのインストールを指定する場合があります。
インストール後、以下の手順でVPMリポジトリを追加してください。
* 「パッケージ管理」 > 「VPMリポジトリを追加」
* 「リポジトリ情報を入力」に次の値を入力し、「VPMリポジトリを追加」
* `https://vpm.nadena.dev/vpm.json`
* 以下の情報が記載されることを確認し、「VPMリポジトリを追加」
* リポジトリ名: `bd_`
* URL: 入力したURL
その後、プロジェクトの"管理"を開き、Modular Avatarの+をクリックし、「適用」をクリックしてください。
![ALCOM Install UI](alcom-install.png)
![ALCOM Install Confirm UI](alcom-install-confirm.png)
最新版にアップデートするには、バージョン番号と緑色の矢印を囲った枠内をクリックし、「適用」をクリックしてください。
![ALCOM Update UI](alcom-update.png)
## テスト版
テスト版のドキュメントは[こちら](https://modular-avatar.nadena.dev/dev)にあります.
テスト版は開発中のため、バグがあったり、互換性のない変更を加える可能性があります。
バグ報告やフィードバックは[GitHubのissueページ](https://github.com/bdunderscore/modular-avatar/issues)へお願いします。
### VCCでのテスト版インストール
VCCでテスト版をインストールできるようにするには、[こちらをクリック](vcc://vpm/addRepo?url=https://vpm.nadena.dev/vpm-prerelease.json)
そして、VCCの設定画面のPackagesタブで、`bd_`のリポジトリをチェックを外し、`bd_ prerelease`のリポジトリをチェックを入れ、`Show pre-release packages`にチェックを入れてください。
![Pre-release settings](prerelease.png)
テスト版のドキュメントは[こちら](https://modular-avatar.nadena.dev/dev)にあります.
テスト版は開発中のため、バグがあったり、互換性のない変更を加える可能性があります。
バグ報告やフィードバックは[GitHubのissueページ](https://github.com/bdunderscore/modular-avatar/issues)へお願いします。
## ALCOMでのインストール
### ALCOMでのテスト版インストール
[ALCOM](https://vrc-get.anatawa12.com/ja/alcom/)でModular Avatarのインストールを指定する場合があります。
インストール後、以下の手順でVPMリポジトリを追加してください。
* 「パッケージ管理」 > 「VPMリポジトリを追加」
* 「リポジトリ情報を入力」に次の値を入力し、「VPMリポジトリを追加」
* 通常版: `https://vpm.nadena.dev/vpm.json`
* テスト版: `https://vpm.nadena.dev/vpm-prerelease.json`
* `https://vpm.nadena.dev/vpm-prerelease.json`
* 以下の情報が記載されることを確認し、「VPMリポジトリを追加」
* リポジトリ名: `bd_` もしくは `bd_ (prereleases)`
* リポジトリ名: `bd_ (prereleases)`
* URL: 入力したURL
その後、プロジェクトの"管理"を開き、Modular Avatarの+をクリックし、「適用」をクリックしてください。
VPMリポジトリの追加が完了したら、テスト版が表示されるように変更します。
* (現在「通常版」を使用している場合は)「パッケージ管理」タブで、`bd_`リポジトリのチェックを外し、`bd_ (prereleases)`リポジトリのチェックを入れてください。
* 「設定」タブで、 `VPMパッケージ` の中にある `プレリリース版のパッケージを表示する`にチェックを入れてください。
![ALCOM Change Repogitories UI](alcom-prerelease-repo.png)
![ALCOM enable Prerelease UI](alcom-prerelease-settings.png)
終わったら、プロジェクトの"管理"を開き、Modular Avatarの+をクリックし、「適用」をクリックしてください。
![ALCOM Install UI](alcom-install.png)