mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-18 18:10:37 +08:00
fd4fe84310
* Update listen-message-event.md * Update other.md * Update send-message.md * Update ai.md * Update ai.md * Update send-message.md * Update listen-message-event.md * Delete docs/zh/dev/star/guides/env.md * Delete docs/en/dev/star/guides/env.md * Update simple.md * Update discord.md * Update discord.md * Update matrix.md * Update matrix.md * Update index.md * Update index.md * Update openapi.md * Update ppio.md * Update ppio.md * Update function-calling.md * Update function-calling.md * Update config.mjs * docs: add EN desktop deployment page * Update plugin.md * Update ai.md * Update ai.md * Update ai.md * Update desktop.md
43 lines
2.3 KiB
Markdown
43 lines
2.3 KiB
Markdown
# Minimal Example
|
|
|
|
The `main.py` file in the plugin template is a minimal plugin instance.
|
|
|
|
```python
|
|
from astrbot.api.event import filter, AstrMessageEvent, MessageEventResult
|
|
from astrbot.api.star import Context, Star
|
|
from astrbot.api import logger # Use the logger interface provided by AstrBot
|
|
|
|
class MyPlugin(Star):
|
|
def __init__(self, context: Context):
|
|
super().__init__(context)
|
|
|
|
# Decorator to register a command. The command name is "helloworld". Once registered, sending `/helloworld` will trigger this command and respond with `Hello, {user_name}!`
|
|
@filter.command("helloworld")
|
|
async def helloworld(self, event: AstrMessageEvent):
|
|
'''This is a hello world command''' # This is the handler's description, which will be parsed to help users understand the plugin's functionality. Highly recommended to provide.
|
|
user_name = event.get_sender_name()
|
|
message_str = event.message_str # Get the plain text content of the message
|
|
logger.info("Hello world command triggered!")
|
|
yield event.plain_result(f"Hello, {user_name}!") # Send a plain text message
|
|
|
|
async def terminate(self):
|
|
'''Optionally implement the terminate function, which will be called when the plugin is uninstalled/disabled.'''
|
|
```
|
|
|
|
Explanation:
|
|
|
|
- Plugins must inherit from the `Star` class.
|
|
- The `Context` class is used for plugin interaction with AstrBot Core, allowing you to call various APIs provided by AstrBot Core.
|
|
- Specific handler functions are defined within the plugin class, such as the `helloworld` function here.
|
|
- `AstrMessageEvent` is AstrBot's message event object, which stores information about the message sender, message content, etc.
|
|
- `AstrBotMessage` is AstrBot's message object, which stores the specific content of messages delivered by the messaging platform. It can be accessed via `event.message_obj`.
|
|
|
|
> [!TIP]
|
|
>
|
|
> Handlers must be registered within the plugin class, with the first two parameters being `self` and `event`. If the file becomes too long, you can write services externally and call them from the handler.
|
|
>
|
|
> The file containing the plugin class must be named `main.py`.
|
|
|
|
All handler functions must be written within the plugin class. To keep content concise, in subsequent sections, we may omit the plugin class definition.
|
|
|