Fluxer.Net-Docs/index.html at dev · Nexfinity/Fluxer.Net-Docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!DOCTYPE html>
<head>
    <title>Fluxer.Net Docs</title>
    <meta charset="utf-8" />
    <link rel="preload" as="style" href="/assets/defaults.css" />
    <link rel="stylesheet" href="/assets/defaults.css" />
    <link rel="icon" href="/assets/imgs/nexfinity.png" />
</head>

<body>
    <template id="select">about-header</template>
    <template id="content">
        <h1>Welcome to Fluxer.Net</h1>

        <p>Fluxer.Net is a .NET library for building bots and applications on the Fluxer platform. It provides a simple, intuitive API for interacting with Fluxer's REST API and real-time gateway.</p>

        <h2>Features</h2>
        <ul>
            <li><strong>REST API Client:</strong> Complete coverage of all Fluxer API endpoints</li>
            <li><strong>WebSocket Gateway:</strong> Real-time event streaming with automatic reconnection</li>
            <li><strong>Command Framework:</strong> Discord.Net-style command service with automatic argument parsing</li>
            <li><strong>EmbedBuilder:</strong> Fluent API for creating rich embeds with validation</li>
            <li><strong>Built-in Rate Limiting:</strong> Client-side rate limiting to prevent API abuse</li>
            <li><strong>Async/Await Support:</strong> Modern asynchronous programming patterns</li>
            <li><strong>Comprehensive Logging:</strong> Built on Serilog for detailed diagnostics</li>
            <li><strong>Session Resuming:</strong> Automatic gateway reconnection without event loss</li>
        </ul>

        <h2>Quick Start</h2>
        <p>Install Fluxer.Net via NuGet:</p>

        <pre><code class="language-sh">dotnet add package Fluxer.Net</code></pre>

        <p>Create a simple bot:</p>

        <pre><code class="language-cs">using Fluxer.Net;
using Serilog;

// Configure logging
Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Information()
    .WriteTo.Console()
    .CreateLogger();

// Initialize clients
const string token = "YOUR_TOKEN_HERE";
var config = new FluxerConfig();
var apiClient = new ApiClient(token, config);
var gatewayClient = new GatewayClient(token, config);

// Listen for messages
gatewayClient.MessageCreate += async (data) =>
{
    var message = data.Message;
    if (message.Content == "!ping")
    {
        await apiClient.SendMessage(message.ChannelId,
            new Message { Content = "Pong!" });
    }
};

// Connect and run
await gatewayClient.ConnectAsync();
await Task.Delay(-1);</code></pre>

        <h2>Getting Started</h2>
        <p>New to Fluxer.Net? Start with these tutorials:</p>
        <ul>
            <li><a href="/tutorials/first-bot/1.create.html">Creating Your First Bot</a> - Set up a basic bot</li>
            <li><a href="/tutorials/first-bot/2.messages.html">Receiving Messages</a> - Handle gateway events</li>
            <li><a href="/tutorials/first-bot/3.commands.html">Your First Command</a> - Build a command system</li>
        </ul>

        <h2>Reference Guides</h2>
        <ul>
            <li><a href="/guides/configuration.html">Configuration</a> - Configure Fluxer.Net for your needs</li>
            <li><a href="/guides/command-service.html">Command Service</a> - Build command bots with the CommandService framework</li>
            <li><a href="/guides/preconditions.html">Custom Preconditions</a> - Create custom command requirements and restrictions</li>
            <li><a href="/guides/embed-builder.html">EmbedBuilder</a> - Create rich embeds with the fluent API</li>
            <li><a href="/guides/api-client.html">API Client</a> - Complete REST API reference</li>
            <li><a href="/guides/gateway-client.html">Gateway Client</a> - Real-time events reference</li>
            <li><a href="/guides/events.html">Events Reference</a> - All available gateway events</li>
            <li><a href="/guides/rate-limiting.html">Rate Limiting</a> - Understanding rate limits</li>
            <li><a href="/guides/voice-client.html">Voice Client (ALPHA)</a> - ⚠️ Experimental voice connection support</li>
        </ul>

        <h2>Requirements</h2>
        <ul>
            <li>.NET 7.0 or later</li>
            <li>A Fluxer account and authentication token</li>
        </ul>

        <h2>Support</h2>
        <p>Need help? Check out these resources:</p>
        <ul>
            <li><a href="https://fluxer.gg/fluxer-net">Fluxer.Net Community</a> - Join our Fluxer server</li>
            <li><a href="https://github.com/Nexfinity/Fluxer.Net">GitHub Repository</a> - Report issues and contribute</li>
            <li><a href="/contact.html">Contact</a> - Other ways to get help</li>
        </ul>

        <h2>License</h2>
        <p>Fluxer.Net is open source and available under the MIT License.</p>
    </template>
    <script src="/assets/scripts/loader.js"></script>

    <script src="/assets/ext/shikijs/dist/index.unpkg.iife.js"></script>
    <script>
        shiki.setCDN("/assets/ext/shikijs");

        shiki.loadTheme('themes/dracula.json').then(theme =>
            shiki.getHighlighter({theme: theme, langs: ['cs', 'sh']}).then(hl => {
                document.querySelectorAll('pre code').forEach(block => {
                    const lang = block.className.replace('language-', '');
                    const highlighted = hl.codeToHtml(block.textContent, { lang: lang });
                    block.parentElement.outerHTML = highlighted;
                });
            })
        );
    </script>
</body>