/ = = = = = = = = = = = = = = = = = 
 
 | H U X B O T   R E A D M E 
 
 \ = = = = = = = = = = = = = = = = = 
 
 
 
 I N T R O D U C T I O N 
 
 
 
 H u x B o t   i s   a   s i m p l e   I R C   b o t   c r e a t e d   t o   c o l l e c t   a n d   s a v e   i m a g e   l i n k s   p o s t e d   o n   I R C   c h a n n e l s . 
 
 I t   w i l l   r e a c t   t o   U R L s   p o i n t i n g   t o   . p n g ,   . j p g ,   . j p e g   a n d   . g i f   f i l e s ,   a s   w e l l   a s : 
 
 *   G e l b o o r u 
 
 *   S a f e b o o r u 
 
 *   K o n a c h a n 
 
 *   Y a n d e . r e 
 
 *   D a n b o o r u 
 
 *   H i j i r i b e 
 
 *   P i x i v 
 
 
 
 E v e r y t h i n g   w i l l   b e   s a v e d   t o   a   f i l e   n a m e d   i m g l i s t . t x t   i n   t h e   d i r e c t o r y   o f   t h e   e x e c u t a b l e . 
 
 
 
 S E T U P 
 
 
 
 U p o n   e x e c u t i o n ,   H u x B o t   w i l l   a t t e m p t   t o   r e a d   a   c o n f i g   f i l e s .   B y   d e f a u l t   i t   w i l l   b e   r e a d   f r o m   t h e   l o c a t i o n   o f   t h e   e x e c u t a b l e ,   b u t   y o u   c a n   s p e c i f y   y o u r   o w n   f i l e   l o c a t i o n   u p o n   l a u n c h ,   p r o v i d i n g   i t   a s   a   l a u n c h   p a r a m e t e r .   C o n f i g   f i l e   c o n t a i n s : 
 
 *   S e r v e r   a d d r e s s 
 
 *   C h a n n e l ( s )   n a m e   -   d i v i d e   t h e m   w i t h   c o m m a s 
 
 *   B o t ' s   n i c k n a m e 
 
 *   N i c k S e r v   p a s s w o r d   f o r   t h e   b o t 
 
 *   M a s t e r ' s   n i c k n a m e   -   m o s t   c o m m a n d s   a r e   o w n e r - o n l y 
 
 
 
 I f   t h e   i n f o r m a t i o n   r e a d   f r o m   c o n f i g u r a t i o n   f i l e   i s   i n c o m p l e t e ,   y o u   w i l l   b e   p r o m p t e d   t o   f i l l   t h e   m i s s i n g   p a r t s   i n   a n d   t h e y   w i l l   b e   s t o r e d   i n   t h e   c o n f i g u r a t i o n   f i l e   f o r   f u t u r e   u s e . 
 
 I n   c a s e   t h e   f i l e   d o e s n ' t   e x i s t ,   i t   w i l l   b e   c r e a t e d   u s i n g   t h e   i n f o r m a t i o n   p r o v i d e d   u p o n   l a u n c h . 
 
 
 
 O p t i o n a l   c o n f i g   p a r a m e t e r s : 
 
 *   f i l e p a t h   -   p a t h   t o   t h e   l i s t   f i l e 
 
 *   f i l t e r   -   p a t h   t o   t h e   f i l t e r s   f i l e 
 
 *   i g n o r e   -   b l a c k l i s t 
 
 
 
 S u p p o r t e d   c o m m a n d   l i n e   a t t r i b u t e s : 
 
 *   - a l l   -   H u x B o t   w i l l   s a v e   a l l   l i n k s ,   n o t   j u s t   i m a g e s 
 
 *   - c   < p a t h >   -   H u x B o t   w i l l   l a u n c h   w i t h   a   s p e c i f i e d   c o n f i g   f i l e 
 
 *   - t   < p a t h >   -   H u x B o t   w i l l   r e a d   t h e   s p e c i f i e d   t r i g g e r   l i s t 
 
 *   - s   -   H u x B o t   w i l l   c l o s e   i m m e d i a t e l y   a f t e r   q u i t t i n g   f r o m   I R C 
 
 
 
 U S A G E 
 
 
 
 T h e   m a i n   p u r p o s e   o f   t h e   b o t   i s   s a v i n g   i m a g e   l i n k s .   T h e y   w i l l   b e   r e a d   f r o m   a n y   w o r d   o f   t h e   m e s s a g e .   T h e y   w i l l   b e   s t o r e d   i n   n e w   l i n e   e a c h   i n   t h e   t e x t   f i l e   s a v e d   a s   t h e   l i s t   ( d e f a u l t   i s   i m g l i s t . t x t   i n   t h e   e x e c u t a b l e   l o c a t i o n ) .   Y o u   w i l l   b e   n o t i f i e d   i n   b o t ' s   w i n d o w   i f   a n   i m a g e   h a s   b e e n   s a v e d . 
 
 H u x B o t   a l s o   s u p p o r t s   t r i g g e r s . 
 
 *   ! s a y   < c h a n n e l / u s e r >   < m e s s a g e >   -   H u x B o t   w i l l   s a y   t h e   m e s s a g e   o n   s e l e c t e d   c h a n n e l   o r   s e n d   i t   t o   s e l e c t e d   u s e r . 
 
 *   ! j o i n   < c h a n n e l >   -   H u x B o t   w i l l   a t t e m p t   t o   j o i n   t h e   p r o v i d e d   c h a n n e l . 
 
 *   ! p a r t   -   H u x B o t   w i l l   l e a v e   t h e   c h a n n e l   i t   j o i n e d   u p o n   l a u n c h . 
 
 *   ! q u i t   < m e s s a g e >   -   H u x B o t   w i l l   q u i t   I R C   s e r v e r   a n d   c l o s e .   T h e   m e s s a g e   i s   o p t i o n a l . 
 
 *   ! s o r t   -   H u x B o t   w i l l   c r e a t e   a   s e p a r a t e   l i s t   f i l e ,   n a m e d   t h e   s a m e   a s   t h e   o r i g i n a l   l i s t ,   b u t   w i t h   _ s o r t e d   s u f f i x .   T h e   n e w   l i s t   w i l l   b e   o r d e r e d   b y   n a m e . 
 
 *   ! h t m l   -   H u x B o t   w i l l   c r e a t e   a   s e p a r a t e ,   s o r t e d   l i s t   f i l e ,   n a m e d   t h e   s a m e   a s   t h e   o r i g i n a l   l i s t ,   b u t   w i t h   . h t m l   e x t e n s i o n . 
 
 *   ! t r i g l i s t   -   H u x B o t   w i l l   l i s t   a l l   l o a d e d   c u s t o m   t r i g g e r s . 
 
 *   ! r e l o a d   -   H u x B o t   w i l l   r e l o a d   c u s t o m   t r i g g e r s . 
 
 *   ! t i m e   < t i m e z o n e >   ( p u b l i c )   -   H u x B o t   w i l l   p r o v i d e   c u r r e n t   t i m e   i n   g i v e n   t i m e z o n e . 
 
 
 
 Y o u   c a n   c r e a t e   y o u r   o w n   t r i g g e r s .   A   s a m p l e   f i l e   h a s   b e e n   a t t a c h e d .   T r i g g e r s   s h o u l d   l o o k   l i k e   t h i s :   < t r i g g e r > | < r e s p o n s e >   o r   < t r i g g e r > | < r e s p o n s e > | < c o o l d o w n   i n   s e c o n d s > . 
 
 E x a m p l e s : 
 
 *   ! f l i p | (   `  )   ~ ;%%;%| 1 0   ( w i t h   1 0   s e c o n d s   c o o l d o w n ) 
 
 *   q u c y y | %( 0) %  ( n o   c o o l d o w n ) 
 
 A l l   P M s   s e n t   t o   H u x B o t   w i l l   b e   r e l a y e d   t o   t h e   m a s t e r ,   a l o n g   w i t h   t h e   s e n d e r ' s   n i c k . 
 
 
 
 C H A N G E L O G 
 
 -   1 . 1 1   -   2 5 . 0 7 . 2 0 1 2   -   a d d e d   ! t i m e   t r i g g e r 
 
 -   1 . 1 0   -   2 1 . 0 7 . 2 0 1 2   -   a d d e d   ! t r i g l i s t   a n d   ! r e l o a d   t r i g g e r s ;   a d d e d   " - s "   c o m m a n d   l i n e   a t t r i b u t e 
 
 -   1 . 0 8   -   2 0 . 0 7 . 2 0 1 2   -   a d d e d   " - c "   a n d   " - t "   c o m m a n d   l i n e   a t t r i b u t e s 
 
 -   1 . 0 7   -   2 0 . 0 7 . 2 0 1 2   -   a d d e d   c u s t o m   t r i g g e r s 
 
 -   1 . 0 6   -   1 9 . 0 7 . 2 0 1 2   -   a d d e d   ! h t m l   t r i g g e r 
 
 -   1 . 0 5   -   1 9 . 0 7 . 2 0 1 2   -   a d d e d   P M   r e l a y i n g 
 
 -   1 . 0 4   -   1 1 . 0 7 . 2 0 1 2   -   a d d e d   b l a c k l i s t 
 
 -   1 . 0 3   -   1 1 . 0 7 . 2 0 1 2   -   c h a n g e d   ! s a y   c o m m a n d 
 
 -   1 . 0 1   -   0 7 . 0 7 . 2 0 1 2   -   a d d e d   " - a l l "   c o m m a n d   l i n e   a t t r i b u t e 
 
 -   1 . 0 0   -   0 1 . 0 7 . 2 0 1 2   -   F i r s t   r e l e a s e 