trixxy-statistic

trixxy-statistic is a Discord.js package designed to create and manage dynamic statistic channels in your Discord server. These channels can display real-time information, such as member count, by updating their names automatically. This package is ideal for keeping your server members informed with up-to-date statistics.

Features

• Dynamic Channel Names: Automatically updates channel names with current statistics.
• Customizable Statistics: Easily configure what statistic to display (e.g., member count).
• Configurable Update Interval: Set how often the statistic channels should be updated.
• Easy Integration: Simple to set up and integrate into your existing Discord.js bot.

Installation

To install the package, use npm:

npm install trixxy-statistic

Required Dependencies:

• discord.js (v14.x or higher)

Usage

Here's how to use TrixxyStatistic in your Discord.js bot:

const { Client, GatewayIntentBits, ChannelType } = require('discord.js');
const TrixxyStatistic = require('trixxy-statistic');

const client = new Client({
    intents: [
        GatewayIntentBits.Guilds,
        GatewayIntentBits.GuildMembers, // Required for member count statistics
    ],
});

client.on('ready', () => {
    console.log(`Logged in as ${client.user.tag}!`);

    // Initialize TrixxyStatistic for a specific guild
    const statisticHandler = new TrixxyStatistic(client, {
        guildId: 'YOUR_GUILD_ID', // Replace with your server's guild ID
        channelName: 'Members: {count}', // The name template for the statistic channel. {count} will be replaced by the actual count.
        channelType: ChannelType.GuildVoice, // Optional: Type of channel to create (e.g., GuildVoice, GuildText). Default is GuildVoice.
        updateInterval: 300000 // Optional: Update interval in milliseconds (e.g., 5 minutes). Default is 1 minute (60000).
    });

    // The package automatically handles channel creation and updates.
});

client.login('YOUR_BOT_TOKEN'); // Replace with your bot token

TrixxyStatistic Class

constructor(client, options)

Initializes the TrixxyStatistic handler.

• client (required): The Discord.js Client instance.
• options (optional): An object containing configuration options:
  • guildId (string): The ID of the guild where the statistic channel will be managed. Required.
  • channelName (string): The template for the statistic channel's name. Use {count} as a placeholder for the statistic value (e.g., member count). Default: 'Members: {count}'.
  • channelType (ChannelType): The type of Discord channel to create for the statistic. Can be ChannelType.GuildVoice, ChannelType.GuildText, etc. Default: ChannelType.GuildVoice.
  • updateInterval (number): The interval in milliseconds at which the statistic channel's name will be updated. Default: 60000 (1 minute).

Important Notes

• Ensure your bot has the Guilds and GuildMembers intents enabled in the Discord Developer Portal and in your Client initialization.
• The bot must have permissions to Manage Channels in the specified guild to create and rename channels.
• If channelType is set to ChannelType.GuildVoice, the bot will automatically set permissions to prevent users from connecting to it, as it's intended for display only.

License

This project is licensed under the ISC License.