Minecraft UniBot Docs

English

简体中文

English

简体中文

Appearance

UniBot Core

Copy page

About 476 wordsAbout 2 min

UniBot is the core bot of Minecraft UniBot, built on the NoneBot2 framework, responsible for communicating with chat platforms and multiple Minecraft servers. UniBot is fully compatible with the NoneBot2 ecosystem, can seamlessly integrate with the NB Plugin Store, and can directly use community-ready plugins.

Quick Navigation

Configuration Guide

All configuration items including .env and Config.toml

Extension System

Extension types, manifest, states, and rendering system

Architecture

Dive into the project structure

REST API

WebUI backend API reference

Developing Extensions

Write your own UniBot extensions

Publish to Marketplace

Publish your extension to the extension marketplace

Tech Stack

CategoryTechnology
FrameworkNoneBot2 (FastAPI driven)
Command ParsingAlconna
Session Infouninfo
Data ValidationPydantic
HTTP Clienthttpx
Image RenderingJinja2 (template) + html2pic / Playwright (engine)
AuthenticationJWT + bcrypt
FrontendVue 3 + Vite + Pinia

Tech Stack Overview

Core Capabilities

  • Cross-platform Messaging: one set of command logic, universal across all platforms.
  • Multi-server Interconnect: connect to multiple servers simultaneously, forwarding messages between them.
  • Extension System: five types of extensions — commands, services, rendering engines, templates, and resources — enabled/disabled on demand with failure isolation.
  • WebUI Admin Panel: visual configuration, monitoring, logs, and extension management.
  • Image Rendering: render command output as polished images, with freely combinable templates and engines.
  • Whitelist Management: bind platform accounts to game IDs.
  • NoneBot2 Ecosystem: seamless integration with the NB Plugin Store; community plugins are plug-and-play.

Directory Structure

Bot.py# Bot entry point

Watchdog.py# Watchdog process (auto-restart)

Config.toml# Bot configuration

Config

Data# Data persistence (JSON)

Logs# Runtime logs

Extensions# Extension packages (local / marketplace)

Plugins# NoneBot plugins (command modules)

Scripts# Core scripts

WebUi# Vue 3 admin panel frontend

Startup

UniBot has two entry points:

  • Bot.py: runs the bot process directly.
  • Watchdog.py: a watchdog process that monitors abnormal bot exits and restarts automatically, and handles WebUI restart requests (dependency sync runs inside the bot process via the Task Center).

We recommend launching with Watchdog.py:

uv run Watchdog.py