AnimeFunsion/modular-avatar
1
0
Fork 0
mirror of https://github.com/bdunderscore/modular-avatar.git synced 2025-05-13 22:58:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
modular-avatar/docs~/docs/intro.md
bd_ d9cbb85860
docs: documentation updates for resonite support (#1580) 
Also marks ALCOM as the recommended installation method
2025-05-12 21:04:14 -07:00

3.3 KiB
Raw Blame History

sidebar_position
1

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Modular Avatar

Modular Avatar is a suite of non-destructive tools for modularizing your avatars, and for distributing avatar components. With Modular Avatar, adding a new outfit or gimmick to your avatar is as easy as drag-and-drop!

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.

Installation

The recommended way to install Modular Avatar is using ALCOM. Installation using the VRChat Creator Companion is also supported.

If you are using 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.json
  3. Confirm the following details are displayed, then click "Add VPM Repository":
    • 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.

ALCOM Install UI

ALCOM Install Confirm UI

To update to the latest version, click the area with the version number and green arrow, then click APPLY.

ALCOM Update UI

If you are using the VRChat Creator Companion, click here:

Then, go to "manage project" for your project, and click the + next to Modular Avatar.

VCC UI

To update to the latest version, just click the green arrow in the "Latest Version" column.

Prerelease versions

:::warning

Due to bugs in VCC dependency resolution, please use ALCOM to install prerelease versions of Modular Avatar.

:::

To make prerelease versions available in ALCOM:

  1. Open "Packages" and select "ADD REPOSITORY".
  2. Enter the following value under "Enter informatino 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.

Then, in your ALCOM Settings window, enable Show pre-release packages.

Pre-release settings

The documentation for the prerelease branch can be found here.

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.

What to read next

Once you've installed MA, check out one of the tutorials below: