¿Qué hacer en caso de error?

En caso de encontrar un bug, sigue estos pasos!

  1. Reportar el bug: comprime la carpeta “LOGS” dentro del programa y envíala a través de discord en la sala Reporte de Bugs o por privado a merk_cat. Si recuerdas qué hacías exactamente cuando dejó de funcionar, es de gran ayuda comentarlo.
  2. Prueba a reiniciar el programa asegurándote que no hay otra copia funcionando en el Administrador de Tareas.
  3. Si el programa no arranca y te es imposible usarlo, utiliza el Updater ( puedes ejecutarlo directamente desde la carpeta “UPDATER” dentro de la carpeta del bot ) para ir a la versión anterior de forma temporal. Es importante no quedarse atrás en las versiones, ya que a veces se hacen cambios y pueden dejar de funcionar, es sólo de forma temporal hasta solucionar el error.

General / básico

  • AwitaBot es un programa desarrollado en C#, por lo que es una aplicación que se ejecuta en el PC del streamer.
  • Al iniciar el programa, aparece un login. Este login es con tu cuenta de usuario o de streamer, y NO la del bot. Para loguearte con el bot, se hace una vez dentro del programa.
  • Toda la configuración se almacena en el servidor, excepto lo que se refiere a configuración del PC ( tamaño de ventana, posición, voz seleccionada ) y los tokens de inicio de sesión. En el servidor, por seguridad, no se almacena ningún tipo de dato sensible.
  • Se recomienda configurar todas las opciones con el chatbot desconectado, aunque la mayoría funciona conectado.
  • Es MUY decisivo el reportar los bugs. Sin estos reportes, es probable que no sepa que existe y por lo tanto, no se arregle por arte de magia.
  • Para reportar los bugs, comprime la carpeta LOGS que se encuentra en la carpeta principal de AwitaBot, y envíala a través de discord en el canal de reporte de bugs o por privado a @merk_cat
  • Si es posible, describir los movimientos que han llevado a ese bug, aunque entiendo que a veces es complicado. Ejemplo: he conectado el bot, le he dado al botón de spawnear el boss, no ha aparecido y al cabo de unos segundos ha crasheado. No imagináis lo que me ayuda este tipo de información, aunque lo más esencial es la carpeta de LOGS.
  • Las cajas de comandos, son un tipo de bloque genérico que tiene el mismo funcionamiento para todos los comandos. El comando se escribe SIN la exclamación “!” y en minúsculas (aunque por lo general está configurado para que evite las mayúsculas, es mejor ponerlo directamente en minúsculas). Ejemplo:
  • El campo de coste es para añadir un coste de puntos al comando.
  • Los campos de tiempo ( cooldowns y otros campos que no haya una definición específica ) son siempre en segundos.
  • El “check” de activo, sirve para activar o desactivar el comando. Con el tick puesto, es que está activo.
  • Lo mismo que el check de activo, es para los de los permisos. Si el check de viewer está vacío y el de sub activo, solo podrá usarlo el sub. Lo mismo para el resto.
  • El chatbot contiene un updater para actualizar con un sólo click. Al iniciar el programa, te pide el login y aparece abajo la versión actual y la del servidor, y un botón para abrir el updater.
  • Una vez en el updater, puedes elegir la versión. Se recomienda SIEMPRE estar en la última versión, pero el poder retroceder a una de las últimas versiones es por si la más reciente tiene algun bug crítico.
  • En la pestaña de opciones, hay un selector para el dispositivo de audio de salida. Hecho para poderlo usar con programas de ruteo de sonido como “Voicemeteer” y otros.
  • En la pestaña de Awita, hay un selector de voces para el comando de Text-To-Speech ( texto a voz ). Esta lista es de las voces que tienes instaladas en el PC, ya sea a través de Windows o programas externos. AwitaBot NO incluye ningún tipo de voz.
  • Por lo general, cualquier sonido ( comando texto a voz, sonido de “ring-ring” de las peleas, etc) tiene su propio control de volumen.
  • Algunos apartados tienen este tipo de configuración de bloque. Sirve para activar o desactivar todo el bloque entero, y/o añadir un cooldown genérico. Ejemplo

  • En este caso, por ejemplo, desactivarlo significaría no poder usar ningún comando relacionado con las peleas. Ni retar, aceptar o cancelar. El cooldown también afecta a TODOS los comandos. 

Los siguientes apartados, por falta de uso y feedback, se consideran experimentales. En principio, deberían funcionar, pero es posible que aparezca algún tipo de bug.

  • Sorteos
  • Pinturillo

APARTADOS

Pestaña principal para usar durante el streaming, consta de los siguientes apartados

  • Chat: chat de twitch incrustado directamente. Una vez logueado guarda la sesión.
  • Botones rápidos: los 4 primeros botones, se configuran en el apartado de utilidades, y sirven para lanzarlos al hacer click. El último, viene por defecto, y es para lanzar el BOSS que se configura en la pestaña de eventos.
  • Usuarios: lista de usuarios conectados al chat. Puedes quitar usuarios de la lista, marcándolos como “bot” en la pestaña de usuarios.
  • Navegador personalizable: abajo a la derecha, puedes configurar un enlace en el apartado de Opciones, para poner una web. Por ejemplo, puede ser la ventana incrustada de eventos de streamlabs, la lista de loots o cualquier otro que quieras.
  • Mensajes rápidos: aquí puedes configurar los botones de la pestaña de directo. Puesto que es un mensaje, es el único campo donde SÍ tienes que añadir el símbolo de exclamación “!” para ejecutar un comando.
  • Spawnear usuario: Sirve para añadir / quitar un usuario de los personajes en pantalla.
  • Dar puntos: puedes dar puntos a un usuario. Primer campo es el nombre de usuario y el segundo cantidad de puntos.
  • Regalar puntos a toda la sala: pues eso.
  • Puntos cada 60 segundos: la cantidad de puntos que se da a los usuarios conectados al chat, cada 60 segundos.
  • Nombre de los puntos: nombre de los puntos (plural) que aparecerá cada vez que se utilicen.
  • Mensaje !puntos: El mensaje que devolverá el chatbot al usar el comando !puntos. Los tags, se reemplazan por el texto que contienen para poderlo configurar a tu manera. Ejemplo: “{nick} tiene {puntos} puntos!” se convertirá en “Merk_cat tiene 100 puntos!”
  • Lista de usuarios: esta lista no se actualiza sola ( debes darle al botón para refrescarla ) y sólo funciona con el chat desconectado. Puedes eliminar y editar usuarios.
  • Rangos: Son los rangos que consiguen los usuarios al alcanzar X horas conectados a tu canal ( mientras el bot esté encendido, obviamente ). El tiempo está en horas.
  •  

Éstos comandos son simples, por el hecho que al poner X comando te devuelve X mensaje, y no se produce ninguna otra acción.

  • Puedes organizarlo por categorías, para una mejor ordenación y un activado / desactivado más rápido.
  • Si el mismo comando, lo repites varias veces, se mandarán todos los mensajes por el orden del campo “orden”. 
  • Se les puede añadir coste de puntos.
  • El “check” es para activar o desactivar. Con el tick es que está activado, y debe estar activado la categoría y el comando para funcionar.
  • El comando “awita” sirve para que se lea un mensaje con voz.
  • La voz se configura aquí, sólo aparecen las voces instaladas en tu ordenador, y requiere el botón de guardar para que se mantenga.

Comandos

  • Spawn: el comando para aparecer en pantalla. Si funciona, no da ningún mensaje de confirmación ( aunque se puede activar más abajo ) para evitar el “spam” del bot.
  • Mensaje: este comando manda un mensaje y/o emotes que aparece en forma de bocadillo encima del personaje en pantalla. Tiene una limitación de caracteres para evitar el mal uso. 
  • Salir: comando para salir de la pantalla. Se añadió para poder cambiar la skin una vez estas en pantalla, ya que tienes que salir y entrar para que se cambie.

Spawner

  • El spawner es la forma en que aparecen los personajes en pantalla. De momento sólo están las naves alienígenas, pero se añadirán más en un futuro.

Otros

  • Ruta HTML para añadirlo al programa de streaming.
  • Activar / desactivar los mensajes de confirmación ( es decir, si no faltan puntos, si no está ya en pantalla, etc ). 

Las peleas son pequeñas batallas entre dos jugadores, que aparecen visualmente en pantalla. Se apuesta una cantidad de puntos y el que gana se los lleva. Consta de tres simples comandos:

  • !pelear {usuario} {cantidad a apostar } : Reta a una pelea a otro usuario por una cantidad a apostar. Un usuario solo puede estar esperando una pelea a la vez, y tiene un cooldown de 1 minuto.
  • !aceptarpelea : Acepta una pelea a la que te han retado
  • !rechazarpelea: Rechaza la pelea

Configuraciones:

  • Apuesta mínima necesaria para poder retar a alguien a una pelea. Así se puede evitar muchas peleas por 1 punto, y tiene más “reto” o mérito jugar.
  • Volumen de la alerta, es el “ring-ring” de aviso que empieza una pelea al aparecer en pantalla
  • Botones para probar las alertas del overlay.

Una lista de mensajes que el chatbot lanza automáticamente. Se puede configurar un tiempo entre mensajes, y el número de mensajes que tienen que haber entre el último mensaje automático y el nuevo para evitar “spam”.

Los usuarios pueden añadir chistes a una base de datos, y luego reproducirlos aleatoriamente con otro comando.

  • Los chistes se pueden modificar / borrar en caso de ser ofensivos , spam o cualquier motivo.
  • Al reproducir los chistes, se hace de forma aleatoria. Se puede añadir el nombre de un usuario como parámetro del comando para reproducir un chiste aleatorio de ese usuario.

Este apartado está en desarrollo por su poco uso. Su función es bastante simple:

  • Configuras un comando que tengan que poner los usuarios para participar
  • Le das al botón “empezar”, y el chatbot empieza a detectar quién ha puesto ese comando y los añade a la lista.
  • Una vez rellenada la lista, pulsas el botón “Elegir Ganador” y manda un mensaje al chat con un usuario aleatorio de la lista.

Realmente hay muchas herramientas mejores, que filtran por tipo de usuario ( sub, viewer, etc ) que son más visuales, esto estaba pensado para algo más simple y rápido.

  • Comando promo: configura el comando y el texto de respuesta. Sirve para ser el típico mensaje de promoción. Sólo lo pueden usar los mods del canal y el streamer.
  • Voteban: una herramienta experimental y troll a partes iguales. Un usuario puede empezar una votación para banear temporalmente a un usuario. Se puede configurar el tiempo de baneo ( en segundos ), el porcentaje de usuarios que deben votar a favor para que se complete el ban, y el mensaje una vez se ha baneado. No es muy recomendada pero en su día pasamos una tarde divertida.

Este bloque, antes que nada, aclarar que NO es un song request real, aunque abajo lo llamaré así para aclararnos. En su defecto los usuarios pueden añadir canciones con el enlace o el nombre de la canción a una lista de reproducción que le asignes, pero no se reproduce sola, ni nada.

  • Lista de reproducción: una vez logueado, puedes seleccionar la lista que servirá para el “sr”. Puedes recargar el selector con el botón a su derecha, y vaciar la lista si quieres que vaya siendo temporal. Asegúrate de no vaciar una lista personal / que no quieras borrar!
  • Comando añadir a la lista de reproducción: se puede añadir con enlace o título de la canción.
  • Comando canción actual. Se puede dejar vacío para desactivar, sino el comando devuelve la canción actual ( con los tags que asignes )
  • Se pueden poner diferentes overlays:
    • Sólo un TXT con el texto de la canción.
    • HTML canción actual ( sólo portada )
    • HTML Con portada + texto que se mueve de derecha a izquierda.

Lista de comandos para lanzar un sonido y/o gif

  • Los sonidos pueden ser .WAV o .MP3
  • El comando y el nombre del archivo debe ser el mismo.
  • Los sonidos se ponen dentro de la carpeta de sonidos que se encuentra en la carpeta principal de awitabot, aunque se puede abrir con un botón en este apartado.
  • Si se rellena el campo de “Mensaje Notificación”, aparecerá en pantalla una notificación con el texto.
  • Igual que los sonidos, los gifs se ponen en la carpeta “gifs” y deben tener el mismo nombre el archivo y el campo “GIF”.
  • El botón de “cargar carpeta” se recomienda solo usar en la primera configuración. Lo que hace es leer la carpeta y añadir un comando por cada archivo que hay en la carpeta.

Contador Tiempo

Un contador regresivo que escribe el tiempo restante en un TXT, para poder ponerlo en el programa de streaming y configurar la fuente, tamaño, color, etc…

Suficientemente intuitivo. Seleccionas la fecha final para el contador y le das a iniciar. 

Comandos Contadores

Llevar la cuenta de cualquier cosa, ya sean muertes en el juego, número de veces que alguien pregunta algo, etc.

  • Ruta TXT para ponerlo en OBS
  • (Respuesta configurable) Para ver la cuenta actual !{nombre del comando}: ejemplo !muertes
  • (Sólo Mods) Para poner la cantidad exacta !{nombre del comando} {cantidad}: ejemplo !muertes 57
  • (Sólo Mods) Para añadir a la cuenta actual !{nombre del comando} +{cantidad}: ejemplo !muertes +3
  • (Sólo Mods) Para restar a la cuenta actual !{nombre del comando} -{cantidad}: ejemplo !muertes -5

Lotería

  • Cada X tiempo ( en minutos ) aparecerá un mensaje para el inicio de la lotería.
  • Para participar, los usuarios deben escribir la palabra clave. No es un comando, por lo tanto su mensaje sólo debe contener esa palabra, si no pones ninguna exclamación, los usuarios tampoco
  • Puedes configurar un intervalo de puntos como premio para el ganador.

Boss

  • Puedes configurar el boss para que aparezca cuando le das al botón de la pestaña de directo.
  • Este boss aparece en la pantalla de personajes en pantalla, y los usuarios que están en ella, se dirijen a el a luchar hasta que su vida baje a 0.
  • Se puede configurar la vida y el daño por segundo y usuario, así configurar la duración.
  • Lo demás es bastante intuitivo, recomiendo probarlo OFFLINE para ver su funcionamiento.

Como ya digo más arriba, este apartado es experimental, y por su poco uso puede contener bugs desconocidos.

  • Elije una palabra aleatoria con la web que aparece, o bien escribe una palabra.
  • Asegúrate de configurar la captura de pantalla de la ventana del pinturillo para poder streamearla.
  • Una vez rellenado el premio, la palabra y el tiempo máximo, inicia el pinturillo.
  • Los usuarios tendrán ese tiempo para acertarlo, y el que lo acierte recibirá el premio.
  • Comando amor: al escribir (por ejemplo) !love {usuario}, te dice un porcentaje aleatorio entre tu y esa persona. Se puede configurar de tal manera que sea “love”, “hate” o cualquier cosa que se te ocurra.
  • Comando robar: puedes robar a otro usuario. Se puede robar un 10% con un máximo de 100 puntos, y además puede salirte mal y ser tú el robado.
  • Comando ruleta: apuesta X puntos en la ruleta, con opción a ganar o perder.
  • Comando reaccionar: manda un emote a la pantalla que sube hasta desaparecer
  • Comando lluvia de emotes: manda una lluvia de emotes de arriba a abajo, configurable en cantidad y tamaño.

Archivos TXT: el último sub y el total de subs funciona bien, pero el último follower muestra tambien los “re-follows” ( gente que ya te seguía, te deja de seguir y vuelve a darle para aparecer el último ) así que no se recomienda usar éste último.

Notificaciones Awita

  • El sistema de notificaciones en pantalla genérico, que se usa en todos los casos que debe aparecer algún mensaje en pantalla.
  • Se puede configurar los efectos ( en la web de la librería encontraréis toda la lista )
  • Se puede configurar la imagen 
  • Se puede configurar el nombre
  • Se puede configurar el volumen del “blip” de la alerta.
  • Mantener en primer plano: el programa se mantiene siempre encima de las otras ventanas.
  • Dispositivo de salida del text-to-speech
  • Debug: puedes enviar un archivo de reporte de bugs desde aquí, aunque no se recomienda ya que no se puede añadir texto.
  • Pestaña directo: puedes configurar el enlace del navegador de la pestaña principal descrito más arriba.
  • Si tienes problemas con el login del bot o quieres cambiar la cuenta, aquí puedes reloguear la cuenta del bot
  • Acciones Usuarios: Desde aquí puedes reinciar los puntos, XP o rangos de TODOS los usuarios a la vez. Usar con precaución.