-==============================-
-===== ][ Yet Another Half-IRC ][ =====-
-==============================-
Versión Actual: v1.35

Índice
------------------------------

1. Introducción
2. Requerimientos
3. Instalación y configuración
4. Chateando desde el HL
5. FAQ
6. Ficheros de lenguaje
7. Problemas conocidos

8. Historial de versiones
-- Notas finales

------------------------------


1. INTRODUCCIÓN
-----------------------------------------------------------------------------------------

'Yet Another Half-IRC' es un addon para mIRC 6 que permite interactuar con el IRC desde el juego Half-Life (y cualquiera de sus Mods). Más allá de simplemente enviar texto, YAH es una compleja aplicación que permite por ejemplo seleccionar que eventos deben ser monitorizados y en que canales, a la vez que para visualizar el texto durante el juego, podemos verlo en consola o en pantalla (mediante el uso de búferes), mientras jugamos y sin interferir en el desarrollo del juego.

En sentido inverso, podemos enviar texto a cualquier canal en el que estemos, o por privado (query). Así mismo, se han implementado una serie de comandos para por ejemplo ver o cambiar la ventana activa, entrar y salir de canales, ponerse away o cerrar por completo el mIRC entre otros.

Para un completo aprovechamiento de las características de esta aplicación, lee por completo este Readme, así evitaras muchos errores frecuentes.


2. REQUERIMIENTOS
-----------------------------------------------------------------------------------------

Este script ha sido desarrollado para mIRC 6.x y Half-Life 1.1.1.0, aunque es posible que funcione correctamente con versiones anteriores.

Cualquier sistema operativo sobre el que corran sin problemas las aplicaciones mencionadas es factible para el uso de YAH.


3. INSTALACION Y CONFIGURACIÓN
-----------------------------------------------------------------------------------------

Yet Another Half-IRC viene distribuido en un fichero .zip cuyo contenido debe ser extraido en una carpeta llamada YAH dentro del directorio del mIRC (por ejemplo: C:\mIRC\YAH). Una vez hecho esto, con el mIRC abierto y conectado a una red de IRC, carga el addon tecleando lo siguiente en cualquier ventana (sólo necesitas hacerlo la 1º vez):

/load -rs YAH\yah.mrc

Si el proceso es correcto, verás el aviso de que el script se ha cargado correctamente, así como el nombre y versión del mismo.

La primera vez que lo cargues, el programa te pedirá que selecciones uno de los idiomas disponibles. Es imprescindible que selecciones uno de ellos, de lo contrario el script se auto-descargará. A continuacion detectará que no tienes un fichero de configuración y te avisará de ello, abriendo la ventana de setup de la aplicación. Para configurarlo manualmente, puedes acceder al menú tecleando:

/yah

en cualquier ventana, o usando los menús accesibles con el boton secundario del mouse en las ventanas de canales, Estado y en la barra de menús.

En el Setup tenemos 3 pestañas:

- Pestaña General:

Para empezar, puedes activar o desactivar las dos funciones principales del YAH: El envío de texto del IRC al Half-Life y el envío desde la consola al IRC (tanto texto como comandos). Con la 1º activada, puedes seleccionar que eventos se van a monitorizar en los canales que tengas en la lista. Así por ejemplo, si solo tienes activado el evento "Texto Canal", solo veras en el HL lo que escribe la gente de los canales de la lista, pero no veras si se cambian el nick, si salen del canal/IRC y tampoco los querys (privados) que te abran. Ten en cuenta que monitorizar muchos eventos en varios canales a la vez puede hacer más difícil de leer por la cantidad de información que llega mezclada.

Por otra parte, puedes configurar que hacer en caso que alguien te avise en el IRC (mencione tu nick). Puedes hacer que el canal en el que te llamaron sea añadido automáticamente a la lista durante el tiempo que especifiques en minutos, de forma que puedas escribir en este canal para responder al aviso. Para hacer esto aún más fácil, tienes la posibilidad de cambiar automáticamente la ventana activa a la del canal en el que te avisaron, facilitando así la tarea de enviar texto al mismo desde la consola del HL (ver sección 3).

Por último, se ofrece la posibilidad de monitorizar el canal que este activo, sin necesidad de añadirlo a la lista. Puedes usar esta característica por ejemplo, para monitorizar un canal en el que no estás habitualmente.

- Pestaña Configuración:

Es muy importante que configures correctamente la ruta al Half-Life y el Mod en el que vas a usar el programa, por que de lo contrario no podrás enviar texto y/o comandos al IRC desde la consola, ni tampoco usar el Buffer de envío. Por ejemplo:

C:\Juegos\Half-Life\cstrike\


Usar Buffer de envío: El uso de bufferes resulta en un sistema mucho más cómodo para ver lo que sucede en el IRC, pues se crea la sensación de una ventana (ya sea la propia consola o la pantalla) dedicada exclusivamente a recibir el texto del mismo. Si esta opción esta desactivada, el texto se ira enviando al juego en el momento en que aparezca en el mIRC, mezclándose con el texto propio del juego. Sin embargo, al activarlo, envía el texto de forma continuada sólo cuando se presiona la tecla configurada, pudiendo atender el IRC cuando te apetezca. Verás el buffer sobreimpresionado en la pantalla del juego, y con otra pulsación dejaras de recibirlo. Puedes configurarlo a tu gusto, indicando el nº de líneas que contendrá el buffer y el tiempo (en segundos) que tarda en actualizarse. (Nota: Para poder usar esta caracteristica, debes tener activado "HL --> IRC" y la ruta al HL correctamente configurada).

Como funcionalidad añadida, se incluye el buffer contestador o buffer de avisos, que mantiene sólo las entradas correspondientes a la gente que ha mencionado tu nick en cualquier canal (este o no en la lista) o en un Query. Puedes acceder a este buffer mediante la otra tecla que hayas asignado y siempre de forma complementaria al
buffer normal, es decir, no puedes ver ambos a la vez.

Las teclas que hayas seleccionado para cada buffer se guardan, junto con el resto de alias necesarios para que la aplicación funcione correctamente, en el directorio que tengas configurado para el juego, en un fichero llamado yahirc.cfg. Además (de forma opcional) se añade una entrada al fichero autoexec.cfg para que sea cargado automáticamente al arrancar el Half-Life.

Por ultimo, en esta pestaña puedes configurar si quieres ver el texto que envías, muy útil para saber que realmente llego a la persona/canal deseado. No olvides tampoco echar un vistazo a los comandos de consola, que tienes listados en esta pestaña. Encontraras una breve descripción de lo que hacen al pasar el puntero del ratón sobre los mismos.

- Pestaña Acerca de:

No creo que necesite descripción ;) Recuerda pasar de vez en cuando por la Web del programa para estar al día de actualizaciones, bugs, noticias, etc.

 

4. CHATEANDO DESDE EL HALF-LIFE
-----------------------------------------------------------------------------------------

Bien, ya tienes la aplicación configurada y te dispones a jugar. Recuerda que es imprescindible tener activada la sección "HL --> IRC" y la ruta al juego correcta para poder enviar texto al IRC desde el Half-Life, ya que no viene configurado por defecto.

Una vez con el juego en marcha, debes saber la regla básica: Cualquier texto o comando que envíes al IRC debe empezar por el identificador ‘irc’. Esto es muy importante, pues de otro modo el script no lo reconocerá.

Vamos a distinguir 4 secciones:

1.- Enviando texto a un canal:

Para enviar texto a un canal especifico, que debes tener abierto:

(Nota: ']' denota el prompt de la consola)

]irc #mi_canal hola, que tal estas?

Enviaría "hola, que tal estas" a el canal #mi_canal


2.- Enviando texto a un privado (query):

Funciona de forma similar a con los canales, excepto que el primer argumento debe ser el comando /query seguido del nick de la persona con la que queremos hablar en privado.
Ejemplo:

]irc /query fulanito te estaba buscando

abrirá una ventana de privado a fulanito y escribira "te estaba buscando" en ella. (Nota: La ventana activa cambiará automaticamente a la de dicho privado sólo si se acaba de iniciar la conversación).


3.- Enviando texto a la ventana activa:

Podemos enviar texto directamente a la ventana activa, ya sea un canal o un query, escribiendo directamente. (Nota: Puedes consultar cual es la ventana activa con el comando /awin)
Ejemplo:

]irc buenos dias

enviaría el texto "buenos dias" a la ventana activa en ese momento.


4.- Usando comandos

Hemos implementado una serie de comandos en el script para añadirle la funcionalidad de no tener que salir del juego para llevar a cabo acciones básicas en el IRC, como son entrar o salir de un canal, ponerse away, cambiar el nick, la ventana activa, etc. También es posible añadir/borrar canales de la lista de monitorizacion desde la consola con el comando /chan.

Puedes ver el listado completo de comandos en la pestaña Configuración del programa, así como una breve descripción de lo que hacen. También puedes consultar este listado y la sintaxis de cada uno desde la consola mediante el comando /help:

]irc /help

devolverá un listado de los comandos posibles.

]irc /help /awin

muestra la ayuda especifica del comando /awin. Una vez que sabemos lo que hace y como usarlo podemos probarlo:

]irc /awin #mi_canal

Ésto nos cambiará la ventana activa del mIRC a el canal #mi_canal, y veremos un aviso informando de que ahora la ventana activa es dicho canal.

 

5. FREQUENTLY ASQUED QUESTIONS (FAQ)
-----------------------------------------------------------------------------------------

P: No me reconoce el identificador 'irc'. Me dice, comando desconocido.

R: Asegúrate de haber configurado la ruta correcta del juego, por ejemplo: "C:\Sierra\Half-Life\cstrike\" (para el juego Counter-Strike) y comprueba que en tal directorio existe el fichero yahirc.cfg, y que hay un 'exec yahirc.cfg' en tu autoexec.cfg (también en el mismo directorio). Si todo esta en orden pero sigue sin reconocerlo, prueba a ejecutar manualmente el fichero desde la consola, tecleando 'exec yahirc.cfg'


P: Las teclas que tengo configuradas para los bufferes no funcionan.

R: La causa más frecuente de este error es la sentencia "unbind all" en la configuración personalizada del juego, pués esta se ejecuta después del autoexec.cfg. Una solución es ejecutar manualmente el fichero yahirc.cfg desde la consola o añadir 'exec yahirc.cfg' a nuestro propio fichero de configuración.


P: ¿Puede el YAH ser erroneamente detectado como un cheat?

R: No, pues no es un "client hook" (como el OGC) y no interfiere para nada en el juego. Solo presenta texto en pantalla mediante el uso de comandos totalmente permitidos.

 

6. FICHEROS DE LENGUAJE
-----------------------------------------------------------------------------------------

YAH no está limitado a los idiomas que vienen por defecto, puedes crear tu propio fichero de lenguaje para que estés más a gusto con el entorno. Añadir un idioma es sencillo, tan sólo tienes que coger uno de los ficheros de lenguaje (.lng) que vienen con el script, hacer una copia, renombrarlo a tu_idioma.lng y con un editor de textos traducir cada línea siguiendo estas indicaciones:

- Respeta la numeración y el espaciado de cada línea, así como el símbolo '=' al comienzo de cada una.

- En la sección [credits] escribe los datos que creas necesarios, puedes dejar algún campo vacio si quieres.

- En la sección [gui] es muy importante que trates de respetar la longitud de las frases. Si son muy largas saldrán cortadas, así que usa abreviaturas si es necesario.

- La sección [console] NO debe contener caracteres incompatibles con la consola del Half-Life (que no se muestren correctamente). Así por ejemplo, se deben evitar las vocales acentuadas y los caracteres propios de ciertos idiomas (ñ, Ç, ø, etc). El resto de secciones pueden ser traducidas sin esta restricción.

Existen partes que NO se deben traducir, aquellas que contienen identificadores y comandos. Si dudas de alguna puedes comparar con otro fichero de los incluidos con el script. Son identificadores:

- Los indicadores de sección: [credits], [gui], [console] y [engine]
- Las palabras que empiecen por '$' , '/' ó '%'.Por ejemplo: "$1", "$nick", "/chan", "%yahname", "$mircdir $+ YAH\"
- Los argumentos fijos de los comandos, cómo: "20=ERROR! Uso: /chan [add/del] #canal" dónde "add/del" no deben ser traducidos pero si el #canal. Es decir, aquellos argumentos que representan un parametro fijo, no un contenido, no deben ser traducidos.

Es muy importante que trates de distinguir el contexto de cada frase para una correcta traducción.

Si has creado tu propio lenguaje no incluido ya en esta versión de YAH y quieres compartirlo con los demás, puedes enviárnoslo para que sea publicado en la web y/o en la próxima versión del programa. Para ponerte en contacto con nosotros usa el correo electrónico o los foros.

 


7. PROBLEMAS CONOCIDOS
-----------------------------------------------------------------------------------------

- Posiblemente debido a algún bug del mIRC, en ocasiones no se muestra correctamente la ventana activa.

- El uso del buffer sobreimpresionado en pantalla puede verse afectado por scripts de compra o similares que usen el comando "developer 0". En caso de que deje de mostrarse el buffer, basta con declear "developer 1" en la consola o darle dos veces a la tecla de recibir el buffer.

- Este script no funciona correctamente con programas externos para subir la prioridad del proceso hl.exe, como por ejemplo WinLauncher XP.

- El uso de la opcion "Cambiar ventana activa" puede causar en ciertas ocaciones que la aplicacion mIRC pase automaticamente a ser la ventana activa del escritorio, minimizandose el juego Half-Life. Estamos investigando como evitarlo.

 

8. HISTORIAL DE VERSIONES
-----------------------------------------------------------------------------------------

--> 06/11/2002 - v1.35

- Corregido: Los timers no se paran ante una desconexión del IRC
- Corregido: Bug al configurar la ruta al Half-Life
- Corregido: Mejorado el comando /query, que podía no funcionar con ciertos scripts
- Añadido: Función de autotesteo para ayudar a resolver problemas
- Añadido: Timestamp al buffer contestador
- Añadido: El Readme traducido al inglés
- Segunda versión lanzada, en esta ocasion para el mundo entero :)

--> 27/10/2002 - v1.30 Beta

- Corregido: diversos fallos menores en los ficheros de lenguaje
- Corregido: Cambiados los límites de las líneas del buffer y tiempo de refresco
- Corregido: Diversas optimizaciones y correciones de código
- Corregido: Los cambios en las variables no se hacen efectivos hasta cerrar el GUI
- Corregido: La configuración se guarda correctamente (en memoria) al cerrar el GUI con la X
- Corregido: Diversas optimizaciones y correciones de código
- Corregido: Menor uso de recursos mientras se esta jugando
- Corregido: El formato del Readme.htm, ahora se adapta al ancho de la ventana del navegador
- Añadido: Aviso de path incorrecto en el GUI


--> 12/10/2002 - v1.21 Beta

- Corregido: Numerosas correcciones y mejoras para el Multi-Lenguaje
- Corregido: Error que desconfiguraba el path al Half-Life
- Corregido: el evento QUIT se enviaba aunque el canal no estuviera monitorizado
- Corregido: Bug en la DLL que impedía listar el 1º condump encontrado
- Corregido: Mejorada la verificación del path (compatibilidad con Counter-Strike Retail) y de los ficheros de lenguajes
- Corregido: Los querys ya no establecen la ventana como activa automaticamente
- Corregido: Error al deshabilitar la opción de Usar Buffer de envío
- Eliminado: El comando /buffer para usarlo desde la consola, se controla el buffer sólo con la tecla configurada al efecto
- Añadido: Entradas de menu en la barra de menús y ventanas de canales y Status.


--> 26/09/2002 - v1.15 Beta

- Añadido: Primera implementación del sistema Multi-lenguaje
- Corregido: Mejora en la comprobación del path al Half-Life
- Corregido: Los nombres de alias y variables han sido normalizados (yah.*) para evitar posibles problemas con otros scripts.
- Corregido: Todos los comandos de consola están ahora en inglés


--> 23/09/2002 - v1.05 Beta

- Corregido: Nueva DLL en VC++ que evita los problemas de imcompatibilidad con ciertas configuraciones
- Corregido: bug al crear la cfg si no se usa el Modo Buffer
- Añadido: Comprobación de instalacion correcta y de versión del mIRC


--> 21/09/2002 - v1.01

- Corregido: Optimización de código para evitar errores.
- Corregido: Últimos ajustes del GUI para la version final.
- Corregido: La salida de los echos ahora es mas ordenada.
- Añadido: El mensaje de expulsión ante un KICK.
- Primera release al publico ;)


--> 19/09/2002 - v0.99 Beta

- Añadido: Ahora el script debe instalarse en un directorio propio ($mircdir\YAH).
- Añadido: Añadir el 'exec yahirc.cfg' al autoexec.cfg es ahora opcional.
- Añadido: El comando /query para abrir una nueva ventana de privado.
- Eliminado: El comando /evento, por no ser muy útil.


--> 14/09/2002 - v0.98 Beta

- Corregido: diversos bugs menores
- Añadido: Una DLL sustituye la función $findfile del mIRC, haciendo el trabajo más rápido.
- Eliminado: La opción de NO enviar el buffer a petición, por no ser necesaria.
- Half-Life IRC Client es ahora 'Yet Another Half-IRC', debido a la aparición de un
programa similar con el mismo nombre (HLirc by Disk2).


--> 02/08/2002 - v0.97 Beta

- Corregido: Error tipográfico en los alias para el HL.
- Corregido: Error al buscar el icono del mIRC.
- Corregido: Los binds de la CFG se asignaban a letras mayúsculas.
- Modificado: El uso del comando "contimes", causante real de los cuelgues.
- Modificado: Los buffers han sido implementados en memoria (Hash Tables) en vez
de en ficheros, disminuyendo así el uso de CPU por parte del mIRC.


--> 04/07/2002 - v0.95 Beta

- Primera version beta del 'Half-Life IRC Client' que sale a la luz para los beta-testers.
- Corregida la excesiva longitud de los alias, que causaba cuelgues en el HL.
- Últimos arreglos y corrección de bugs para la fase Beta.


Notas finales:
-----------------------------------------------------------------------------------------

Este software es distribuido gratuitamente y con la intención de serles útil a aquellos que lo usen, pero no se garantiza que sea compatible con todas las configuraciones o que funcione como debe. Los autores del mismo han puesto todo el esfuerzo posible en corregir bugs conocidos y en tener en cuenta la diversidad de entornos en que puede ser ejecutado. De cualquier modo, declinamos toda responsabilidad sobre los daños que pueda causar el uso del mismo.

- Yet Another Half-IRC -

Programado por PiTaGoRaS & CeeC
http://yah.frekuenzia.com
E-Mail: yah@frekuenzia.com

Agradecimientos:
- Al programa HLSW (www.hlsw.de), gracias a una de sus funciones surgió la idea original para el proyecto.
- A todos aquellos que colaboraron durante la fase Beta del programa y que mostraron un gran interés por participar :)
- A los amigos del IRC, con los que pasamos muchas horas mientras programábamos, por hacernos pasar esos buenos ratos ;)