Skip to content

Windows Deployment

System Requirements

Windows 10 or later, at least 2GB of available memory.

One-Click Package

Recommended for most users. The one-key package is a desktop app that automatically manages MaiBot installation, updates, startup, and configuration.

MaiBot OneKeyDownload the latest one-key package from GitHub

You can also join a QQ group and get it from the group files — see Community Groups.

After downloading, double-click the installer and follow the prompts. On first launch, the one-key package will automatically set up the Python environment and install dependencies, then walk you through a configuration wizard.

TIP

If you run into issues, check the FAQ first — most common situations are covered there.

Source Deployment

If you prefer the command line or want to contribute to development, deploy from source.

You'll need Python 3.12+ and Git first.

Install uv:

powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Clone the repository:

bash
git clone https://github.com/Mai-with-u/MaiBot.git

Navigate into the folder and install dependencies:

bash
uv sync
bash
pip install -r requirements.txt

Launch:

bash
uv run bot.py

On first launch, you'll be asked to agree to the user agreement. Type "agree" in the terminal to proceed.

Accessing WebUI

After starting, MaiBot automatically launches the WebUI service. Open your browser and visit:

http://localhost:8001

On first launch, the terminal will print the WebUI login Token, like this:

07-30 18:53:45 [WebUI] WebUI 配置文件不存在,正在创建: /MaiMBot/data/webui.json
07-30 18:53:45 [WebUI] WebUI 配置已保存到: /MaiMBot/data/webui.json
07-30 18:53:45 [WebUI] 新的 WebUI Token 已生成: QSwgc2Vu...
07-30 18:53:45 [WebUI应用] 🔑 WebUI 登录 Token: QSwgc2VucGFp77yBQ2lhbGxv772eKOKIoOODu8+JPCAp4oyS4piF
07-30 18:53:45 [WebUI应用] 💡 请使用此 Token 登录 WebUI
07-30 18:53:45 [WebUI服务] 🌐 WebUI 服务器启动中...

Copy the Token from the log and paste it into the browser login page to access WebUI. You can later view or modify the Token in data/webui.json.

Once in WebUI, follow the configuration wizard to set up models and connect platforms.

For detailed steps on configuring models and connecting to QQ, see Model Configuration and Adapters.