🔎 Searcher

Faça pesquisas dentro do Discord de forma simples e interativa.

• Fácil de usar
• Gratuído
• Primeiro bot a dar suporte a plataformas como: modrinth, visual studio code marketplace, etc.
• Respeita a sua privacidade.

🧐 Como adicionar?

Você pode adicionar a versão oficial do Searcher clicando aqui!

Aviso sério

O searcher nunca irá pedir permissões para mudar algo no seu servidor, ou coletar informações além de:

• ID dos usuários que utilizaram algum comando

Sempre verifique o ID da aplicação caso entre em um link postado fora desse repositório ou fora do website oficial do Searcher. Lembrando que o ID do Searcher é 886046032616624138.

🆘 Suporte

Existem duas formas de obter suporte sobre o Searcher, sendo elas:

• Abrindo uma issue nesse repositório.
• Entrando no servidor de suporte

🖥️ Área dos programadores

Está interessado em contribuir com o projeto? melhorar o código, ou simplesmente fazer uma versão auto-hospedada? aqui é a sua área.

🤝 Contribuindo

Uma coisa que está bem na cara é que o código do searcher não é as mil maravilhas, mas seria legal se você pudesse ajudar a melhorar ele :D

Abrindo Issues

Antes de abrir uma Issue, você deve considerar algumas coisas:

Reportando algum bug/falha

• Dê uma descrição detalhada sobre o bug, é bom que a equipe entenda o máximo possível.
• Fale como reproduzir o bug, se puder, também use imagens pra demonstrar.

Abrindo pull requests

Corrigindo algum bug/falha

• Dê uma descrição detalhada sobre o bug, é bom que a equipe entenda o máximo possível.
• Fale como reproduzir o bug, se puder, também use imagens pra demonstrar.
• Dê uma descrição detalhada sobre a sua correção.

Melhorando um trecho do código

• Dê uma descrição detalhada sobre o que você melhorou.
• Explique o motivo da sua correção ser melhor que o código atual, se puder, mostre o máximo de comparações

🚀 Self-hosting

Antes de fazer uma versão auto-hospedada, considere algumas coisas:

• O Searcher está em desenvolvimento, novas coisas serão feitas, e nem sempre o guia de self-hosting estará 100% atualizado (porém não vamos deixar ele aqui penando, lógico que ele irá ser atualizado também.)
• Respeite os desenvolvedores do projeto, dê os créditos e não fale que você quem fez.
• Também siga todas as exigências da licença "GPLv3".
• O Banco de dados que o Searcher usa é o MONGODB, você precisa ter um servidor do MONGODB para se conectar.
• O Searcher roda o seu próprio servidor MONGODB, se você não puder fazer o mesmo, dê uma olhada no MONGODB atlas.
• Você precisa de uma chave de acesso do deepai.

Preparando o config.yml e as variáveis de ambiente

O Searcher possuí algumas informações importantes guardadas no config.yml, por isso você deve preparar ele de forma correta (caso contrário sua versão auto-hospedada irá rodar com diversos bugs) Veja uma versão dele explicando as propriedades:

bot: 
 id: "" # ID da sua aplicação.
 devs: 
  - "Shut!#5230"
  - "Weariful#6650" # Aqui é a lista de desenvoledores (nome e tag), coloque eles com um "-" no começo.
 dev_ids:
  - "470976775145390082"
  - "343778106340802580" # Aqui é a lista de desenvolvedores (ID), coloque eles com um "-" no começo.
 logs:
  channel:
   id: "" #Esse é o ID do canal de logs do Searcher.

Prepare o seu config.yml com base nas informações acima. Agora as variáveis de ambiente, você deve criar um arquivo chamado .env, e colocar nele as seguintes informações:

BOT_TOKEN=token da sua aplicação
DB_URL=URL do seu banco de dados MONGODB
DEEPAI_KEY=token de acesso do deepai
IMAGES_SERVER=url do servidor de imagens (cdn)
PUBLIC_KEY=key publica do seu bot
PORT=porta onde o webserver irá rodar

Para obter o token de acesso ao deepai, você deve criar uma conta em deepai.org

Instalando depedências e ligando o bot

Antes, você deve instalar as dependências usando o comando:

npm install

Isso irá instalar todas as dependências que estão no package.json. Após isso, você pode rodar o seguinte comando:

node index.js

Caso tudo ligar, parabéns, você concluiu boa parte do trabalho, agora falta algumas coisinhas

Registrando os comandos

Agora você deve registrar os comandos, essa parte é relativamente simples. Para registrar todos os comandos globalmente, é só rodar o seguinte comando:

node registerCommands.js

Nota: Os comandos globais demoram até 1 hora para atualizar em todos os servidores. Porém, se você fizer alterações nas informações do comando (só há necessidade de atualizar caso você mudar algo dentro da propriedade command), você pode registrar em um servidor primeiro para não precisar esperar 1 hora. Para registrar comandos localmente, é só rodar o comando:

node registerCommands.js <ID do servidor>

Registrando apenas um comando

As vezes editar todos os comandos simplesmente porque você mudou um só é meio desnecessário. Felizmente o Searcher possui um sistema pra evitar isso. Para registrar um comando globalmente, é só você usar:

node registerCommand.js <nome do arquivo do comando>

Para registrar um comando em apenas um servidor, é só você usar:

node registerCommand.js <nome do arquivo do comando> <ID do servidor>

Lembrando: É o NOME do arquivo do comando, e não o nome do comando.

Registrando seu webserver

O Searcher não utiliza gateway para receber e responder comandos, nós somos modinhas, usamos webserver. Para registrar seu webserver é bem simples, quando você rodar ele, veja qual a URL/IP (lembrando que se você rodar no seu PC, você deve expor o webserver no seu IP público, já que o discord não pode enviar solicitações para o IP local.), o endpoint dos comandos é /api/interaction. Então a url seria: <seu ip ou dominio>/api/interaction

Configurando sua URL no developer portal

Vá nas configurações da sua aplicação no discord developer portal, logo na página de informações gerais, lá em baixo existe uma opção chamada INTERACTIONS ENDPOINT URL, você deve colocar a url do seu webserver lá. Exemplo abaixo: Depois disso, sua instância auto-hospedada está pronta lembrando que:

• Não vamos dar suporte para versões auto-hospedadas.