💁 Loritta 💁

Olá, eu me chamo Loritta (ou, como meus amigos próximos me chamam, "Lori") e sou apenas um simples bot brasileiro para o Discord com várias funções jamais vistas!

Eu tenho várias funções para entretenimento (como comandos engraçados e memes), funções sociais (sistema de perfil com XP e reputação), extremamente customizável (você pode ativar/desativar qualquer comando meu, alterar meu prefixo para o que você quiser e muito mais!) e com um simples foco: Ser o melhor bot brasileiro para o Discord!

Um dos motivos que me fizeram me tornar o que eu sou hoje é a falta de bots brasileiros para o Discord, já que muitos servidores brasileiros no Discord usam bots "de baixa qualidade" em português ou usam bots que falam (na verdade escrevem) em inglês... e convenhamos, nenhuma dessas opções parece agradável para os usuários... e por isto que eu prometo mudar isto!

🤔 Como adiciono ela ao meu servidor?

Se você quiser usar a Loritta no seu servidor, você pode adicionar ela clicando aqui.

Enquanto é possível fazer "self hosting" (hospedar você mesmo) ela, eu não irei dar suporte para quem quiser fazer isto para evitar pessoas criando "clones" e levando todo o crédito por terem criado o bot, eu dou suporte se você quer fazer "self hosting" para ajudar e contribuir para ela.

💁 Suporte

Você pode obter suporte sobre a Loritta clicando aqui!

🙋 Como ajudar?

Existem vários repositórios na nossa organização de várias partes da Loritta, caso você queria contribuir em outras partes da Loritta, clique nos links abaixo para ir no repositório deles.

Loritta: Código-fonte da Loritta ("backend"), isto inclui toda a parte do bot em si (comandos, funcionalidades, etc) e a parte "backend" do website dela.
LorittaLocales: Arquivos de tradução da Loritta.
LorittaWebsite: "Frontend" do website da Loritta, isto inclui imagens, CSS, HTML, etc do website dela.
PerfectDreams: Servidor de Minecraft da Loritta!

💵 Como Doar?

Mesmo que você não saiba programar, você pode ajudar no desenvolvimento da Loritta doando! https://loritta.website/donate

🙌 Como Usar?

👨‍💻 Como Compilar e Selfhostear?

Você também pode hospedar a Loritta você mesmo (afinal, é por isso que se chama selfhosting) caso você preferia ter total controle sobre os bots que você tem no seu servidor, mas lembre-se...

Nós deixamos o código-fonte de nossos projetos para que outras pessoas possam se inspirar e aprender com nossos projetos, o objetivo é que pessoas que são fãs da Loritta aprendam como ela funciona e, caso queiram, podem ajudar ela com bug fixes e novas funcionalidades.
Eu não irei dar suporte caso você queria fazer self hosting apenas para você querer fazer "fama" falando que você criou um bot, mesmo que na verdade você apenas pegou o código-fonte dela e hospedou, lembre-se, a licença do projeto é AGPL v3, você é obrigado a deixar todas as suas alterações no projeto públicas!
Eu não irei ficar explicando e te ajudando a como arrumar problemas na sua versão selfhosted dela, você está por sua conta e risco. A única exceção é se você está planejando selfhostear para ajudar a desenvolver ela.
A Lori precisa de várias API Keys para várias funcionalidades diferentes, enquanto nem todas são obrigatórias, a falta de alguma irá causar problemas em algumas funcionalidades dela.
Os "assets" (imagens, fontes, etc) não são distribuídos junto com o código-fonte, você terá que criar e incluir seus próprios assets.
Nós utilizamos Ubuntu 18.04, talvez ela irá funcionar em outros sistemas Linux ou até em Windows, mas recomendamos que você tente hospedar em uma máquina que rode Ubuntu ou derivados.
Para evitar confusões e problemas, você não pode utilizar o nome ou a personagem "Loritta", "Lori" ou nomes parecidos na sua versão selfhosted.

Nós recomendamos utilizar a versão pública da Loritta, mas se você realmente quiser hospedar ou ajudar a desenvolver a Loritta, siga os seguintes passos:

Tenha o JDK 11 (ou superior) instalado na sua máquina e certifique-se que o Java está acessível pelo terminal. (Tente executar java no terminal, caso não funcione, procure como incluir a pasta do JDK no PATH do seu sistema operacional)
Tenha o MongoDB instalado na sua máquina. (No futuro o MongoDB será removido da Loritta e será 100% substituido pelo PostgreSQL)
Tenha o PostgreSQL instalado na sua máquina. (No futuro será possível executar a Loritta utilizando uma database SQLite)
Tenha o git-shell ou o git-cli instalados. No Windows você pode utilizar o Git Bash.
Caso você precise fazer modificações no código-fonte da Lori, é recomendado utilizar o IntelliJ IDEA.
Faça git clone https://github.com/LorittaBot/Loritta.git em alguma pasta no seu computador.
Agora, usando o PowerShell (ou o Git Bash), entre na pasta criada e utilize gradle w build
Ao terminar de compilar todos os módulos, vá em loritta-discord\build\libs. (Troque loritta-discord pelo módulo da Loritta que você deseja utilizar)
Caso tenha uma JAR loritta-discord-fat-YYYY.MM.DD-SNAPSHOT.jar, quer dizer que tudo compilou corretamente, yay! 🎉
Copie a JAR acima para uma nova pasta.
Vá para a pasta principal do repositório, copie a pasta libs para a nova pasta que você tinha criado anteriormente.
Antes de inicializar a Lori, você deverá criar quatro arquivos para configurar a Loritta, sendo eles...

Salve cada arquivo na mesma pasta da JAR e configure cada um utilizando o seu editor de texto favorito. (Visual Studio Code, Notepad++, etc)

Você pode pegar os arquivos de linguagem "locales" utilizando git clone https://github.com/LorittaBot/LorittaLocales

Você pode pegar os arquivos do website utilizando git clone https://github.com/LorittaBot/LorittaWebsite

Algumas funcionalidades da Lori estão em plugins separados, você pode pegar eles na pasta loritta-plugins/nome-do-plugin/build/libs/.

Pelo terminal, utilize java -Xmx1G -Xms1G -jar NomeDaJarQueVocêCopiouAnteriormente.jar.
Caso tenha dado tudo certo, a sua versão selfhosted da Lori irá iniciar e você poderá utilizar os comandos dela! 🎉

Para editar o código-fonte da Loritta, abra o IntelliJ IDEA e importe o build.gradle.kts, espere o IDEA baixar todas as dependências e divirta-se aprendendo, modificando e melhorando a Loritta!

🔀 Pull Requests

No seu Pull Request, você deverá seguir o meu estilo de código bonitinho que eu faço, é recomendado que você coloque comentários nas partes do seu código para que seja mais fácil na hora da leitura.

Caso o seu código possua texto, você é obrigado a utilizar o sistema de localização da Loritta, para que o seu Pull Request possa ser traduzido para outras linguagens, ou seja, após criar o seu Pull Request, crie um Pull Request no repositório de linguagens da Loritta com as keys necessárias.

O seu código não pode ser algo "gambiarra", meu código pode ter algumas gambiarras mas isto não significa que você também deve encher a Lori com mais gambiarras no seu Pull Request.

Você precisa pensar "será que alguém iria utilizar isto?", se você criar um comando que só seja útil no seu servidor, provavelmente eu irei negar o seu Pull Request, se for algo apenas útil para o seu servidor, seria melhor você criar o comando utilizando a API de comandos em JavaScript da Loritta.

Funcionalidades (como comandos) relacionados a coisas NSFW não serão adicionadas na Loritta e seu Pull Request será negado, eu prefiro que as pessoas, ao olharem o avatar dela, pensem que ela é um bot que cria memes toscos do que um bot que fica mandando coisas NSFW no chat.

📦 Dependências

A Lori utiliza várias dependências no código-fonte dela, obrigado a todos os mantenedores das dependências! Sem vocês, talvez a Loritta não iria existir (ou teria várias funcionalidades reduzidas ou talvez até inexistentes!)

Nome	Mantenedor
Kotlin	JetBrains
Kotlin Coroutines	JetBrains
Guava	Google
Caffeine	Ben Manes
JDA	DV8FromTheWorld, kantenkugel, MinnDevelopment, Almighty-Alpaca, etc
MongoDB Java Driver	MongoDB
TemmieWebhook	MrPowerGamerBR
TemmieMercadoPago	MrPowerGamerBR
AminoREAPI	MrPowerGamerBR
Apache Commons Lang	Apache
Apache Commons Codec	Apache
Apache Commons IO	Apache
Apache Commons Text	Apache
Jooby	Jooby Project
Jooby Netty	Jooby Project
Jooby Kotlin	Jooby Project
Jooby MongoDB	Jooby Project
Pebble	Pebble Templates
jsoup	jhy
Http Request	kevinsawicki
LavaPlayer	sedmelluq
JDA-NAS	sedmelluq
JRakNet	Whirvis
Kotson	SalomonBrys

💫 Agradecimentos especiais para...

YourKit, criadores do YourKit Java Profiler, suportam projetos open source de todos os tipos com o excelente profiler de aplicações Java e .NET. Nós agradecemos por darem uma licença open source para conseguir deixar a Lori mais incrível e maravilhosa para todos os nossos usuários!

📄 Licença

O código-fonte da Loritta está licenciado sob a GNU Affero General Public License v3.0

Ao utilizar a Loritta você aceita os termos de uso dela.

"Discord", "DiscordApp" and any associated logos are registered trademarks of Discord Inc.

Xernium/Loritta