Getting Started

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

1. Download

Get the latest version from GitHub Releases: Xinbot Releases

Download the file named xinbot-[LATEST_VERSION].jar.

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 password in 2b2t.xin
    },
    "enableTranslation" : true,         // Language file loading (higher memory usage)
    "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 path: ./config.conf
java -jar xinbot-[LATEST_VERSION].jar

# or specify the config path manually
java -jar xinbot-[LATEST_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.

---

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