Return
to top
WELCOME!
Vtuber Kit
Created by Kyuppin

This User Guide is up to date as of version 0.1.96b

"Download vTuber Kit for free using the Itchio link below! Then scroll down to start learning how to use the app!"


Download



Topics
Quick Start
    Welcome to vTuber Kit!
    Tracking
    Capturing
    Controls

Hair
    Introduction
    Options
    Parts

Face
    Introduction
    Options
    Parts

Clothing
    Introduction
    Options
    Parts

Accessories
    Introduction
    Options
    Parts

Custom Items
    Introduction
    Custom Items
    Options

Live Settings
    Introduction
    Save/Load Position
    Save/Load Design
    Interactivity Shortcuts

Twitch Settings
    Introduction
    Connection
    Redeems

Model Settings
    Introduction
    vTuber Variables
    Mouth Variables
    Eyes Variables
    Doodle Effect

App Settings
    Introduction
    Game Capture
    Devices & More
    UI Settings
    Window Settings
    Miscellaneous Settings
    Spout Capture
    Virtual Camera
    Data Stuff

Miscellaneous
    Introduction
    Color Picker
    Unmoving Plaid
    Capture Methods

Credits
    Contributors
    Plugins
    More
QUICK START
Behold!
This is what you will be feasting your eyes upon when you open the program for the first time.

Tracking
vTuber Kit defaults to webcam tracking. It should automatically grab your default webcam and microphone and start tracking your face. Give it a test by moving your face around and opening your mouth or talking.
If the model has its eyes closed or is unresponsive, go to the Gear tab in the top left and under the "Devices & More" section, make sure your desired webcam and microphone are selected.
vTuber Kit also offers mouse tracking! Almost directly below the the camera and microphone options is an option to turn on mouse tracking.

Capturing
Now that vTuber Kit is tracking, we can set up capturing the program in OBS.

By far, the easiest and quickest method of capturing vTuber Kit is to use a Game Capture Source. In OBS, find your sources window and add a new game Capture source. Name it "vTuber Kit" and click OK. A new window will pop up. Change Mode to "capture specific window", select the vTuber Kit window, and check the "allow transparency" box.
And that's it! vTuber kit should be in your OBS scene now, with the background automatically removed.

I recommend sizing the vTuber Kit source to be the same size as the scene. So if you have a 1920x1080 scene, use the same size for vTuber Kit, or an equal ratio. Then resize vTuber kit so it fits the entire scene. You can also right-click the vTuber Kit source and go to Transform > Fit to screen.
Finally, while you have vtuber Kit window active, you can press Esc to hide the side panels. That's it! You're all set to stream.

Keep in mind that this was the quick and easy way. You can find better methods in the Capture Methods section.

Controls
Here are some simple and important controls for controlling your model.

Esc

Hides the UI panels.

Right Click & Drag

Move the model around the screen.

Mouse Wheel / Up & Down Arrow Keys

Zoom in/out on the model.

Mouse Wheel Click / Spacebar

Resets to the model's base/saved position and zoom.


"That's it for the basics! Now it's time to customize your model!"
HAIR
Introduction
Most tabs in vTuber kit will have overall options at the top, and then more tabs underneath with sub-categories of options. First, we'll be looking at the hair tab and all hair-related things. Let's jump into it!

Options
Base

This is the base color of the hair. Click this, or any other color box and a color picker will appear, allowing you to change the base color of the hair.

Shading

Use this to color the hair's shading. Each hair part has a built-in shading layer.

Shading Transparency

This slider controls the transparency of the hair's shading color. Set this to 0 for no hair shading and 1 for completely opaque.

Bangs Visibility

These checkboxes control whether individual bangs are shown or hidden. Bangs that have 3 pieces will only utilize the 3 middle checkboxes.

Gradient

Click the gradient button and the panel will expand to show options for back hair, side tails, bangs, and tied hair.

The height sliders define the how quickly the gradient changes from one color to the next, with lower numbers being more sudden transitions. The position sliders define how high the transition begins, with lower numbers starting at the bottom of the hair.

I recommend playing around with these values to get a feel for it, as some are more finnicky than you'd expect. But generally, you want to adjust the height slider until you can see the gradient. Next, adjust the position slider to line up the gradient color to where you want it. Then finally, adjust the height slider again for precise control on how far the transition goes.

Parts
vTuber Kit has 5 different options for hair. Each can be changed individually so you can mix and match for more customization.

Back Hair

The hair at the back, displayed behind the head.

Bangs

The hair that appears in front of the face. These can be turned on/off individually as explained in the Bangs Visibility section.

Side Hair

The hair that rests at the left and right side of the face, behind the bangs.

Tails

Hair that tied up or sticks out from the sides of the Back Hair.

Ahoge

This is the little tuft of hair that sticks up from the top of the model's Back Hair.

"You can even turn all of the hair off to become bald, like me!"

FACE
Introduction


Options
Skin

Your model's skin color.

Outline

The outline color of the model. This affects all outlines for all parts, not just the body.

Mouth

The color of the inside of the mouth.

Iris

The color of the iris, the colored part of the eye around the pupil.

Pupil

The color of the pupil, the center of the eye.

Sclera

The color of the eye around the iris.

Heterochromia

Clicking this button will expand the eye options giving you a 2nd set of the eye colors so you can control each eye individually.

More Eye Options

Clicking this button will open a separate menu. Here you can find some additional eye options. You can change the scaling of the pupils, the scaling of the eyes as a whole, and change the eye's positions.

"Try using the pupil X scaling to give your characters skinny eyes. Useful for appearing like a cat!"

Parts
Eyes



Mouth



Ears



Eyebrows



CLOTHING
Introduction
Options
Primary Color

Secondary Color

Unmoving Plaid

Parts
Outfits

Tops

Bottoms

Socks

ACCESSORIES
Introduction
Options
Primary Color

Secondary Color

Unmoving Plaid

X Pos

Y Pos

Squish

Freeze Tail

Parts
CUSTOM ITEMS
Introduction
Custom Items
Creation

To create a new custom item, click the plus button. This will spawn in a new custom item with the default onionbug sprite. It will spawn attached to the base of the model at the center of the body.

Controls

When you spawn a new custom item, click on an existing custom item directly, or click the custom item in the panel, some on-screen controls will be displayed.

You are able to click and drag on the square in the middle of the controls to scale the item. You can also click on the circle and drag 360 degrees to rotate the object.

Management

Delete

On/Off

Options
Z-Axis

Rotation

Scale

Flip

Move

Attach

Clone

Hide Pinned Sprite

Jiggly Sprite

Freeze Model

MISCELLANEOUS
Introduction
This section explains various aspects of vTuber kit. Whether they can be considered supplementary, or I wanted them in one place to link to throughout the User guide. There's some helpful stuff in here.

Color Picker
The color picker will pop up whenever you click on a color box.

Click and drag inside the rainbow colored part to select a color. Use the shade slider to the right of it to control how light/dark the colors will be.

You can also input a color hex directly at the bottom. press enter to confirm the color.

Finally, you can use the color dropper button in the bottom right to pick a color within vTuber kit. This feature does not work to capture colors on your desktop. Click the color dropper button and then left click over the color you want. The color dropper will show a zoomed-in view so you can be sure about the color you're selecting.

To close the colow picker, click the X at the top, press the Esc button, or click anywhere else in the window.

Unmoving Plaid
What Is It?

Unmoving plaid is a repeating texture that stays stationary and fills certain areas of the vTuber Kit model. For example: Chowder, Gankutsuou, and Sayonara Zetsubou Sensei make use of this technique. If it helps, think of it as just a textured color you're adding to the model.

How To Use

Click the Unmoving Plaid button in Vtuber Kit to open the image panel. Click the plus button and choose the image you'd like to use. Make sure that image is selected and it should appear on the model.

Click the same texture to turn the unmoving plaid off. You can have multiple unmoving plaid textures loaded into vTuber Kit. Use the mouse wheel to scroll through them all. At this time, you cannot remove textures. Removing the textures in the save data will result in unexpected errors so please exercise caution when editing any files in the save data folder.

Capture Methods
Spout Capture

Game Capture

Virtual Camera Capture