Skip to main content

Installation and Deployment

info

Web mode, Window mode, and Pet mode share the same code repository and project structure. Developers/users only need to maintain/configure one set of code to support deployment and use of all modes.

tip

For Electron applications, you can download the installation package for your platform from Github Release.

If you want to build the application from source code, please follow these steps:

Prerequisites​

  • Node.js 18.0 or higher (check version by running node -v). It's recommended to use nvm to manage multiple Node.js versions

Clone the repository and install dependencies​

git clone [placeholder]
cd [placeholder]
npm install

Project Structure​

umaxing-vtuber-web/
├── resources/
├── src/
│   ├── main/
│   │   ├── index.ts
│   │   ├── menu-manager.ts
│   │   └── window-manager.ts
│   ├── preload/
│   │   ├── index.d.ts
│   │   └── index.ts
│   └── renderer/
│       ├── public/
│       └── src/
│           ├── assets/
│           ├── components/
│           │   ├── canvas/
│           │   ├── electron/
│           │   ├── footer/
│           │   └── sidebar/
│           │       └── setting/
│           ├── context/
│           ├── hooks/
│           │   ├── canvas/
│           │   ├── electron/
│           │   ├── footer/
│           │   └── sidebar/
│           │       └── setting/
│           ├── services/
│           ├── types/
│           ├── App.tsx
│           └── main.tsx
├── electron.vite.config.ts
└── package.json

Development Mode (Optional, typically used for developer testing)​

npm run dev
info

npm run dev will start both Electron and Web modes (default on port 5137)

Choose the appropriate build command based on the target platform/mode​

npm run build:win
info

The output files for Electron builds will be located in the dist directory.

The output files for Web builds will be located in the src/renderer/dist directory.