Kit de Construção para Discord Bot 🤖

merefield · Julho 10, 2019, 8:29am

Propósito deste plugin

Este plugin faz várias coisas:

Permite que você alimente um bot do Discord usando seu servidor Discourse para realizar ações que integrem os dois sistemas. Faça um fork deste repositório e expanda-o com Ruby simples para criar todos os tipos de funcionalidades para o bot.
Funcionalidades existentes que servem como exemplos e utilitários úteis:

Oferece algumas postagens automáticas bidirecionais de conteúdo que atendem a certos critérios.
Comando para copiar mensagens ad hoc para o Discourse.
Comando para sincronizar a associação a grupos com a associação a funções (roles) do seu servidor Discord com sua instância do Discourse.

O plugin fornece um esqueleto extensível sobre o qual você pode construir recursos adicionais. PRs (Pull Requests) para adições geralmente úteis são bem-vindos.

^{esses não são os dois comandos de sincronização, apenas uma ilustração da interação do bot que é possível. o segundo comando na captura de tela foi descontinuado durante o desenvolvimento}

A configuração é necessariamente complexa, mas é ótima para fãs de ambos os sistemas que estão dispostos a dedicar tempo para entender como cada sistema funciona, pelo menos em nível funcional e conceitual. Você precisa entender alguns fundamentos de como o gerenciamento de usuários do Discourse e do Discord funciona para obter o melhor deste plugin.

Comandos do Bot

Existem quatro comandos:

Ping!
!disckick
!discsync
!disccopy

Ping!

Para verificar se o bot está respondendo, basta digitar “Ping!” e o bot deve responder com “ : Pong!” - maravilhoso, não é? (isso é uma espécie de meme, btw!)

!disckick <min_trust_level: padrão 2>

Digitar isso expulsará qualquer usuário que exista no seu Discourse, mas com um Nível de Confiança abaixo do valor fornecido. O padrão, se você não fornecer um valor, é 2.

Exemplo:

!discsync <clean up: padrão false, min_visibility: padrão 0, include automated groups: padrão false>

Este comando tentará copiar todos os grupos para Funções (Roles) no Discord que correspondam aos critérios fornecidos (ou padrões, se não fornecidos). Em seguida, tentará popular as funções de acordo com a associação a Grupos no Discourse. É uma sincronização unidirecional apenas. Nenhum dado do Discourse é alterado.

!disccopy <number_of_messages> <optional_target_category_name> <optional_target_topic_name>

Permite copiar o histórico de mensagens do Discord para sua instância do Discourse diretamente do chat do Discord. Isso pode lidar com milhares de mensagens de uma só vez (mas para esse volume, levará algum tempo).

Comunicação bidirecional

Aqui estão as configurações:

Você pode designar um Canal de Anúncios no Discord nas configurações do plugin.
Agora você pode digitar no Canal de Anúncios designado do Discord e isso publicará sua mensagem no Tópico do Discourse designado nas configurações do plugin.
Você pode configurar uma lista de Categorias no Discourse para postar no canal de Anúncios do seu Discord se alguém postar lá ou adicionar um novo Tópico (um ou ambos).
Cópia de chat automatizada por mensagem, por canal, para qualquer Categoria com nome idêntico no Discourse: se o nome do canal corresponder ao nome da Categoria, a mensagem será copiada para o Discourse.

Além disso, adicionei um novo arquivo para gerenciar eventos do Discord suportados pela API discordrb, sendo a lógica de Anúncios o primeiro exemplo (sinta-se à vontade para desenvolver novos e enviar um PR se forem úteis para a comunidade em geral).

NB: Para qualquer mensagem copiada para o Discourse a partir do Discord, o Usuário será exibido corretamente se esse usuário tiver feito login no Discourse usando o login do Discord (assim, o Bot do Discord consegue corresponder os usuários).

Estado deste plugin

Este é um plugin complexo de configurar. Isso era praticamente inevitável.

No entanto, é brincadeira de criança usá-lo uma vez que tudo esteja funcionando.

Considere o código atualmente em Beta. Foi testado, inclusive em Produção, mas provavelmente contém bugs. Recomendo testá-lo primeiro em um servidor Discord novo antes de aplicá-lo ao seu servidor Discord principal de “Produção”, a menos que você esteja apenas começando.

Qualquer bug tem muito mais probabilidade de afetar sua instância do Discord do que a do Discourse, pois não são feitas alterações no Discourse. No entanto, escrevi-o de uma forma que significa que a maioria das coisas é recuperável e você pode simplesmente repetir algo para corrigir um problema, geralmente. O Discourse é usado como mestre para informações de associação e grupo, e esses dados são usados para atualizar a associação e as Funções (Roles) no seu servidor Discord.

Instruções de Configuração

Pré-requisitos

Um servidor Discord no qual você é Administrador.
Um App do Discord (veja abaixo).
Um Bot do Discord (veja abaixo).
Acesso ssh root ao seu servidor Discourse.
Atualizações no app.yml para instalar o plugin.
Todos os usuários do seu Discourse precisarão fazer login usando o login OAuth do Discord que aparecerá na sua página de login assim que o plugin for instalado.

App do Discord

Vá para cá e crie um aplicativo:

Clique em “New Application” (Novo Aplicativo).

Você precisará criar um Bot e ele ficará mais ou menos assim (deixe-o não ‘público’):

Você precisará autorizar o bot no navegador, veja OAuth2 - Documentation - Discord

Depois que o bot for configurado, copie o Token. Você precisará inseri-lo no Discourse mais tarde.

Alterações no app.yml

plugin

Você precisa de apenas um plugin para isso agora que o Login Social do Discord é nativo no núcleo do Discourse (yeah )

Então, no prompt, execute ./launcher rebuild app como de costume.

Isso deve funcionar, sem problemas.

Você pode receber alguns erros no console e nos logs indicando uma falha do bot na primeira construção, pois você ainda não inseriu as credenciais do bot na interface frontal das configurações do Discourse. (lidar com isso de forma mais elegante é uma tarefa pendente, eu apagarerei esta parte quando isso for feito). Isso não fará mal algum, no entanto, e o próprio Discourse funcionará normalmente.

Uma vez na área de administração do seu Discourse, vá para Configurações do Plugin e preencha estes:

Você obterá os IDs da interface do Discord. Você precisará ativar o Modo Desenvolvedor para permitir que você copie esses IDs. No Discord, vá para suas Configurações → Aparência → AVANÇADO e ative o Modo Desenvolvedor:

Você pode então obter os IDs na interface, por exemplo:

Você também precisará preencher as Configurações do OAuth do Discord. O Client ID e o Secret são do seu mesmo App do Discord.

Depois de definir essas configurações, volte para o prompt raiz no linux e digite:

./launcher restart app

Se você configurou corretamente seus servidores Discord e Discourse, deverá ver o bot entrar no servidor.

Se o bot cair (ele ficará offline), você precisará fazer a mesma coisa novamente para trazê-lo de volta. Maior independência do bot em relação ao servidor principal do Discourse é uma tarefa pendente. Dito isso, executei um bot em Produção por um longo tempo e ele ainda não caiu.

Futuros comandos?

Se você tiver uma ideia para outro comando que aproveite a ligação entre Discourse e Discord e que você acredite ser útil para a comunidade em geral, me avise nas respostas e podemos analisar o potencial para implementar isso. NB: este bot não tem a intenção de realizar tarefas fora do escopo do Discourse.

Limitações

O objetivo principal deste plugin era permitir que o usuário criasse um bot em seu Discord que fosse alimentado por seu servidor Discourse e pudesse realizar algumas funções básicas de gerenciamento de associação. Também fornece uma base para quaisquer interações adicionais semelhantes a bots entre os dois sistemas para o futuro. Parte da motivação para usar bots é que eles são simplesmente divertidos.

Os comandos do bot são ad hoc por sua própria natureza.

Problemas Conhecidos

O bot iniciará uma instância de si mesmo se você entrar em uma sessão de console rails no servidor. Isso fará com que o bot pareça responder duas vezes (mas na verdade há dois bots agora). No console rails, pare o bot adicional simplesmente digitando: ::DiscordBot::Bot.discord_bot.stop Isso agora não deve mais ser necessário!
O Robô é um pouco tagarela durante atualizações do Discourse ‘online’, pois continua sendo reativado durante o processo de atualização. Isso remonta a descobrir uma boa maneira de executar o bot em um processo separado e gerenciado, em vez de uma thread ramificada do servidor web. Acredito que isso seja tudo inofensivo, no entanto, e se a saída dos bots for apenas para o seu canal de administração no Discord, você realmente se importa? Isso deve estar quase resolvido agora, com o bot anunciando a si mesmo apenas duas vezes durante uma reconstrução.

Agradecimentos

Há vários apoiadores a agradecer por este plugin, que me levou muito tempo para chegar a este estágio, incluindo @Wedgebert, @FoohonPie. Obrigado ao Jeff por sua generosa contribuição. Obrigado a @angus por todo o encorajamento e por lidar com o apoio financeiro.

O plugin foi inspirado no trabalho que @Watercolor_Games fez em um estágio anterior e depende do plugin de OAuth do Discord criado por @featheredtoast.

O plugin depende da biblioteca Ruby discordrb semi-oficial apoiada pelo Discord e do trabalho fantástico que a equipe do Discord fez para tornar seu sistema acessível. Obrigado a @Falco por me ajudar com uma dependência de maneira extremamente responsiva.

Além disso, é claro, isso não seria possível sem o incrível ecossistema de plugins do Discourse (yeah!)

Estado destas instruções

Elas serão melhoradas com o tempo e eu agradeço o feedback. Há áreas que certamente serão pouco claras.

Owen_Walters · Julho 14, 2019, 3:42am

Hey I’m super interested in this.

Would the opposite be possible? I’d love a way to be able to create a Discourse setup for my Discord server. I’m not sure if there’s a Discord API event for roles being given but you could probably check when someone logs in with Discord or with CRON.

merefield · Julho 14, 2019, 5:26am

Yes, absolutely.

You could either build that as a bot command for ad hoc application, but with a repeat feature that reran the command after a period (nice but not very transparent and no way to individually manage these recurrences)

OR

As I alluded to above, have it scheduled as a job in Discourse as a sidekiq job. That might be a separate plugin (I actually started on the skeleton of that approach before moving to a bot only solution mainly because the ‘bot’ approach was kind of the Discord ‘thing’, fun and offered a unique approach and result), but if I can get Discourse to fire off bot commands then that’s moot (not yet had the chance to test that), and then we can write stuff once and have it work either way (nice!).

Both these solutions would rely on the same OAuth login though.

Whilst this is an excellent idea, it can’t be a priority for me at present because I have a lot of other client work at the moment I need to deliver, but if you wish to support such an extension, we can discuss offline on a PM and schedule it in.

Owen_Walters · Julho 14, 2019, 6:49am

It might be interesting to play around with, but I have nowhere near the skill level required to volunteer to develop/maintain an addon like this. I might make a messy fork at some time but I certainly don’t want my name on anything official.

merefield · Julho 14, 2019, 6:55am

Absolutely get messy. It’s the only way to learn. :).

merefield · Julho 17, 2019, 3:33pm

Minor bug fix deployed:

neemiasvf · Julho 17, 2019, 4:15pm

Got this during rebuild:

Bot is still offline. Triple checked everything and it’s all set up correctly. Not sure how to proceed now… Maybe I need to open a port on my server instance?

merefield · Julho 17, 2019, 4:17pm

Thanks for testing this out and so soon after the update. Let me try to reproduce and I will revert. I did not change anything wrt to the port config.

merefield · Julho 17, 2019, 4:43pm

No issues rebuilding here, Bot comes up fine … have you changed anything in your server config in between?

Your 400 Bad Request sounds like your server sent a corrupt or bad request to the Discord server and this was the response. This suggests it received it fine and was not blocked.

You can get this for:

malformed requests
lack of authorisation
exceeding rate limits

Unfortunately the error message doesn’t appear to help us determine which of these was the particular issue.

Presumably your Discourse is up? Check all the plugin settings are populated correctly.

Just to rule out a temporary gremlin run ./launcher restart app when you get chance … this will take your site down for a few seconds only (sorry about that!).

Falco · Julho 17, 2019, 8:03pm

I see it runs the bot in the after_initialize block, so it will prevent migrations (and rebuilds) if the bot is misconfigured, or if Discord is down.

Maybe try to handle this exception and just log it?

merefield · Julho 17, 2019, 8:06pm

It runs on a separate thread? So I expect that not to be an issue?

However this callback seems to run several times in a rebuild, so the main issue will be that a misconfigured bot could actually breach rate limits if authorisation fails too many times in quick succession. If that happens the account, in worse case, could be blocked for some time.

In any case, I’ll do a quick patch to do that with the current implementation to lessen the impact. Thanks for the suggestion.

UPDATE: @falco, this is done, e.g.:

ransim · Julho 31, 2019, 9:20pm

First I want to say thank you for making this, once I can get it working its going to be a huge help for us managing our discourse and discord for a volunteer community.
I am running into a 400 error when trying to run this bot. Prior to this plugin being added we have been successfully using the official discord auth plugin and webhooks via the chat integration plugin. I’ve validated that those are both still working appropriately.

I created the bot within the same discord app I’d previously created authorized the bot within the discord server, it shows up in the member list as offline. Your documentation didn’t say what permission value to apply, but given most bots I’ve encountered for discord asked for it I went ahead and set it up with a permissions value of 8 for Administrator.

Within the discord server I then copied the ID of the Role it created, which was named after my app, and the id of the channel for admin text.I added the app Role to that channel with full rights, just to be sure, then added the IDs to discourse and restarted.

Unfortunately no matter what I try I’m getting a 400, I even tried a rebuild just to be sure.

merefield · Julho 31, 2019, 9:29pm

Thank you, kind words. It was also enabled by the generosity of funders.

Yes, that’s great. It should have Admin.

This is the second report of this issue.

If you intentially remove the last char of the token in settings (remember what this is) do you get a 401 instead?

Let’s move this to PM because it might get messy (we can always post the solution here).

ransim · Agosto 1, 2019, 2:26pm

Just to post an update in case anyone else sees this, we’re actively looking into the issue but haven’t yet narrowed down the cause. I’d say if anyone else is running into this issue please say so would help to have others testing.

merefield · Agosto 1, 2019, 4:48pm

This is now fixed. It was a weird one to track down.

Thanks to @ransim for raising and working with me to get to the bottom of it.

Huge thanks to the #ruby_discordrb gang on Discord API for their patient and instant help!

@neemiasvf

p0nda · Agosto 30, 2019, 3:04am

@merefield no problem,Your plugin is great.But I have encountered some problems now.
such this:

Discourse Sync:  Starting.  Please be patient, I'm rate limited to respect Discord services.
Discourse Sync:  Checking if there are any eligible groups for sync ...
Discourse Sync: 1 eligible group(s) were found
Discourse Sync:  Preparing list of users who also have a registered account on Discord ...
Discourse Sync:  Preparing list of groups that users who have a registered account on Discord belong to on Discourse ...
Discourse Sync: 0 eligible group(s) were found with Discord users
Discourse Sync:  No users were found in elibigle groups for sync using provided or default criteria!

my commond is : !discsync 4

and commond changed: !discsync false 5 false

Discourse Sync:  Starting.  Please be patient, I'm rate limited to respect Discord services.
Discourse Sync:  Checking if there are any eligible groups for sync ...
Discourse Sync: 10 eligible group(s) were found
Discourse Sync:  Preparing list of users who also have a registered account on Discord ...
Discourse Sync:  Preparing list of groups that users who have a registered account on Discord belong to on Discourse ...

merefield · Setembro 1, 2019, 8:50pm

Hey @p0nda, sorry for slow reply.

If you include any parameters, you need to include all of them. It might be interpreting things strangely.

blueve.in · Setembro 17, 2019, 12:38am

Unable to get the extended bot settings to show up? I have the changes to the app.yml and plugins installed. I have the OAuth setup working, but not the bot settings. Any ideas?

blueve.in · Setembro 17, 2019, 11:14am

The OAuth setting are there but no bot settings

i3itCoin · Setembro 17, 2019, 11:16am

These

Tópico		Respostas	Visualizações
Discourse Trust Levels for Discord Development	61	10128	29 de Novembro de 2019
Discord and Discourse - Better Together \| Blog Blog	12	4770	28 de Dezembro de 2021
Discord login and obtain discord roles in discourse Feature	3	2257	21 de Novembro de 2019
Request widgetbot.io Feature	2	1138	12 de Outubro de 2021
[PAID] 2-way sync Discord <-> Discourse Marketplace	2	964	10 de Março de 2023