Skip to content

huangdihd/xinbot

Repository files navigation

Xinbot

logo

📖 Official Documentation: xinbot.shouldbe.top

Latest Release Issues License Stars jitpack commit activity


A lightweight, highly modular Minecraft bot framework.

English / 简体中文

Demonstration

asciicast

⚠️ Important Note

Starting from 2.0.0, Xinbot must have a MetaPlugin installed to start and interact with the server. The purpose of a MetaPlugin is to handle server-specific interaction logic (such as login handshakes, auto-reconnect, etc.), allowing the core framework to remain generic.

You can find the official MetaPlugin implementation for 2b2t.xin here: xinMetaPlugin.

Features

  • Vibrant logs: parse and render messages just like the official client.
  • Secure login: use your legit Minecraft account with confidence.
  • MetaPlugin Architecture: core interaction logic is decoupled, enabling support for various server types via MetaPlugins.
  • Plugin architecture: extend behavior with a familiar Bukkit-style event system.
  • Internationalization: support for multiple languages and bootstrap error reporting.

Quick Start

Please refer to the documentation site.


Modpacks

A modpack bundles a set of plugins and language files into a single .zip so a ready-to-use setup can be shared and installed in one step. A modpack never contains config.conf, so account credentials and sessions are never shipped.

Archive layout:

example-modpack.zip
├── modpack.yml          # manifest (name & version required)
├── plugins/             # plugin jars -> installed into the plugin directory
│   └── *.jar
└── lang/                # optional .lang overrides -> installed into ./lang/
    └── *.lang

modpack.yml:

name: "2b2t.xin Survival Pack"   # required
version: "1.0.0"                  # required
author: "huangdihd"              # optional
description: "..."               # optional
xinbotVersion: ">=2.2.0"         # optional, informational
plugins: [PluginA, PluginB]       # optional, informational

CLI sub-commands (run instead of starting the bot):

java -jar xinbot.jar --install <file.zip>       # install a modpack into ./plugin and ./lang
java -jar xinbot.jar --export <out.zip>         # pack current plugins + lang files into a modpack
java -jar xinbot.jar --modpack-info <file.zip>  # print a modpack's manifest
java -jar xinbot.jar --help                     # list all sub-commands

Installing overwrites existing files of the same name (with a warning) and ignores any archive entry outside plugins/ and lang/. The plugin directory is read from config.conf when present, otherwise the default plugin/ is used.


Community

  • QQ Group: 434173700 — main community for users and players
  • Telegram: t.me/xinbot_develop
  • Issues: bug reports and feature requests are welcome on GitHub Issues

License

GPL-3.0-or-later, see LICENSE for the full text.

If you like Xinbot, a star goes a long way!

Made with ❤️ by huangdihd

About

A Minecraft Bot Client for Anarchist Servers

Topics

Resources

License

Stars

30 stars

Watchers

2 watching

Forks

Packages

 
 
 

Contributors