Setup

This guide will help you get started with the setup of an application.

Prerequisites

Before you start, make sure you have the following installed:

To install the package, run the following command:

npm

pnpm

npm install -g vtubers

To create a new application, run the following command:

Basic Template

With a Specific Template

No Template

vtubers create my-app # Replace my-app with your app name

What is a template?

A template is a pre-configured project that you can use to get started quickly. You can find templates on the GitHub repository.

If you added --no-template, the cli will create a basic vtubers.config.ts file for you.

On This Page