Esta biblioteca recopila Lua scripts escritos para Verlihub hubs. Cada script agrega una pequeña función del hub sin cambiar la fuente C++ Verlihub ni compilar un complemento personalizado.
Utilice estos artículos para mostrar bots, comandos auxiliares, mensajes cronometrados, entradas de listas de usuarios, asistentes de validación y pequeñas automatizaciones. Mantenga el trabajo pesado fuera del proceso del hub y use Lua solo para el comportamiento del concentrador que debe ejecutarse dentro de Verlihub.
Propósito de esta biblioteca
La biblioteca existe para que el propietario de un centro pueda revisar un script, comprender qué cambia, copiarlo en el directorio esperado, ajustar la configuración documentada, cargarlo, probarlo y desactivarlo nuevamente sin conjeturas.
Cada artículo de guión debe indicar:
- Qué hace el guión.
- Qué característica Verlihub cambia o agrega.
- Ya sea que cree un bot, un comando, un temporizador, un enlace, una entrada de lista de usuarios o un asistente de validación.
- Dónde se debe colocar el archivo de script.
- Cómo se carga, recarga, descarga o desactiva el script.
- Qué configuraciones son seguras para editar.
- De qué complemento Verlihub o permiso del concentrador depende el script.
- Límites conocidos, notas de versión y advertencias de producción.
Estándares de guión recomendados
Los scripts de esta biblioteca deben ser pequeños, legibles y con control de versión. Un archivo Lua debería hacer un trabajo. No mezcle un robot de reloj, un comando de reglas, una verificación antispam y una limpieza de base de datos en un solo archivo a menos que el artículo explique por qué esas acciones deben enviarse juntas.
- Utilice un propósito principal por guión.
- Coloque comentarios claros en la parte superior del archivo.
- Valores configurables del grupo cerca de la parte superior.
- No codifique rutas privadas a menos que el artículo las explique.
- Evite escrituras innecesarias en la base de datos.
- Evite bloquear llamadas de red desde eventos centrales.
- Evite bucles pesados dentro de los ganchos de inicio de sesión, chat o lista de usuarios.
- Deje claro el comportamiento de inicio y apagado.
- Comandos de carga, recarga y descarga de documentos.
Para los centros de producción, los scripts más pequeños suelen ser más fáciles de depurar, deshabilitar y reemplazar que un archivo grande que controla el comportamiento del centro no relacionado.
Encabezado de guión sugerido
Comience cada guión con un breve bloque de comentarios. El encabezado debe indicarle al siguiente operador cuál es el archivo antes de que el script toque un centro en vivo.
-- Script: time.lua
-- Purpose: Displays a clock-like bot entry in the Verlihub user list.
-- Scope: User-list display only.
-- Author: PWiAM
-- Notes: Test on a private hub before production use.Formato de artículo de guión sugerido
Cada artículo secundario en esta sección debe usar la misma forma para que los guiones se puedan comparar y revisar rápidamente.
- Descripción general.
- Requisitos.
- Instalación.
- Configuración.
- Cargando el guión.
- Pruebas.
- Descarga o inhabilitación.
- Solución de problemas.
- Guión completo.
- Páginas relacionadas.
Instalación de secuencias de comandos
La ubicación exacta depende de la ruta de instalación de Verlihub, pero los archivos personalizados Lua deben residir en un directorio propiedad del usuario del servicio que ejecuta el concentrador.
sudo mkdir -p /usr/local/etc/verlihub/lua
sudo chown -R verlihub:verlihub /usr/local/etc/verlihub/lua
sudo chmod 750 /usr/local/etc/verlihub/luaLuego coloque cada script en ese directorio:
/usr/local/etc/verlihub/lua/time.luaSi su servicio se ejecuta con un usuario diferente, cambie el propietario de esa cuenta. no usar chmod 777 /usr/local/etc/verlihub/lua. Lua archivos se ejecutan dentro del proceso central, por lo que el acceso de escritura pertenece solo a administradores confiables.
Cargando y recargando scripts
Los scripts Lua requieren que se instale y habilite primero el complemento Verlihub Lua. Si el complemento no está cargado, revise el artículo de configuración principal Lua antes de cargar archivos de script.
Las comprobaciones de complementos útiles incluyen:
!pluglist!lstplug
Utilice un flujo de trabajo de pequeños cambios al editar un script en vivo:
- Guarde una copia de seguridad del archivo de trabajo actual.
- Cambie una configuración o una función.
- Vuelva a cargar solo ese script si su compilación lo admite.
- Verifique la salida del concentrador y los registros Verlihub.
- Revierta rápidamente si los usuarios ven errores, bots duplicados o resultados de chat repetidos.
Si los comandos de recarga de script no están disponibles en su compilación Verlihub, reinicie o vuelva a cargar el complemento Lua de acuerdo con los comandos de administración de complementos de su servidor.
Probar scripts de forma segura
Pruebe los scripts Lua en un centro privado o en una ventana de mantenimiento silenciosa antes de confiar en ellos en producción.
- Confirme que el script se cargue sin errores de sintaxis.
- Confirma que no inunda el chat principal.
- Confirme que no crea bots duplicados ni entradas repetidas en la lista de usuarios.
- Confirme que se comporta correctamente después de la recarga.
- Confirme que se comporta correctamente después de reiniciar el concentrador.
- Confirme que los operadores pueden desactivarlo rápidamente.
- Para scripts de comando, pruebe con usuarios normales y cuentas de operador.
- Para mensajes programados o entradas de listas de usuarios, pruebe el intervalo para que el script no genere ruido ni se cargue.
Notas de seguridad de producción
El código Lua se ejecuta dentro del proceso central. Un script incorrecto puede afectar el chat, el inicio de sesión, las actualizaciones de la lista de usuarios o el cierre de complementos.
Evitar:
- Bucles infinitos.
- Duerme mucho dentro de los controladores de eventos.
- Lecturas de archivos grandes durante eventos de usuario.
- Bloqueo de solicitudes HTTP externas.
- Consultas intensas a bases de datos desde chat o enlaces de inicio de sesión.
- Mensajes de difusión repetidos sin límites.
- Scripts que no se pueden descargar limpiamente.
Preferir:
- Controladores de eventos pequeños.
- Borrar valores de configuración.
- Temporizadores conservadores.
- Lógica de comando simple.
- Registrar solo cuando le brinda al operador información útil.
- Fácil reversión.
Si una tarea tarda mucho en ejecutarse, muévala fuera de Verlihub y deja que Lua active o muestre el resultado.
Control de versiones
Mantenga scripts personalizados en Git cuando sea posible. Un pequeño repositorio en el directorio de scripts es suficiente para muchos centros.
cd /usr/local/etc/verlihub/lua
git init
git add .
git commit -m "Initial Verlihub Lua scripts"Antes de editar un guión de producción, verifique lo que ya ha cambiado:
git status
git diffDespués de probar el cambio:
git add time.lua
git commit -m "Update time.lua clock display"Esto le brinda al siguiente operador un historial de cambios y una ruta de reversión rápida.
Guiones disponibles
time.lua Verlihub script de reloj de lista de usuarios crea una pequeña entrada de lista de usuarios similar a un bot que muestra la hora actual.
Úselo cuando un centro desee una entrada de reloj visible sin ejecutar un proceso de bot independiente o un servicio externo. Es el primer ejemplo mantenido en esta biblioteca y puede usarse como patrón para otros scripts orientados a visualización.
Agregar más secuencias de comandos
Los nuevos scripts deben agregarse como artículos secundarios en esta sección, no pegarse en esta página de índice. Los buenos candidatos incluyen:
- Guión del mensaje de bienvenida.
- Guión de recordatorio de reglas.
- Script de comando auxiliar del operador.
- Guión de anuncio programado.
- Script de visualización del recuento de usuarios.
- Script de ayuda antispam.
- Script de comando de información del concentrador.
- Script de aviso del modo de mantenimiento.
Cada artículo nuevo debe incluir notas de instalación, valores de configuración, pasos de prueba, pasos de descarga y la lista completa de scripts.