💁 A multipurpose, multilanguage, customizable, modular, and very cute bot for Discord! ~Making your server more awesome~
Latest commit 09b2ef6 Oct 13, 2018

README.md


💁 Loritta 💁

Discord Bots

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?

VocĂȘ tambĂ©m pode hospedar a Loritta em algum lugar se vocĂȘ nĂŁo quiser utilizar a versĂŁo pĂșblica dela, mas lembrando...

  • 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 como arrumar problemas na sua versĂŁo self hosted dela, vocĂȘ estĂĄ por sua conta e risco.
  • Eu irei dar suporte caso vocĂȘ queria hospedar ela para contribuir e ajudar ela.
  • Lembrando que ela precisa de vĂĄrias API Keys para vĂĄrias funcionalidades dela, caso vocĂȘ nĂŁo coloque uma delas, talvez ela poderĂĄ ter funcionalidade reduzida ou talvez nĂŁo irĂĄ funcionar corretamente!
  • Lembrando que eu nĂŁo distribuo os "assets" dela (imagens, fontes, etc), ou seja, comandos que utilizam tais assets nĂŁo irĂŁo funcionar corretamente.
  • Existem vĂĄrias coisas "hard coded" nela, ou seja, vocĂȘ terĂĄ que editar o cĂłdigo-fonte dela e recompilar, afinal, eu nunca pensei que alguĂ©m ia usar hospedar a Loritta entĂŁo vocĂȘ terĂĄ que fazer algumas modificaçÔes no cĂłdigo-fonte dela para funcionar. 😉
  • Eu hospedo ela em uma mĂĄquina rodando CentOS 7, talvez ela nĂŁo irĂĄ rodar corretamente em outros sistemas operacionais.
  • VocĂȘ nĂŁo pode utilizar o nome "Loritta" ou a personagem Loritta na sua versĂŁo self hosted.

Mas se vocĂȘ quiser mesmo hospedar a Loritta, siga os seguintes passos:

  1. Tenha o MongoDB instalado na sua mĂĄquina.
  2. Tenha o JDK 8 (ou superior) na sua mĂĄquina.
  3. Tenha o Git Bash instalado na sua mĂĄquina.
  4. Tenha o Maven instalado na sua mĂĄquina com o PATH configurado corretamente. (para que vocĂȘ possa usar mvn install em qualquer pasta e o JAVA_HOME, para que o mvn install funcione)
  5. Tenha o IntelliJ IDEA instalado na sua mĂĄquina.
  6. Faça git clone https://github.com/LorittaBot/Loritta.git em alguma pasta no seu computador.
  7. Agora, usando o PowerShell (ou o prĂłprio Git Bash), entre na pasta criada e utilize mvn install
  8. ApĂłs terminar de compilar, vĂĄ na pasta target e pegue a JAR Loritta-0.0.1-SNAPSHOT.jar e a pasta "libs".
  9. Inicie a JAR que vocĂȘ copiou pelo prompt de comando utilizando java -jar Loritta-0.0.1-SNAPSHOT.jar, vocĂȘ provavelmente terĂĄ que futuramente colocar mais memĂłria nela para evitar OutOfMemoryExceptions, no momento que eu escrevi este post, a versĂŁo pĂșblica dela estĂĄ utilizando -Xmx8G -Xms8G (ou seja, 8GBs de memĂłria alocada)
  10. Após iniciar, um arquivo chamado config.json serå criado, abra ele com um editor de texto decente (como o Notepad++) e preencha todas as opçÔes, a configuração jå vem com alguns valores padrÔes e alguns destes valores padrÔes vem com explicaçÔes sobre para que ele serve e da onde ele surgiu.
  11. ApĂłs terminar de configurar, inicie a JAR novamente e, se tudo der certo, ela irĂĄ iniciar e vocĂȘ poderĂĄ usar os comandos dela! 🎉

🔀 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

📄 Licença

O cĂłdigo-fonte da Loritta estĂĄ licenciado sob a GNU Affero General Public License v3.0

A personagem Loritta Ă© © MrPowerGamerBR & PerfectDreams — Todos os direitos reservados

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



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