bot package

Submodules

• bot.weakauras_bot module
  • WeakAurasBot
    • WeakAurasBot.config
    • WeakAurasBot.data_dir
    • WeakAurasBot.__init__()
    • WeakAurasBot.sanitize_server_name()
    • WeakAurasBot.get_server_folder()
    • WeakAurasBot.get_server_macros_file()
    • WeakAurasBot.load_server_macros()
    • WeakAurasBot.save_server_macros()
    • WeakAurasBot.get_server_config_file()
    • WeakAurasBot.load_server_config()
    • WeakAurasBot.save_server_config()
    • WeakAurasBot.is_event_enabled()
    • WeakAurasBot.has_admin_access()
    • WeakAurasBot.create_embed()
    • WeakAurasBot.on_ready()
    • WeakAurasBot.sync_commands()

Module contents

class bot.WeakAurasBot(config)

Bases: Bot

WeakAuras Discord Bot with server-specific macro storage and management.

This bot extends discord.py’s commands.Bot to provide WeakAuras-specific functionality including macro storage, server configuration, and administrative features. Each Discord server gets its own isolated data storage.

config

Bot configuration dictionary.

Type:

dict[str, Any]

data_dir

Directory path for server data storage.

Type:

Path

Example

>>> config = {"storage": {"data_directory": "server_data"}}
>>> bot = WeakAurasBot(config)
>>> # Bot is now ready for command registration and startup

__init__(config)

Initialize the WeakAuras bot with configuration.

Parameters:

config (dict[str, Any]) – Configuration dictionary containing bot settings, storage paths, and other options.

Example

>>> config = {
...     "storage": {"data_directory": "server_data"},
...     "bot": {"brand_color": 0x9F4AF3}
... }
>>> bot = WeakAurasBot(config)

create_embed(title=None, description=None, color=None, footer_text=None)

Create a branded WeakAuras embed with logo attachment

Return type:

tuple[Embed, File | None]

get_server_config_file(guild_id, guild_name)

Get the configuration file path for a specific server

Return type:

Path

get_server_folder(guild_id, guild_name)

Get or create the server folder path, checking for existing folders by guild ID

Return type:

Path

get_server_macros_file(guild_id, guild_name)

Get the macros file path for a specific server

Return type:

Path

has_admin_access(member)

Check if member has admin access via role names or Discord permissions

Return type:

bool

async is_event_enabled(guild_id, event_type)

Check if a specific event is enabled for a server.

Checks Django database first, then falls back to JSON configuration.

Parameters:

• guild_id (int) – Discord guild ID

• event_type (str) – Type of event (e.g., “temperature”)

Returns:

True if event is enabled, False otherwise

Return type:

bool

load_server_config(guild_id, guild_name)

Load configuration for a specific server

Return type:

dict[str, Any]

load_server_macros(guild_id, guild_name)

Load macros for a specific server

Return type:

dict[str, Any]

async on_ready()

sanitize_server_name(server_name)

Sanitize server name for use as folder name

Return type:

str

save_server_config(guild_id, guild_name, config)

Save configuration for a specific server

Return type:

None

save_server_macros(guild_id, guild_name, macros)

Save macros for a specific server

Return type:

None

async sync_commands()

Sync slash commands with Discord