discord needle

Agulha

Needle é um bot Discord que ajuda você a organizar seu servidor criando threads Discord automaticamente.

Começando

A maneira mais fácil de começar a usar o Needle em seu servidor é usar a instância hospedada. Clique aqui para convidar Needle para o seu servidor Discord! Se você tiver alguma dúvida, sinta-se à vontade para entrar no servidor de suporte e verificar as Perguntas Frequentes.

Auto-hospedagem (avançado)

A instância hospedada do Needle é personalizável e deve ser suficiente para a maioria dos usuários. No entanto, se você tiver requisitos especiais e quiser modificar a funcionalidade do Needle, você terá que bifurcar o repositório e hospedar sua própria instância. Isto requer conhecimento de programação e é apenas para usuários avançados – o suporte para isso será limitado.

Needle requer um ambiente com Node.js versão 16.9.0 ou superior, juntamente com armazenamento persistente para arquivos de configuração por servidor - hosts compartilhados (como Replit e Heroku) não funcionarão.

1. Clone ou baixe a versão mais recente do Needle (branch: stable ).

2. Copie .env.example para .env e preencha o token e o ID do aplicativo do seu bot.

3. Execute npm install para instalar as dependências do Needle.

4. Execute npm run build para compilar o código do Needle.

5. Execute npm run deploy para configurar comandos de barra.

• Os comandos de barra podem levar até uma hora para aparecer em todos os servidores.

6. Execute npm start para iniciar o Needle?

O Needle requer as seguintes permissões para funcionar, junto com os applications.commands e os escopos bot .

• Ver canais

• Enviar mensagens

• Envie mensagens em tópicos

• Crie tópicos públicos

• Ler histórico de mensagens

Você pode usar este link para convidar sua versão auto-hospedada do Needle, substituindo <APP ID> pelo ID do aplicativo do seu bot:

https://discord.com/oauth2/authorize?client_id=<APP ID>&permissions=309237713920&scope=bot%20applications.commands

Docker

Needle tem uma imagem oficial do Docker. As versões são marcadas por sua versão secundária e de patch (por exemplo, 2.0.0 e 2.0 ), com a versão mais recente marcada latest . As filiais são marcadas por seus nomes. Para executar a imagem, escreva o seguinte comando, substituindo token pelo token do seu bot:

 docker run -d --name Needle --env DISCORD_API_TOKEN=token discord-needle ghcr.io/MarcusOtter/discord-needle:latest

Por padrão, isso criará um volume anônimo para /configs . Para alterar o local, adicione -v /path/to/configs:/configs ao comando.

Há também um arquivo docker-compose.yml de exemplo.

Você ainda precisará implantar os comandos de barra do Needle - siga as instruções regulares de auto-hospedagem além da etapa 6.

Contribuindo

Diretrizes de contribuição em breve ™️

Junte-se ao Discord se estiver interessado!

Se você quiser apoiar o Needle de outras maneiras, considere patrocinar o desenvolvimento do Needle.

Você também pode votar e avaliar o bot em top.gg.

Licença

Este programa é software livre: você pode redistribuí-lo e/ou modificá-lo sob os termos da Licença Pública Geral GNU Affero conforme publicada pela Free Software Foundation, seja a versão 3 da Licença ou (a seu critério) qualquer versão posterior.

Este programa é distribuído na esperança de que seja útil, mas SEM QUALQUER GARANTIA; mesmo sem a garantia implícita de COMERCIALIZAÇÃO ou ADEQUAÇÃO A UM DETERMINADO FIM. Consulte a Licença Pública Geral GNU Affero para obter mais detalhes.

Você deve ter recebido uma cópia da Licença Pública Geral GNU Affero junto com este programa. Caso contrário, consulte https://www.gnu.org/licenses/.