PluralFlux/Program.cs

// ============================================================================
// Fluxer.Net Example Project - Getting Started Tutorial
// ============================================================================
// This example demonstrates the core concepts of building a Fluxer bot using
// the Fluxer.Net library. You'll learn how to:
//   1. Configure logging for debugging and monitoring
//   2. Set up both the Gateway (real-time events) and API (REST operations)
//   3. Handle gateway events (like messages)
//   4. Make API calls (like sending messages)
//   5. Implement basic command handling
//
// Prerequisites:
//   - A Fluxer account and bot token (add it to config.yml)
//   - .NET 7.0 or higher
//   - Basic understanding of async/await in C#
// ============================================================================

using System.Reflection;
using Serilog;
using Serilog.Core;
using Serilog.Sinks.SystemConsole.Themes;
using Fluxer.Net;
using Fluxer.Net.Commands;
using Fluxer.Net.Data.Enums;
using Fluxer.Net.Gateway.Data;
using PluralFlux;

// ============================================================================
// STEP 1: Configure Logging
// ============================================================================
// Serilog provides structured logging for the Fluxer.Net library. This helps
// you debug issues and monitor your bot's activity. Logs are written to both
// the console (for development) and a file (for production debugging).

Log.Logger = new LoggerConfiguration()
                .MinimumLevel.Debug()  // Log everything (Verbose, Debug, Info, Warning, Error, Fatal)
                .WriteTo.Console(theme: AnsiConsoleTheme.Code)  // Pretty console output with colors
                .CreateLogger();

// ============================================================================
// STEP 2: Load Your Bot Token
// ============================================================================
// The token authenticates your bot with the Fluxer API. NEVER commit your
// token to version control! Store it in config.yml (which is .gitignored).
//
// To get a token:
//   1. Create a bot in the Fluxer developer portal
//   2. Copy the bot token
//   3. Paste it into config.yml as "Token: flx_your_token_here"

var config = ConfigExtension.LoadConfig();
if (config == null)
{
    Log.Error("YAML file not found. Please create a config.yml file with your bot token.");
    Log.Error("Example format:\n  Token: flx_your_token_here");
    return;
}

Log.Debug("Config file loaded successfully.");

// ============================================================================
// STEP 3: Initialize the Gateway Client (Real-Time Events)
// ============================================================================
// The GatewayClient connects to Fluxer's WebSocket gateway to receive real-time
// events like messages, reactions, member joins, etc. This is the "listening"
// part of your bot that responds to what happens on Fluxer.
//
// Key Configuration Options:
//   - ReconnectAttemptDelay: Seconds to wait between reconnection attempts
//   - Serilog: Logger instance for gateway events
//   - IgnoredGatewayEvents: Filter out events you don't need (reduces processing)
//   - Presence: Your bot's initial status (Online, Idle, DND, Invisible)

var gateway = new GatewayClient(config["Token"], new()
{
    ReconnectAttemptDelay = 2,  // Reconnect quickly if connection drops
    Serilog = Log.Logger as Logger,  // Use our configured logger

    // Ignore high-volume events we don't need to reduce CPU/memory usage
    // Common events to ignore: PRESENCE_UPDATE, TYPING_START, VOICE_STATE_UPDATE
    IgnoredGatewayEvents = new()
    {
        "PRESENCE_UPDATE"  // We don't need to track when users go online/offline
    },

    // Set your bot's status. Options: Online, Idle, DND, Invisible
    Presence = new PresenceUpdateGatewayData(Status.Online)
});

// ============================================================================
// STEP 4: Initialize the API Client (REST Operations)
// ============================================================================
// The ApiClient handles REST API requests for creating, reading, updating, and
// deleting resources (messages, channels, guilds, users, etc.). This is the
// "action" part of your bot that makes changes on Fluxer.
//
// Key Features:
//   - Automatic rate limiting (enabled by default via sliding window algorithm)
//   - Token-based authentication
//   - Full coverage of 150+ Fluxer API endpoints
//   - Shared logging configuration with the gateway

var api = new ApiClient(config[key: "Token"], new()
{
    Serilog = Log.Logger as Logger,  // Use our configured logger
    EnableRateLimiting = true  // Prevent hitting rate limits (default: true)
});

// ============================================================================
// STEP 4.5: Initialize the Command Service
// ============================================================================
// The CommandService provides a Discord.Net-style command framework for handling
// text-based commands. It automatically discovers command modules, parses arguments,
// and executes commands with support for preconditions and dependency injection.
//
// Key Features:
//   - Attribute-based command definition
//   - Automatic type parsing (string, int, bool, DateTime, etc.)
//   - Optional and remainder parameters
//   - Precondition support (RequireOwner, RequireContext, etc.)
//   - Sync/Async execution modes

var commands = new CommandService(
    prefixChar: '/',  // Commands start with /
    logger: Log.Logger as Logger,  // Use our configured logger
    services: null  // No dependency injection for this example
);

// Automatically register all command modules from this assembly
await commands.AddModulesAsync(Assembly.GetExecutingAssembly());

Log.Information("Registered {ModuleCount} command module(s) with {CommandCount} command(s)",
    commands.Modules.Count, commands.Commands.Count());

// ============================================================================
// STEP 5: Handle Command-Line Arguments
// ============================================================================
// This example supports a --revoke flag to log out the bot and invalidate
// the current token. Useful for testing or emergency shutdowns.
//
// Usage: dotnet run --revoke

if (args.Length > 0 && args[0] == "--revoke")
{
    Log.Information("Revoking token and logging out...");
    await api.Logout();
    Log.Information("Token revoked successfully. The bot is now logged out.");
    return;
}

// ============================================================================
// STEP 6: Example API Call - Update Bot Nickname
// ============================================================================
// This demonstrates a simple API call to update the bot's nickname in a guild.
// Replace the guild ID with your own guild/community ID.
//
// To find your guild ID:
//   1. Enable developer mode in Fluxer settings
//   2. Right-click your guild/community
//   3. Click "Copy ID"

// NOTE: Replace this guild ID with your own!
// await api.UpdateCurrentMember(1431484523333775609, new()
// {
//     Nickname = "Fluxer.Net Example Bot"
// });

// ============================================================================
// STEP 7: Subscribe to Gateway Events
// ============================================================================
// The gateway uses an event-driven architecture. You subscribe to events by
// attaching handlers to the GatewayClient. Here we demonstrate basic command
// handling by listening for MESSAGE_CREATE events.
//
// Available Events (just a few examples):
//   - MessageCreate: New message posted
//   - MessageUpdate: Message edited
//   - MessageDelete: Message deleted
//   - GuildCreate: Bot added to a guild
//   - GuildMemberAdd: User joined a guild
//   - MessageReactionAdd: Reaction added to a message
//   ... and many more! See GatewayClient.cs for the full list.

gateway.MessageCreate += async messageData =>
{
    try
    {

        // Log every message for debugging (optional - can be noisy!)
        Log.Debug("Message received in channel {ChannelId} from {Username}: {Content}",
            messageData.ChannelId, messageData.Author.Username, messageData.Content);

        // ========================================================================
        // Command Handling using CommandService
        // ========================================================================
        // The CommandService automatically parses commands and executes them.
        // Commands are defined in module classes (see Modules/BasicCommands.cs)

        // Check if the message starts with the command prefix
        int argPos = 0;
        if (messageData.Content?.StartsWith("pf;") == true)
        {
            argPos = 3; // Skip the prefix character

            // Create a command context with all the necessary information
            var context = new CommandContext(api, gateway, messageData);

            // Execute the command
            var result = await commands.ExecuteAsync(context, argPos);

            // Log command execution results
            if (!result.IsSuccess)
            {
                // Log errors (you can also send error messages to the user here)
                Log.Warning("Command execution failed: {Error} ({ErrorType})",
                    result.Error, result.ErrorType);

                // Optionally send error message to user
                if (result.ErrorType == CommandError.UnknownCommand)
                {
                    // Don't spam for unknown commands - just log it
                }
                else if (result.ErrorType == CommandError.BadArgCount)
                {
                    await api.SendMessage(messageData.ChannelId, new()
                    {
                        Content = $"❌ Error: {result.Error}"
                    });
                }
                else if (result.ErrorType == CommandError.ParseFailed)
                {
                    await api.SendMessage(messageData.ChannelId, new()
                    {
                        Content = $"❌ Error: {result.Error}"
                    });
                }
                else if (result.ErrorType == CommandError.UnmetPrecondition)
                {
                    await api.SendMessage(messageData.ChannelId, new()
                    {
                        Content = $"⛔ {result.Error}"
                    });
                }
                else
                {
                    await api.SendMessage(messageData.ChannelId, new()
                    {
                        Content = $"❌ An error occurred: {result.Error}"
                    });
                }
            }
            else
            {
                Log.Information("Command executed successfully by {Username} ({UserId})",
                    messageData.Author.Username, messageData.Author.Id);
            }
        }
    }
    catch (Exception ex)
    {
        Log.Error(ex, "Error while processing message");
    }
};

// ============================================================================
// Additional Gateway Event Examples (Uncomment to use)
// ============================================================================

// Example: Log when the bot is ready
gateway.Ready += readyData =>
{
    try
    {
        Log.Information("Bot is ready! Logged in as {Username}", readyData.User?.Username);
    }
    catch (Exception ex)
    {
        Log.Error(ex, "Error on ready event");
    }
};

// Example: Track message deletions
// gateway.MessageDelete += deleteData =>
// {
//     Log.Information("Message {MessageId} was deleted from channel {ChannelId}",
//                     deleteData.Id, deleteData.ChannelId);
// };

// Example: Welcome new guild members
// gateway.GuildMemberAdd += async memberData =>
// {
//     Log.Information("New member joined guild {GuildId}: User {UserId}",
//                     memberData.GuildId, memberData.UserId);
//
//     // Send a welcome message (replace with your welcome channel ID)
//     // await api.SendMessage(yourWelcomeChannelId, new()
//     // {
//     //     Content = $"Welcome to the server, <@{memberData.UserId}>! 🎉"
//     // });
// };

// Example: Track message reactions
// gateway.MessageReactionAdd += reactionData =>
// {
//     Log.Debug("Reaction {Emoji} added to message {MessageId} by user {UserId}",
//               reactionData.Emoji?.Name, reactionData.MessageId, reactionData.UserId);
// };

// ============================================================================
// STEP 8: Connect to the Gateway
// ============================================================================
// This establishes the WebSocket connection and starts receiving events.
// IMPORTANT: Uncomment this line to actually connect! It's commented out by
// default so you can test API calls without connecting to the gateway.

await gateway.ConnectAsync();
Log.Information("Connected to Fluxer gateway. Bot is now online!");

// ============================================================================
// STEP 9: Keep the Bot Running
// ============================================================================
// The bot needs to stay running to continue receiving events. Task.Delay(-1)
// blocks the main thread indefinitely. The bot will run until you stop it
// with Ctrl+C or kill the process.
//
// In production, you might want to:
//   - Add graceful shutdown handling (CancellationToken)
//   - Implement a /shutdown command for authorized users
//   - Run as a system service or Docker container

// await api.UpdateCurrentMember(1431484523333775609, new() { Nickname = "Fluxer.Net" });

Log.Information("Bot is running. Press Ctrl+C to stop.");
await Task.Delay(-1);

// ============================================================================
// Next Steps & Resources
// ============================================================================
// Now that you understand the basics, here are some ideas to expand your bot:
//
// 1. Add more commands:
//    - Create new command modules in the Modules/ folder
//    - Use preconditions: [RequireOwner], [RequireContext(ContextType.Guild)]
//    - Add parameter types: int, bool, DateTime, TimeSpan, enums, etc.
//    - Use [Remainder] for multi-word parameters
//    - Use [Alias] to add alternative command names
//    - Implement BeforeExecute/AfterExecute hooks in your modules
//
//    Example command module:
//    public class ModerationCommands : ModuleBase
//    {
//        [Command("kick")]
//        [RequireUserPermission(Permissions.KickMembers)]
//        [RequireContext(ContextType.Guild)]
//        public async Task KickCommand(ulong userId, [Remainder] string reason = "No reason provided")
//        {
//            // Kick logic here
//            await ReplyAsync($"Kicked user {userId} for: {reason}");
//        }
//    }
//
// 2. Use more API endpoints:
//    - Create/manage channels: api.CreateChannel()
//    - Manage roles: api.CreateRole(), api.UpdateRole()
//    - Send embeds: Use EmbedBuilder to create rich embeds (see /embed command)
//    - Manage members: api.UpdateMember(), api.KickMember()
//
//    Example: Create a complex embed with error handling
//    try {
//        var embed = new EmbedBuilder()
//            .WithTitle("Server Stats")
//            .WithDescription($"Statistics for {guildName}")
//            .WithColor(0x00FF00) // Green
//            .AddField("Total Members", memberCount.ToString(), inline: true)
//            .AddField("Online Members", onlineCount.ToString(), inline: true)
//            .AddField("Total Channels", channelCount.ToString(), inline: true)
//            .WithThumbnailUrl(guildIconUrl)
//            .WithFooter($"Requested by {username}", userAvatarUrl)
//            .WithCurrentTimestamp()
//            .Build();
//
//        await api.SendMessage(channelId, new() { Embeds = new() { embed } });
//    } catch (InvalidOperationException ex) {
//        Log.Error(ex, "Embed validation failed - check field lengths and URL formats");
//    }
//
// 3. Implement advanced features:
//    - Database integration for persistent data (Entity Framework, Dapper, etc.)
//    - Scheduled tasks and background jobs
//    - Custom preconditions for advanced permission checks
//    - Dependency injection with service providers
//
// 4. Explore rate limiting:
//    - Check remaining requests: api.RateLimitManager.GetBucketInfoAsync()
//    - Monitor active buckets: api.RateLimitManager.ActiveBucketCount
//    - See RateLimiting/README.md for more details
//
// 5. Documentation:
//    - API endpoints: See ApiClient.cs for all 150+ methods
//    - Gateway events: See GatewayClient.cs for all event types
//    - Rate limiting: See RateLimiting/README.md
//    - Configuration: See FluxerConfig.cs for all options
//
// Happy coding! 🚀
// ============================================================================