Created by Kyuppin

This User Guide is up to date as of version 0.1.97

THIS GUIDE IS STILL A WORK IN PROGRESS. MUCH OF IT IS STILL INCOMPLETE. PLEASE USE THE ITCHIO FORUMS IN THE MEANTIME.






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 Overview
    Headpats
    Throw Items
    Falling Items
    Wildcard
    Nose Boops

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
    Texture Options
    Capture Methods
    Legacy Objects

Credits
    Contributors
    Plugins
    More

This is what you will be feasting your eyes upon when you open the program for the first time.

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.

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.

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


Hides the UI panels.


Move the model around the screen.


Zoom in/out on the model.


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

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!


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.


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


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


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

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.

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


The hair at the back, displayed behind the head.


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


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


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

Hair tails turn on with bows by default. To learn how to change/remove those, check the Legacy Objects section.


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

Your model's skin color.


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


The color of the inside of the mouth.


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


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


The color of the eye around the iris.


Below the color options, you will find a bunsh of sliders that let you control the look and feel of your model's eyes. You can scale pupils on X/Y axes, you can scale the overall eyes on X/Y axes, and finally, you can control the X/Y position of the eyes so they can be right where you want them.


Clicking this button will toggle on/off the 2nd set of the eye color options so you can set each eye's iris, pupil, and sclera colors individually.


Clicking this button will replace the Eye Sliders with Brow Sliders. Using these sliders, you can set the rotation of the eyebrows, as well as their X/Y scale and position.



Eyes come in various shapes, from the original cartoony round style to a couple more anime styled options.


vTuber Kit's mouths each have 5 sprites they cycle through depending on how you have your Mouth Variables configured. Each mouth is unique and offers a different feel.


There are multiple types of ears to choose from, from big round ones, to pointy uppy and downy ones!


There are no eyebrow parts quite yet, but you can easily use custom objects to attach your own eyebrow designs!

vTuber Kit comes with a (admittedly lacking...) selection of clothing to keep your model safe and family friendly! No nakedness around here. In fact, vTuber Kit even comes with censor bars, in case you are naked! Uh... Anyways! On to the options!


The primary color of the clothing. Each piece of clothing has a primary color.


A secondary color. Not every piece of clothing will have a secondary color, so you'll have to experiment to see if editing this does anything.


Texture Options gives you the option to add textures to clothing. You can also unfreeze the textures so they move with the clothing for a realistic effect. For more info on this, you can check the Texture Options section.


The first tab in the clothing section is for outfits. Outfits come with a top and a bottom and replace any other clothing currently active. vTuber Kit can either have an outfit active or a top & bottom combo active. Outfits cannot be combined with tops/bottoms.


The second tab is for tops. Here you'll find various clothing that covers the torso.


The third tab is for bottoms. Here you'll find various clothing that covers the legs.


The fourth and final tab is for socks. Socks come in many varieties and follow the movement of the legs.

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.


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.

vTuber Kit comes pre-loaded with some fun animations and effects that can be set to trigger when certain things happen on Twitch. First, we'll cover how to connect vTuber Kit to Twitch.

In order to connect to Twitch, you have to enter information about your account so we can connect to the API and receive information from your channel. Follow along below to get connected.


This is your Twitch username, nothing tough about this one.


Click the "Find My Channel ID" button here to open a webpage where you can easily find your Channel ID. At the loaded webpage, enter your Twitch username in the box and press the "Check" button. Your Channel ID will be displayed under the prompt.Copy and paste that into vTuber Kit.


DO NOT SHARE THIS CODE. DO NOT GENERATE THIS CODE ON STREAM. KEEP THIS SECRET.

An O-Auth code is what allows applications to read the data from your Twitch stream. Generating this will allow vTuber Kit to read information regarding your channel.

Click the "Generate OAuth Key" button here to open a webpage where Twitch will ask for your permission to give vTuber Kit access to read certain information about your channel. Take note that vTuber Kit only asks for permissions to read chat, get channel point redeem info, and get bit donation info.

Authorize vTuber Kit and you will be brought to a webpage with a generated key. Copy that key in its entirety and paste it into vTuber Kit. This key will always be censored in vTuber Kit so it can't be easily seen.



Once you have those three boxes filled, click the "Restart" button at the bottom of the panel. vTuber Kit will restart and attempt to connect to Twitch. If the connection was successful, your redeems will be working! So, let's move on to setting those up so you can test them out!

There are five functions (redeems) in vTuber Kit which can be triggered by various Twitch interactions. This section will give general information that applies to all of their options, and then specific information about each redeem can be found below. Keep in mind that you need to be a Twitch Affiliate or Partner for things like subs, channel points, or bits redeems to work.

Each redeem has its own corresponding tab, and a lot of the options are similar since they are all set up the same way. let's go over the similar options now.


This is the name of the channel point redeem you've set up for your channel. Any time someone from your channel redeems a channel point with this name, this redeem will trigger. This is case sensitive and must be exactly the same as it's displayed on Twitch otherwise it won't trigger.


Chat commands are triggered by viewers just by typing an exclamation point followed by the chosen command. For example, "!headpat". Don't include the exclamation point in the name, it is implied. The good thing about chat commands is anyone can use them, you don't need to be an Affiliate or Partner.


Since viewers can spam chat with commands, the chat commands come with a built-in cooldown which you can set however you want. When a command is put in chat, the cooldown will start. If a command is entered in chat while the cooldown is still running, it will be ignored.


If not set to zero, getting a subscriber will trigger a redeem X number of times. So, if you have the headpat sub redeem set to 5, when you get a sub, you will automatically get headpatted 5 times. Note that this will trigger for regular subs, gifted subs, re-subscribers, prime subs, etc. Any kind of sub basically. If you have multiple redeems set up to trigger with subs, they will all trigger simultaneously, which could lead to quite the spectacle, encouraging more subs.


If not set to zero, getting a bits donation can trigger a redeem. Bits work a bit different than subs, since they're much cheaper to use. You have more granular control over them. You can set the minimum number of bits to trigger a set amount of redeem. So for example, if you have the headpat redeem set as "for every 5 bits, redeem 2 headpats", and then you're cheered 50 bits, you will get headpatted 20 times. Wow, math! If you have multiple redeems set up to trigger with bits, they will all trigger simultaneously, which could lead to quite the spectacle, encouraging more cheers.


Most of the redeems have some sort of sound associated with them. The volume slider gives you individual control of those sounds.

This section explains various aspects of vTuber kit. Whether they can be considered supplementary, or just more of a glossary of things that didn't fit anywhere else. I really just wanted a place to link to them throughout the User guide. There's some helpful stuff in here!

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.


Texture Options let you use 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.


Click the Texture Options 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 texture off. You can have multiple 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.







Legacy Objects are some of the oldest accessories of vTuber Kit, from the good ol days before custom objects and all this newfangled technology-- Er, anyways, they're basically leftovers! They're images that can be swapped by changing PNGs in the vTuber kit reference files instead of doing everything directly in the program. They should really be removed, but some people still use them so I decided to leave them in. There are a few of them, explained more in detail below.


Legacy Objects can be found by going to the Settings (Gear) Tab in the top-left of vTuber Kit, and then scrolling down to and pressing the "open save data" button. In the window that opens, you'll find a folder named "Legacy Objects". Double click that to find the three Legacy Objects.


Editing the Legacy Objects is easy as they're just regular PNG images that vTuber Kit loads at runtime. You're most likely reading this section to change the hair bows, so let's use that as an example. If you want to get rid of those bows, open that PNG in an image editing program, erase the entire canvas, and then save it as a blank image.

DO NOT DELETE THE IMAGE FILE. Deleting the file entirely will probably cause issues for vTuber Kit, so be careful.

The other two images in there can also be changed, but it's probably much easier to use custom objects in the program to do their job for them. For example, you can attach a custom object to the choker charm or directly to the t-shirt and the same effect will be achieved.