New here? Start from this page and complete a minimal deployment step by step.
Guide
About 530 wordsAbout 2 min
Welcome to Minecraft UniBot. This guide serves as the user manual, helping you install the bot and get started quickly. For deeper configuration, jump to the Configuration Guide.
If you're a first-time user, start with the "Quick Start", follow the steps to complete deployment; consult the other pages as needed.
Where to Start
All built-in commands and their usage, checkable at a glance.
All capabilities including group-server interop, image rendering, WebUI, and the extension system.
Visual configuration, real-time monitoring, server / player management, and log viewing.
Render command output into beautiful image cards, powered by rendering engine, template, and resource extensions.
Need to dig deeper into configuration? All configuration items for .env and Config.toml are covered here.
Understand the overall architecture and how components communicate with each other.
Learn about the extension mechanism and combine bot capabilities like building blocks.
Documentation Navigation
| Section | Content | Target Audience |
|---|---|---|
| Quick Start | Complete deployment in five steps | First-time users |
| Command Reference | All built-in commands and usage | All users |
| Features | Group-server interop, image rendering, WebUI, extension system and more | Users who want to know all capabilities |
| WebUI Admin Panel | WebUI page functions, how to enable it, and FAQ | Users of WebUI |
| Image Rendering | Enabling, configuring, and customizing image mode | Users who want image output |
| Configuration Guide | Detailed reference for all configuration items such as .env and Config.toml | Users who need deeper configuration |
Documentation Navigation
Configuration Guide: detailed reference for all configuration items such as
.envandConfig.toml, see Configuration Guide.
Project Components
This project consists of multiple sub-projects, each responsible for one part:
| Sub-Project | Role | Documentation |
|---|---|---|
| UniBot | Core bot, responsible for communicating with chat platforms and multiple servers | Architecture Design |
| MC Adapter | NoneBot's MC protocol adapter, the communication bridge | Adapter Documentation |
Project Components
About QueQiao: QueQiao is a third-party communication protocol officially maintained by 17TheWord / QueQiao, supporting multiple server platforms such as MCDReforged, Spigot, Paper, Fabric, and Forge. UniBot interconnects with QueQiao through the MC Adapter.