Oprettelse af en Discord-bot i .NET Core med deployment på VPS-server

Hej, Habr-folk!

I dag vil du blive introduceret til en artikel, der beskriver, hvordan man opretter en bot ved hjælp af C# på .NET Core, og hvordan man får den til at køre på en remote server.

Artiklen vil bestå af en baghistorie, forberedelsesfase, skrivning af logik og overførsel af botten til den remote server.

Jeg håber, at denne artikel vil være til hjælp for mange begyndere.

Background

Det hele begyndte en søvnløs efterårsnat, som jeg tilbragte på Discord-serveren. Da jeg relativt nyligt var tilsluttet, begyndte jeg at udforske den grundigt. Jeg opdagede tekstkanalen "Jobopslag", blev interesseret, åbnede den og fandt blandt de uinteressante forslag dette:

"Programmerer (botudvikler)
Krav:

• kendskab til programmeringssprog;
• evne til selvstudium.

Ønsker:

• evne til at forstå andres kode;
• kendskab til DISCORD-funktionaliteter.

Opgaver:

• udvikling af bot;
• vedligeholdelse og support af botten.

Din fordel:

• Mulighed for at støtte og påvirke et interessant projekt;
• Erhvervelse af erfaring med teamwork;
• Mulighed for at demonstrere og forbedre eksisterende færdigheder."

Dette fangede straks min interesse. Ja, der blev ikke betalt for dette arbejde, men der blev ikke krævet nogen forpligtelser fra dig, og det vil ikke være skadelig for portfolioet. Så jeg skrev til serveradministratoren, og han bad mig om at skrive en bot, der ville vise statistikken for spillere i World of Tanks.

Forberedelsesfase

Discord
Før vi kan begynde at skrive vores bot, skal vi oprette den til Discord. Du skal:

1. Logge ind på din Discord-konto via linket
2. I fanen "Applications" klikke på knappen "New Application" og navngive botten
3. Få bot-tokenet ved at logge ind på din bot og finde fanen "Bot" under "Settings"
4. Gem tokenet et sted

Wargaming

Derudover skal vi oprette en applikation i Wargaming for at få adgang til Wargaming API. Dette er også enkelt:

1. Log ind på Wargaming-kontoen via dette link
2. Gå til "Mine applikationer" og klik på knappen "Tilføj ny applikation", giv applikationen et navn, og vælg dens type
3. Gem applikationens ID

Software

Her har du allerede frihed til at vælge. Nogle bruger Visual Studio, andre Rider, og nogle er virkelig hardcore og skriver kode i Vim (rigtige programmører bruger kun tastaturet, ikke sandt?). Men for at undgå at implementere Discord API kan du bruge et uofficielt bibliotek til C# kaldet “DSharpPlus”. Det kan installeres enten fra NuGet eller ved selv at kompilere kildekoden fra depotet.

For dem, der ikke ved, eller har glemt, hvordan man installerer applikationer fra NuGet.Instruktion til Visual Studio

1. Gå til fanen Projekt – Administrer NuGet-pakker;
2. Klik på Gennemse, og i søgefeltet indtast “DSharpPlus”;
3. Vælg og installér framework;
4. PROFIT!

Forberedelsesfasen er slut, nu kan vi gå videre til at skrive botten.

Skrivning af logik

Vi vil ikke dække hele logikken i applikationen, jeg vil kun vise, hvordan man arbejder med meddelelser, der fanges af botten, og hvordan man arbejder med Wargaming API.

Arbejdet med Discord-botten foregår gennem funktionen static async Task MainTask(string[] args);
For at kalde denne funktion skal du skrive i Main

MainTask(args).ConfigureAwait(false).GetAwaiter().GetResult();

Derefter skal du initialisere din bot:

discord = new DiscordClient(new DiscordConfiguration
{
    Token = token,
    TokenType = TokenType.Bot,
    UseInternalLogHandler = true,
    LogLevel = LogLevel.Debug
});

Hvor token er tokenet for din bot.
Derefter skriver vi nødvendige kommandoer, som botten skal udføre, gennem en lambda:

discord.MessageCreated += async e =>
{
    string message = e.Message.Content;
    if (message.StartsWith("&"))
    {
        await e.Message.RespondAsync(“Hej, ” + e.Author.Username);
    }
};

Hvor e.Author.Username er brugernavnet på brugeren.

Så når du sender en hvilken som helst besked, der begynder med &, vil botten hilse på dig.

I slutningen af denne funktion skal du skrive await discord.ConnectAsync(); og await Task.Delay(-1);

Dette vil tillade, at kommandoer kører i baggrunden uden at blokere hovedtråden.

Nu skal vi se på Wargaming API. Her er det enkelt – skriv CURL-anmodninger, modtag svar i form af JSON-strenge, udtræk de nødvendige data derfra og manipulér dem.

Eksempel på arbejde med WargamingAPI

public Player FindPlayer(string searchNickname)
        {
            //https://api.worldoftanks.ru/wot/account/list/?application_id=y0ur_a@@_id_h3r3search=nickname
            urlRequest = resourceMan.GetString("url_find_player") + appID + "&search=" + searchNickname;
            Player player = null;
            string resultResponse = GetResponse(urlRequest);
            dynamic parsed = JsonConvert.DeserializeObject(resultResponse);

            string status = parsed.status;
            if (status == "ok")
            {
                int count = parsed.meta.count;
                if (count > 0)
                {
                    player = new Player
                    {
                        Nickname = parsed.data[0].nickname,
                        Id = parsed.data[0].account_id
                    };
                }
                else
                {
                    throw new PlayerNotFound("Spiller ikke fundet");
                }
            }
            else
            {
                string error = parsed.error.message;
                if (error == "NOT_ENOUGH_SEARCH_LENGTH")
                {
                    throw new PlayerNotFound("Minimum tre tegn kræves");
                }
                else if (error == "INVALID_SEARCH")
                {
                    throw new PlayerNotFound("Ugyldig søgning");
                }
                else if (error == "SEARCH_NOT_SPECIFIED")
                {
                    throw new PlayerNotFound("Tom brugernavn");
                }
                else
                {
                    throw new Exception("Noget gik galt.");
                }
            }

            return player;
        }

Advarsel! Det anbefales på det kraftigste ikke at opbevare alle tokens og app-ID'er i åbent format! I det mindste vil Discord blockere sådanne tokens, når de kommer ud på internettet, og i værste fald kan botten blive udnyttet af svindlere.

Deployment på VPS – server

Når du er færdig med botten, skal den placeres på en server, der kører døgnet rundt 24/7. Dette skyldes, at når din applikation kører, kører botten også. Så snart du slukker for applikationen, går din bot også i dvale.

Der er mange VPS-servere derude, både på Windows og på Linux, men i de fleste tilfælde er det langt billigere at hoste på Linux.

På Discord-serveren anbefalede de vscale.io til mig, så jeg oprettede straks en virtuel server på Ubuntu og uploadede botten. Jeg vil ikke beskrive, hvordan denne hjemmeside fungerer, men går direkte til indstillingerne for botten.

Først skal du installere den nødvendige software, som skal køre vores bot, der er skrevet i .NET Core. Hvordan du gør dette, er beskrevet her.

Dernæst skal du uploade botten til Git – en service som GitHub og lignende, og klone den på VPS-serveren, eller på anden måde downloade din bot. Vær opmærksom på, at du kun vil have en konsol, der vil ikke være nogen GUI. Overhovedet.

Når du har downloaded din bot, skal du starte den. For dette skal du:

• Gendanne alle afhængigheder: dotnet restore
• Bygge applikationen: dotnet build name_project.sln -c Release
• Gå til den byggede DLL;
• dotnet name_of_file.dll

Tillykke! Din bot er startet. Desværre optager botten konsollen, og det er ikke så let at lukke VPS-serveren. Derudover, hvis serveren genstartes, skal botten startes igen. Der er et par løsninger på dette problem. Alle er relateret til at starte ved serverstart:

• Tilføje scriptstart til /etc/init.d
• Oprette en tjeneste, der starter ved opstart.

Jeg ser ikke nogen grund til at gå i dybden med dem; alt er tilstrækkeligt godt beskrevet på internettet.

Konklusioner

Jeg er glad for, at jeg tog dette opdrag. Det var min første erfaring med at udvikle en bot, og jeg er glad for, at jeg har fået ny viden om C# og arbejde med Linux.

Link til Discord-serveren. For dem, der spiller Wargaming-spil.
Link til repository, hvor Discord-botten ligger.
Link til DSharpPlus-repository.
Tak for din opmærksomhed!

Kilde: habr.com