mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-03-30 20:15:40 +00:00
cc3fffeb54
- Implemented a configuration option for enabling or disabling commands across multiple command classes. - Each command now checks its enabled state before execution, improving control over command availability. - Updated the configuration loading mechanism to retrieve the enabled state from the config file for commands like Advert, AQI, Catfact, and others.
93 lines
3.2 KiB
Python
93 lines
3.2 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Magic 8-ball command for the MeshCore Bot
|
|
Handles the 'magic8' keyword response
|
|
"""
|
|
import random
|
|
from typing import Optional
|
|
from .base_command import BaseCommand
|
|
from ..models import MeshMessage
|
|
|
|
magic8_responses = ["It is certain.","It is decidedly so.","Without a doubt.","Yes definitely.","You may rely on it.","As I see it, yes.","Most likely.","Outlook good.","Yes.","Signs point to yes.","Reply hazy, try again.","Ask again later.","Better not tell you now.","Cannot predict now.","Concentrate and ask again.","Don't count on it.","My reply is no.","My sources say no.","Outlook not so good.","Very doubtful."]
|
|
|
|
def magic8():
|
|
answer=magic8_responses[random.randint(0,len(magic8_responses)-1)]
|
|
return answer
|
|
|
|
|
|
class Magic8Command(BaseCommand):
|
|
"""Handles the magic8 command.
|
|
|
|
Emulates a Magic 8-Ball, providing a random "fortune" response to a user's question.
|
|
"""
|
|
|
|
# Plugin metadata
|
|
name = "magic8"
|
|
keywords = ['magic8']
|
|
description = "Emulates the classic Magic 8-ball toy'"
|
|
category = "games"
|
|
|
|
def __init__(self, bot):
|
|
"""Initialize the magic8 command.
|
|
|
|
Args:
|
|
bot: The bot instance.
|
|
"""
|
|
super().__init__(bot)
|
|
self.magic8_enabled = self.get_config_value('Magic8_Command', 'enabled', fallback=True, value_type='bool')
|
|
|
|
def can_execute(self, message: MeshMessage) -> bool:
|
|
"""Check if this command can be executed with the given message.
|
|
|
|
Args:
|
|
message: The message triggering the command.
|
|
|
|
Returns:
|
|
bool: True if command is enabled and checks pass, False otherwise.
|
|
"""
|
|
if not self.magic8_enabled:
|
|
return False
|
|
return super().can_execute(message)
|
|
|
|
def get_help_text(self) -> str:
|
|
"""Get help text for the magic8 command.
|
|
|
|
Returns:
|
|
str: The help text for this command.
|
|
"""
|
|
return self.translate('commands.magic8.description')
|
|
|
|
def get_response_format(self) -> Optional[str]:
|
|
"""Get the response format from config.
|
|
|
|
Returns:
|
|
Optional[str]: The format string for the response, or None if not configured.
|
|
"""
|
|
if self.bot.config.has_section('Keywords'):
|
|
format_str = self.bot.config.get('Keywords', 'magic8', fallback=None)
|
|
return self._strip_quotes_from_config(format_str) if format_str else None
|
|
return None
|
|
|
|
async def execute(self, message: MeshMessage) -> bool:
|
|
"""Execute the magic8 command.
|
|
|
|
Selects a random response and sends it to the user.
|
|
|
|
Args:
|
|
message: The message that triggered the command.
|
|
|
|
Returns:
|
|
bool: True if executed successfully, False otherwise.
|
|
"""
|
|
answer = magic8()
|
|
|
|
# Format response with sender mention for channel messages, without for DMs
|
|
if message.is_dm:
|
|
response = f"🎱 {answer}"
|
|
else:
|
|
sender = message.sender_id or "Unknown"
|
|
response = f"🎱 @[{sender}] {answer}"
|
|
|
|
return await self.send_response(message, response)
|
|
|