Mercurial > hg > nnchat
view README @ 157:3287901f9b78
Update documentation.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Wed, 03 Nov 2010 13:27:55 +0200 |
parents | a094a9b8cad9 |
children | 8bb12c22fe05 |
line wrap: on
line source
NNChat - extremely simple NN chat applet compatible client ========================================================== Written and designed by Matti 'ccr' Hämäläinen (C) Copyright 2008-2010 TNSP Distributed under DWETFYWTPL (Do What Ever The Fuck You Want To Public License), see file COPYING for more information. What is this? ------------- A simple NCurses-based client compatible with NewbieNudes.com chatroom protocol. There is a basic line-editing interface with some bells and whistles, such as a input history, logging to file, ignore lists, persistent configuration, etc. Usage ----- See the help, 'nnchat --help' for available command line options. By default the client connects to passion pit (TCP port 8003). By using other ports (option -p) you can connect to "members only" (8003) and free for all "main room" (8002) chats. Connect as registered user to members only chat: > nnchat username password Connect as guest to free for all main chat: > nnchat -p 8002 AnonymousAndy "" Keys ---- arrow left/right - Move cursor in the current buffer. arrow up/down - Browse input history. ctrl+left/right - Move cursor through words. ctrl+l - Refresh/redraw screen. F1 - Toggle between insert and overwrite modes. F2 - Clear current edit buffer. F4 - Toggle ignore mode on/off. F8 - Toggle private chat mode on/off. F9 - Quit. Commands -------- /to <user> - Set target for private chat. Example: "/to foobar" will set target to user "foobar". After this, pressing function key F8 will toggle between private mode and public. /ignore [user] - Toggle user to/from ignore. "/ignore" without specified username will list users currently on the ignore list. When ignore mode is ENABLED (via function key F4), no messages or actions from users on the list will be displayed. However, they will go into log file, if logging is active. /color <color> - Changes your current user color visible to OTHER people using the regular NN chat. Of course, this does not affect this client in any way, as user colors are ignored. /save - Save current configuration (username, password, etc.) Notice that this may be a risk, if your computer has several users as just starting the client will automatically log into the chat with your username and password! /who - Lists all users on the chat currently. Installation ------------ NNChat requires a curses library, preferably ncurses. It is also possible to compile NNChat for Windows via MinGW and use PDCurses instead, but this includes certain complexities in build process (see Makefile.w32) 1) Edit Makefile (optional) 2) make / gmake 3) ./nnchat --help