
======================================================================================================
## iCHAT - open source (InterBBS) IRC client
======================================================================================================

For questions, private channels or operator status contact me:

    TheForze BBS:
	bbs.opicron.eu:23
	bbs.opicron.eu:22

    Netmail:
	fsxnet 21:3/126
	araknet 10:104/4


======================================================================================================
## Changelog
======================================================================================================
v1.5
- Refactor main listen thread
- [ADD] toggle channel users tab
- [ADD] keep track of away status
- [FIX] high cpu usage fixed
- [FIX] improved chat line splits
v1.4
- [ADD] Check irc nickname allready used, change nickname if in use
- [FIX] Change timeout on connect to server, move timeout to main listen loop
- [FIX] Significantly reduce CPU load by adding small timeout to chat thread
v1.3
- [FIX] Add check to pushover calls
v1.2
- [FIX] Make pushover optional because of required python libraries
v1.1
- [ADD] error reporting in threads
- [FIX] pager did not have delay between ticks
v1.0
- Initial release


======================================================================================================
## Installation
======================================================================================================

important: 
	edit your config.py.sample file and rename it to config.py in the /scripts/irc/ directory.

(OPTIONAL FOR PAGING FUNCTIONALITY) 
	edit .pushover.sample file and rename it to .pushover in /scripts/irc/

#Copy files
------------------------------------------------------------------------------------------------------
Copy irc.mpy to your /script/ folder

Copy contents of /irc/ to /script/irc/ folder

Rename config.py.sample to config.py in /scripts/irc/

(optional)Rename .pushover.sample to .pushover in /scripts/irc/

(optional)if you want to used the pager module enable "enable_pushover = True" in config**

Execute irc with the default Python script command in mystic menu


**python needs [Request] module to make this work


======================================================================================================
## Configuration
======================================================================================================

#iCHAT config file
------------------------------------------------------------------------------------------------------
Edit the renamed config.py in your /scripts/irc/ directory and adjust the settings as you prefer.

#Pushover config file
------------------------------------------------------------------------------------------------------
(OPTIONAL) If you wish to use pushover to receive paging notifications on various devices edit 
the renamed .pushover in /scripts/irc and fill in the correct information.



======================================================================================================
## IRC commands
======================================================================================================

/MSG [username]
------------------------------------------------------------------------------------------------------
Send private message to [username] in chat

/KICK [username]
------------------------------------------------------------------------------------------------------
Kick [username] from channel (if you are operator or half operator). Request operator status for 
channels on my board or through netmail.

/TOPIC [the new topic text]
------------------------------------------------------------------------------------------------------
Change the channel topic 

/ME [action text]
------------------------------------------------------------------------------------------------------
Display action in chat. Example "/ME dances" will output: "Username dances" in the action color.


**more to be included (any requests?)



======================================================================================================
## OPTIONAL PYTHON Parameters / Arguments
======================================================================================================

/SERVER 
------------------------------------------------------------------------------------------------------
iCHAT will by connect to the default configured server. By default this is the InterBBS #Trivia channel. 
If you wish to force iCHAT to use another server and/or channel use the /SERVER argument and set the 
ID (number) of the predefined irc server, channel and optional password in the configuration file.

For example:
	/SERVER 0
	/SERVER 1
	/SERVER 12


/PAGER
------------------------------------------------------------------------------------------------------
** (OPTIONAL)
** BEFORE USING PAGER FUNCTIONALITY BE SURE TO REQUEST AN PRIVATE CHANNEL, OR SET UP AN PRIVATE 
** CHANNEL ON YOUR OWN IRC SERVER. WITHOUT AN PASSWORD PROTECTED PRIVATE CHANNEL YOU COULD BE 
** IMPERSONATED. DO NOT USE PUBLIC CHANNELS.

By default iCHAT will to connect to the default channel without showing a pager. To open the sysop
pager before entering the private channel use the /PAGER argument.

The pager will page you through an pushover message on your iphone. To read more about Pushover see 
the following website: https://pushover.net/

Pushover is a free server which makes it possible to send texts to various devices. iCHAT sends an 
server and channel text your phone which opens the default irc client on your phone. 

When the sysop (you) responds in the irc channel the iCHAT pager will notice the response and open the 
channel for the user to chat. This is matched on sysop name, so again be sure to ONLY do this in a 
private channel!

If iCHAT detects that the sysop (you) leaves that channel the chat will close for the user. 
closing the chat on sysop leaving will only happen when in /PAGE mode of course.

to request private channel contact me..

    TheForze BBS:
	    bbs.opicron.eu:23
	    bbs.opicron.eu:22
    Netmail:
   		fsxnet 21:3/126
	    araknet 10:104/4


======================================================================================================
## Keys
======================================================================================================

#Chat
------------------------------------------------------------------------------------------------------
ESC - Exit
ENTER - Send message
CTRL-S - Show irc raw data in background of chat (kludge style)




======================================================================================================
## Greetings
======================================================================================================

#in no particular order
------------------------------------------------------------------------------------------------------
The Godfather, Paulie420, Xqtr, g00r00, ..

Thank you all for encouraging me to continue this mod =)

L8er
oP!