Toggle

Name, with the style row under it.
The Builds line: what this toggle adds to the avatar when it builds.
Icon, with Capture icon at its right end.
Exclusive group, with the arrow button that lists the groups.
Default on and In menu.
The Objects section.
+ Add effect, which adds a section for another kind of effect.
The Scene preview row.

The panel ends with the Advanced fold and any messages about this toggle.

When to use it

A toggle is one button in the avatar's menu. Each press switches its effects on or off: show a hat, hide a jacket, set a face, swap a material or change a colour.

For a dial that moves its effects smoothly, use a radial.
For several toggles where only one may be on, put them in an exclusive group.
For an effect that follows another toggle, a parameter, a touch or a blend shape, with no button of its own, use a trigger.

To add a toggle, press + Toggle in the toolbar, or drag objects from the Hierarchy onto the menu tree. Each dropped object becomes its own toggle, named after the object.

Settings

The settings in the order the panel shows them.

Name

Shown in: Simple and Advanced · Default: New Toggle · Choices: any text

The text the menu shows for this toggle. Type the name and press Enter, or click outside the field.

The parameter and the layer AvatarDoc makes use the name without its colour and style tags.

Style

Shown in: Advanced, and Simple while the name has a style · Default: no style · Choices: a colour, bold, italic

The row under the name styles the whole name at once: the colour swatch, the x that takes the colour away, B for bold and I for italic. Once the name has a style, an In game line shows it the way VRChat draws it. The tree draws the styled name too.

Rich text tags

Shown in: Advanced, and Simple while the name has a style · Default: Off · Choices: On, Off

On shows the name with its tags written out, so you can style only part of it, such as <color=#ff8080>Summer</color> hat. When the tags are more than one colour plus bold and italic, the swatch and the buttons switch off, and a note asks you to go on editing the tags.

Icon

Shown in: Simple and Advanced · Default: none · Choices: any texture

The picture VRChat shows on this toggle's button. Drag a texture from the Project window onto the field.

VRChat's upload check refuses an icon larger than 256 by 256 pixels, or one that is not compressed. AvatarDoc runs the same check and shows an error before you upload.

Capture icon

Shown in: Simple and Advanced

Opens a window that draws only this toggle's own pieces and saves the picture as its icon. Icon capture window describes it.

Exclusive group

Shown in: Advanced, and Simple while the toggle is in a group · Default: empty, no group · Choices: any name, or None and the names in the arrow button's list

Toggles of one component that share a group name form a group, and only one of them can be on at a time. A name you type makes a group of this component. The arrow button at the right end lists None, this component's groups, and the groups of the other AvatarDoc components on the avatar, each with its component in brackets, such as Outfits (Mayo menu). Picking one of those joins that component's group, and a note under the field names the component, such as In the group of Mayo menu. Exclusive groups describes what a group changes.

Default on

Shown in: Simple and Advanced · Default: Off · Choices: On, Off

Starts the toggle on when the avatar loads. A toggle that starts on begins in its on state, so Blend time does not fade it in at every load. In a group, only one toggle should be Default on.

Shown in: Simple and Advanced · Default: On · Choices: On, Off

Off removes the toggle's button from the menu and frees its place there. The toggle keeps its parameter, its effects, its group and its default, so a trigger can still read it and a preset or a Flip trigger can still turn it on or off. The tree shows the row dimmed, with a no menu chip.

Objects

Shown in: Simple and Advanced, always · Default: no rows · Choices: objects of this avatar

The objects the toggle shows or hides. Drag objects from the Hierarchy onto the section. Objects describes the rows.

Blendshapes

Shown in: Simple always; Advanced once it has a row or a rule · Default: no rows · Choices: blend shapes of this avatar's meshes

The blend shape weights the toggle sets, with Capture and Hold the rest beside + Add. Blend shape rows and shape set rules describes the rows and the rules.

Materials

Shown in: Advanced; Simple once it has a row · Default: no rows · Choices: a renderer, a slot and a material

The material slots the toggle swaps while it is on. Material slots describes the rows.

Properties

Shown in: Simple and Advanced, once it has a row · Default: no rows · Choices: a renderer and a shader property

The shader values the toggle changes while it is on, such as a colour or a glow. Material properties describes the rows.

Animations

Shown in: Advanced; Simple once it has a row · Default: no rows · Choices: an animation clip, and a Path root

Your own animation clips, played together with what AvatarDoc writes for this toggle. Leave Path root empty when the clip's paths start at the avatar root. Set it to the prefab's root object when the clip was made inside a prefab.

Where the clip and the toggle's own rows change the same thing, the toggle's own value wins. While the toggle is off, everything the clip changed goes back to its value in the scene. The Scene preview row does not show custom animations, and the panel says so.

In Advanced mode, right-click a row to mark its Path root Pick by hand when copying.

Follows

Shown in: Advanced; Simple once it has a row · Default: no rows · Choices: an object, a target to follow, and Keep offset

While the toggle is on, each object in this section follows its target, for example a sword that moves from the back to the hand. Both must be part of the avatar. Keep offset is off for a new row, so the object snaps onto the target. On keeps the place the object has next to the target in the scene now.

AvatarDoc adds a VRChat constraint to the object in the avatar it uploads. An object that already has a constraint of its own is left alone, with an error.

In Advanced mode, right-click a row to mark the object or its target Pick by hand when copying, for a target a world drop holds when you copy the menu to another avatar.

+ Add effect

Shown in: Simple and Advanced

Lists every kind of effect the toggle can have, each with a one line description. Picking one adds its section. In Simple mode, the list offers Objects, Blendshapes and Properties only. A section that loses its last row goes away again.

Scene preview

Shown in: Advanced · Default: Default · Choices: Default, On, Off

Shows the toggle on or off in the Scene view, without changing anything in the build. Default returns the toggle to its own state. The preview needs NDMF's previews: turn them on under Tools > NDM Framework > Enable Previews, and turn on the AvatarDoc entry under Configure Previews.

Advanced

Shown in: Advanced, and Simple once a setting inside is not at its default · Default: closed · Choices: open, closed

The fold at the bottom of the panel. While it is closed, a dot on it shows that a setting inside is not at its default. It remembers whether you left it open. In Simple mode, the fold appears once any setting inside is not at its default, and then it shows every row.

The Advanced fold.
Platform.
Saved.
Synced.
What Synced costs.
Blend time.
The parameter's name, with the auto or custom chip after it.
Custom name.

Platform

Shown in: Advanced, and Simple once the fold shows · Default: Inherit · Choices: Inherit, Both, PC only, Quest only

Which build makes this toggle. Inherit takes the choice of the submenu the toggle sits in, or the component's Platform when no submenu sets one. A toggle that is not built on one platform still keeps its parameter there, so both platforms keep the same parameters. Different setups for PC and Quest explains how to use it.

Saved

Shown in: Advanced, and Simple once the fold shows · Default: On · Choices: On, Off

Remembers the toggle's state between avatar loads. In a group, the note Group saved and synced takes its place.

Synced

Shown in: Advanced, and Simple once the fold shows · Default: On · Choices: On, Off

Lets other players see the toggle's state. The note beside it says what it costs: +1 bit for a plain toggle, +8 bits for a number, and 0 bits when it costs nothing. Off costs no synced memory, but other players then never see the toggle change. In a group, the note Group saved and synced takes its place.

Blend time

Shown in: Advanced, and Simple once the fold shows · Default: 0 seconds · Range: 0 to 10 seconds

How long the toggle takes to fade between off and on. Blend shapes, material values and follows ease in and out instead of switching at once. A Pin row and a rule that holds the rest of a mesh still switch at once. In a group, the note Blend time is not used while the toggle is in an exclusive group. takes its place.

Parameter

Shown in: Advanced, and Simple once the fold shows · Default: automatic, the parameter prefix, a slash and the name, such as AD/Hat · Choices: automatic, or a name of your own

The value VRChat stores for this toggle. The line under it gives the type and the cost, such as Bool, 1 bit. A toggle in a group shows the group's parameter.

Custom name

Shown in: Advanced, and Simple once the fold shows · Default: Off · Choices: On, Off

On lets you name the parameter yourself, so the toggle can use or drive a parameter that already exists. A toggle in an exclusive group does not show this switch, because it always uses the group's parameter. Two fields appear: Parameter, which starts with the automatic name, and Value, the number the toggle writes while it is on, 1 for a new toggle.

A name the avatar's expression parameters already have: the toggle uses that parameter, with its own saved, synced and default settings, and adds no memory.
A name that only exists in an animator, such as one of VRChat's own: the toggle drives it without adding an expression parameter, so other players do not see it.
A name another tool on the avatar syncs, such as DocMe Skin Touch's: AvatarDoc adds the parameter itself, synced even when the toggle's Synced is off, and in that tool's type, so the menu keeps it even when the tool adds its own parameter late in the upload. A value the type cannot hold, such as 2 on a Bool, is an error.
A toggle with a custom name and no effects of its own only drives the parameter. Something else, such as your own animator or another tool that tells NDMF about its parameters, then does the work, and the panel says Drives a parameter only.
Several toggles with the same custom name share one parameter, each writing its own Value. A whole number other than 1 makes the parameter an Int, and a number with a fraction makes it a Float.
When a toggle of another AvatarDoc component on the avatar uses the same custom name, a line under the parameter says who, such as Also used by: Jacket (CatEars), with the entry and, in brackets, the object its component is on. Sharing stays allowed, so check that both mean the same thing.

What AvatarDoc builds

At upload, a toggle adds one button to the menu, one parameter (a Bool, 1 synced bit while Synced is on) and one layer to the avatar's FX animator, named AD: and the toggle's name. The layer has an off state and an on state. While the toggle is off, each object takes the opposite of its on state, and each blend shape, material and property goes back to its value in the scene, or to the off value its row sets. A toggle with Pin rows or a rule that holds the rest puts those in a layer of their own, placed after the layers other tools add. The Builds line in the panel counts all of this. Layers, Write Defaults and pinned layers explains the layers in detail.

Messages

Docs for AvatarDoc 0.7.1