Skip to content

LorittaBot/LorittaHelper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ™‹β€β™€οΈ Loritta Helper πŸ™‹β€β™€οΈ

The bot that automatically answers ALMOST all questions about Loritta on its support server.

πŸ“… Info

  • This bot is private, it can't be added to your server, but you can self host it.
  • We won't consider pull requests that are not useful.
  • If you want help with contributing, you can call someone with the "Beeps and Boops" role in Loritta's community server, they know very well how to help you out.

🌎 Contributing

You can add new responses to Loritta Helper following these steps:

  • First of all, you need to create a new class with a name that can describe what your response is, something like ProfileBackgroundResponse.kt, at the package: net/perfectdreams/loritta/helper/serverresponses/{language}/Name.kt

  • Let's suppose you're going to create a response that will answer people about how to earn sonhos. The name should be something like HowToGetSonhosResponse or something related.

  • Loritta detects the question using RegEx, there are some materials that we recommend:

  • Now, you need to make your class extends RegExResponse, so it can be considered by Lori.

  • You should add the RegEx patterns at the class init block, something like this:

init {
    patterns.add("como")
    patterns.add("ganha|obtem|receber")
    patterns.add("sonhos|dreams|moedas|dinheiro".toPattern(Pattern.CASE_INSENSITIVE))
}
  • After that, you want to specify the answer, so you need to add a method called getResponse(), it should look something like that:
override fun getResponse(): List<LorittaReply> = listOf(
    LorittaReply(Emotes.LORI_OWO, "You can earn sonhos using `+daily`."),
    LorittaReply(Emotes.LORI_PAT, "Or betting with users using `+coinflip bet`")
)

And then you can search for the class net/perfectdreams/loritta/helper/serverresponses/{language}Responses.kt, you can add your response there to register it. If you have some kind of experience, please consider doing unit tests.

πŸ“Š License

This repository is under the AGPL-3.0 license.