website·Indexed 32 days ago
https://docs.bot.elpsy.cn/A bot framework based on mirai-ts and mirai-api-http that allows users to implement bot functionality through simple configuration or custom plugins. It includes a built-in data system using MongoDB and mongoose, a logging system implemented with winston, and a command system based on commander.js.
Before using el-bot, you must ensure that the mirai-api-http plugin is successfully loaded and running.
To verify connectivity, visit the /about endpoint of the API. By default, mirai-api-http uses port 8080, but el-bot-template defaults to port 4859 to avoid common port conflicts.
# Example check using curl (replace 4859 with your configured port)
curl http://localhost:4859/aboutel-bot is a cross-platform, configurable robot framework based on Node.js. It relies on the following stack to function:
Users must be able to start mirai independently using tools like mirai-console-loader, miraiOK, or mirua.
el-bot plugins are functions that receive a bot context (ctx). You can use ctx.mirai.api to access mirai-ts APIs without handling login or plugin loading manually.
Plugin Structure:
plugins/custom/test.js) or a folder with an index.js (e.g., plugins/custom/test/index.js).Context Object (ctx) Properties:
ctx.el.config: Access bot-related configurations from the config file.ctx.mirai: Access the mirai-ts instance for event listening and API calls.// Example: plugins/custom/test.js
const { default: Bot } = require("el-bot");
/**
* @param {Bot} ctx
*/
module.exports = async function (ctx) {
const mirai = ctx.mirai;
// Listen for messages (covers Friend, Group, and Temp messages)
mirai.on("message", (msg) => {
console.log("Received message:", msg);
});
// Send a command via mirai-api-http
const data = await mirai.api.command.send("help", []);
console.log("Help info:" + data);
// Listen for specific events (e.g., GroupRecallEvent)
mirai.on("GroupRecallEvent", ({ operator }) => {
const text = `${operator.memberName} recalled a message.`;
mirai.api.sendGroupMessage(text, operator.group.id);
});
};utils.InnerMode class allows developers to implement an 'internal mode' for plugins. This prevents state leakage between different chat groups or users. Without InnerMode, a plugin might trigger a response in Group B based on a command sent in Group A. By using InnerMode, the plugin tracks the state specifically for the current message context, ensuring that operations (like a search mode) are isolated to the group where they were initiated.import { utils } from "el-bot";
const innerMode = new utils.InnerMode();
export default async function() {
mirai.on("message", (msg) => {
// Associate the current message with the inner mode instance
innerMode.setMsg(msg);
// Example: Enter 'Image Search' mode if the user sends "搜图"
if (msg.plain === "搜图") {
innerMode.enter();
msg.reply("I'm ready!");
}
// Check if the current context is in internal mode
if (innerMode.getStatus()) {
// Perform the specific action (e.g., fakeSearchImage())
fakeSearchImage();
// Exit internal mode to reset state for this context
innerMode.exit();
}
});
}The rss plugin allows the bot to track and notify users of updates from RSS feeds using rss-parser.
rss in a private chat to see all subscriptions and trigger an immediate fetch. Send rss in a group to see subscriptions specific to that group.el-bot/tmp/rss.json. Deleting this file forces a fresh fetch of all feeds.el-bot package globally to access its command-line interface for managing the bot and its dependencies like mirai.# Install el-bot globally
npm install -g el-bot
# or
yarn global add el-bot
# Install mirai
el install mirai
# Start mirai
el start mirai
# Start the bot
el botnpm install el-bot
# or
yarn add el-bot