🖥️Manual de Instalação

Este manual destina-se a administradores de servidores que desejam instalar o MelkBot para sua comunidade no Discord. Se você é um usuário, não há necessidade de seguir essas instruções.

A instalação do Melk Bot é simples, e consiste em dois passos: 1/ acessar o link de autorização do Discord e 2/ rodar o comando de instalação dentro do Discord.

Autorizando o bot

Entre nesse link da aplicação e escolha o servidor que você deseja instalar o bot. Depois, clique em [Continue]. Quando clicar, as permissões que o bot utiliza vão aparecer. Vou explicar as permissões necessárias para fins de segurança e confiabilidade:

• Manage Channels (gerenciar canais): Essa permissão é necessária para a criação de categorias e canais do Discord que servirão de porta de validação de cada missão. Quando configurar o bot, ele vai criar uma categoria específica do projeto e todos os canais das missões dentro da categoria.

• Read Messages (ler mensagens): Ler mensagens é necessário para que possamos pegar a prova de missão dos usuários, validar e enviar a recompensa em MELK baseado na mensagem.

• Permissões de Thread (Send messages in threads, create public threads, create private threads, manage threads): Essas permissões são usadas para possíveis casos futuros de criação de threads.

• Manage Messages (gerenciar mensagens): precisamos dessa permissão para gerenciar as mensagens, armazenar o ID delas no banco de dados para posterior checagem. As únicas mensagens que gerenciamos são dentro dos canais do projeto.

• Embed Links (embutir links): essa permissão é necessária para colocarmos os links externos de cada missão que direcionam para o nosso site (atualmente no gitbook).

• Attach Files (enviar arquivos): arquivos podem ser enviados nas mensagens do bot, referindo-se a imagens, PDFs ou outros arquivos referentes às aulas.

• Read Message History (ler histórico de mensagens): utilizamos para re-processar mensagens antigas que por algum motivo não foram processadas e enviar recompensas.

• Mention @everyone @here and All Roles (mencionar as roles): utilizamos para anunciar as missões, notificando os usuários

• Add reactions (adicionar reações): usamos as reações para informar os usuários sobre o resultado das missões (validar, mensagem inválida, etc)

• Use External Emoji/Stickers (usar emojis ou adesivos externos): enviar emojis e adesivos nas mensagens, estético

• Use application commands (usar comandos de aplicação): rodar comandos de aplicação padrão

Nota: caso queira, você pode mudar permissões específicas de outras categorias, de maneira que as permissões acima existam apenas na categoria do projeto.

Depois de autorizar, provavelmente você terá que passar pelo “captcha” e em seguida receberá uma notificação de que o bot entrou no seu servidor. Certifique-se de que o bot está no seu servidor, ele aparecerá na lista de membros.

Configurando o bot

A configuração do bot é simplificada e automatizada. Para começar com a primeira trilha, certifique-se de inserir os comandos no canal público adequado. Utilize o comando: !melk configServer, seguido do idioma desejado (pt-BR ou en) e da trilha inicial (atualmente, temos duas opções: basic ou neo).

Se você desejar adicionar outra trilha, continue a utilizar o canal público e empregue o comando: !melk installTrail, seguido pelo nome da trilha desejada (também disponível: basic ou neo). Ao adicionar uma nova trilha, o idioma utilizado será o mesmo da primeira configuração (pt-BR ou en, dependendo do caso).

Segue uma tabela com os comandos completos:

Tipo de instalação	Comando	Detalhes
1a Instalação	!melk configServer pt-BR basic	Instale a trilha "Basic" em português
1a Instalação	!melk configServer en basic	Instale a trilha "Basic" em inglês
1a Instalação	!melk configServer pt-BR neo	Instale a trilha "NEO" em português
1a Instalação	!melk configServer en neo	Instale a trilha "NEO" em inglês
Adicionar trilha	!melk installTrail basic	Adicione a trilha "Basic" no mesmo servidor no idioma configurado inicialmente
Adicionar trilha	!melk installTrail neo	Adicione a trilha "NEO" no mesmo servidor no idioma configurado inicialmente

Caso tenha alguma dificuldade, contate a nossa equipe.

Por favor note que, para voce instalar o bot voce precisa ser o criador e proprietario do servidor.