Skip to content

BetterSidebar API 接口

v1.0.0

BetterSidebar 允许其他插件在侧边栏显示自定义变量。

对接方式

语言对接方式文档
C++ServiceManager 回调C++ 接入指南
PythonSQLite 数据库Python 接入指南

变量格式

在配置文件 plugins/better_sidebar/config.json 中使用 {category.key} 引用变量:

json
{
    "lines": [
        "§e跳跃: §a{stats.jumps}",
        "§e分数: §a{my.score}"
    ]
}

架构

┌────────────────────────────────────────┐
│          BetterSidebar (C++)           │
│  读取变量 → 显示侧边栏                  │
└─────────────────┬──────────────────────┘
                  │ 读取
          ┌───────┴───────┐
          │ external_vars │
          │    .db        │
          └───────┬───────┘
                  │ 写入
┌─────────────────┴──────────────────────┐
│          其他插件 (C++/Python)          │
└────────────────────────────────────────┘

C++ 插件

通过 ServiceManager 注册回调函数:

cpp
auto service = getServer().getServiceManager().load<ISidebarService>("SidebarService");
service->registerVariable("my", "score", [](const std::string& player) {
    return std::to_string(scores[player]);
});

详见 C++ 接入指南

Python 插件

BetterSidebar 启动时自动生成 sidebar_api 模块,直接 import 使用:

python
from sidebar_api import get_sidebar_api

sidebar = get_sidebar_api()
sidebar.set_value("my", "score", player_name, "100")

详见 Python 接入指南

下载

文件语言说明
sidebar_api.hC++ISidebarService 接口定义

Python 无需下载

BetterSidebar 启动时自动生成 Python API 模块。

Made with ❤️ by EVIL-ZIXIE