Skip to main content

Installation

This guide will help you install Miku on your local environment or server.

System Requirements​

  • Python: Version 3.10 or higher.
  • Git: To download source code and enable auto-updates.
  • NVIDIA API Key: Required to use LLM models.
  • Discord Bot Token: Obtain from the Discord Developer Portal.

Installation Steps​

1. Download Source Code​

Use Git to clone the repository to your machine:

git clone hhttps://github.com/akikohatsune/MikuMaid_reborn.git
cd Miku

Using a virtual environment helps isolate project libraries:

# Windows
python -m venv .venv
.venv\Scripts\activate

# Linux/macOS
python3 -m venv .venv
source .venv/bin/activate

3. Install Dependencies​

The project uses requirements.txt to manage dependencies:

pip install -r requirements.txt

4. First Run​

Upon the first run, the bot will automatically create a .env file from .env.example:

python main.py

After running, the bot will report a missing API Key. This is when you need to configure the environment variables in the .env file.