Skip to content

aluruiz/CadiBot

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CadiBot Build Status License

CadiBot es un bot de Telegram que contiene una serie de utilidades, principalmente para grupos

Colaborar

Cualquier aporte será bienvenido :D Puedes aportar ideas, reportar errores o bien puedes hacer un fork y programar una nueva funcionalidad.

Para programar una nueva funcionalidad, debes tener en cuenta lo siguiente:

Modularidad

CadiBot desde la versión 2.0 contiene un núcleo principal y una serie de módulos que se añaden a su alrededor. Para crear un módulo nuevo, debes crear un nuevo package dentro de com.cadiducho.bot.modules, y una clase principal (por convenio, MiFuncionalidadModule) Esa clase debe implementar Module y la información acorde a este quedará registrada mediante la anotación ModuleInfo

@ModuleInfo(name = "MiFuncionalidad", description = "Breve descripción de qué hará mi módulo")
public class MiFuncionalidadModule implements Module {
    @Override
    public void onLoad() {
        //qué ejecutar cuando carga el módulo, por ejemplo: registrar comandos
    }

    @Override
    public void onClose() {
        //qué hacer cuando se descarga el módulo, por ejemplo: cerrar procesos secundarios, conexiones a bases de datos...
    }
}

Si quieres realizar un módulos externo, puedes compilar todas tus clases en un nuevo archivo .jar y moverlo a la subcarpeta /modules que se crea donde ejecuta el bot. Este módulo.jar cargará automáticamente.

Comandos

Los comandos que se creen deben estar asociados siempre a un módulo.

Existen diferentes maneras de crear un comando.

Comandos simples

El sistema del bot soporta la creación de comandos simples mediante una sintaxis Json.

Entenderemos por comandos simples que estos reciban un comando, ignorando los argumentos, y respondan con una o una serie de funcionalidades simples entre las que se incluyen Texto, Gifs, Foto etc.

Este es un ejemplo de un comando simple que responderá a "hola" y "adios" con "ciao"

{
    "aliases": ["hola", "adios"],
    "description": "Saludar o despedirse",
    "module": "Italian Module",
    "funcionalities": [
        {
            "type": "text",
            "text": "ciao",
            "reply_to": "none"
        }
    ]
}

Aquí puedes obtener más información sobre los comandos simples

Packages

No packages published

Languages

  • Java 100.0%