Getting Started

This chapter will guide you through the basic installation, configuration, and first run of Xinbot.

1. Download Core & MetaPlugin

Starting from version 2.0.0, Xinbot requires a MetaPlugin to handle server-specific interaction logic. A Xinbot instance must have exactly one MetaPlugin loaded to run properly.

1. Xinbot Core: Get the latest client from GitHub Releases: Xinbot Releases Download the file named ....
2. MetaPlugin: Download the MetaPlugin designed for your target server (e.g., 2b2t.xin): xinMetaPlugin Releases
   Check our Plugin List to find a plugin compatible with your server. Place the downloaded MetaPlugin JAR into the plugin folder (which you can configure in step 3).

2. Install Java

Xinbot requires Java 17 or newer to run. Check your Java version with:

java -version

3. Basic Configuration

Create a file named config.conf in the same directory as the JAR. Below is a typical HOCON configuration example:

💡 Pro Tip

Don't want to write HOCON manually? Use our Configuration Generator to create your config file in seconds!

{
    "account" : {
        "fullSession" : null,           // Auto-generated by Xinbot; leave empty
        "name" : "[Bot name]",          // Bot username
        "onlineMode" : false,           // true = official account login
        "password" : ""                 // Bot's login password for the server
    },
    "enableTranslation" : true,         // Language file loading (higher memory usage)
    "reconnectTimeout" : 5000,          // Reconnection timeout (ms)
    "reconnectDelay" : 3000,            // Reconnection delay (ms)
    "owner" : "[Owner name]",           // Bot owner's name
    "plugin" : {
        "directory" : "plugin"          // Plugin directory
    },
    "proxy" : {
        "enable" : false,               // Whether enable proxy
        "info" : {
            "address" : "",
            "type" : "",                // HTTP, SOCKS4, SOCKS5
            "password" : "",
            "username" : ""
        }
    }
}

4. Run

Open your terminal, navigate to the JAR's directory, and execute:

Default config

java -jar xinbot-[VERSION].jar

Custom config

java -jar xinbot-[VERSION].jar /path/to/your/config.conf

5. Official Login (Optional)

If onlineMode is set to true and fullSession is null, the console will show a Microsoft login link. Open the link to authorize, and Xinbot will handle the session automatically.

---

6. Language Settings

Xinbot automatically detects your language based on your system environment. If you need to manually force a specific language, you can add JVM parameters at startup:

Simplified Chinese

java -Duser.language=zh -Duser.country=CN -jar xinbot-[VERSION].jar

English

java -Duser.language=en -Duser.country=US -jar xinbot-[VERSION].jar

---

Next, you can check the Usage Guide to learn how to control your bot.