Mercurial > hg > nnchat
comparison README.txt @ 178:da4dbe82a4ed
Renamed README to README.txt.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Mon, 15 Nov 2010 08:30:40 +0200 |
| parents | README@317df807da54 |
| children | a2e9bbd8ca18 |
comparison
equal
deleted
inserted
replaced
| 177:fdc771411795 | 178:da4dbe82a4ed |
|---|---|
| 1 NNChat - extremely simple NN chat applet compatible client | |
| 2 ========================================================== | |
| 3 Written and designed by Matti 'ccr' Hämäläinen | |
| 4 (C) Copyright 2008-2010 TNSP | |
| 5 | |
| 6 | |
| 7 Distributed under DWETFYWTPL (Do What Ever The Fuck You Want | |
| 8 To Public License), see file COPYING for more information. | |
| 9 | |
| 10 | |
| 11 What is this? | |
| 12 ------------- | |
| 13 A simple NCurses-based client compatible with NewbieNudes.com chatroom | |
| 14 protocol. There is a basic line-editing interface with some bells and | |
| 15 whistles, such as a input history, logging to file, ignore lists, | |
| 16 persistent configuration, etc. | |
| 17 | |
| 18 The original Flash-based chat client can be accessed through NN website: | |
| 19 | |
| 20 http://www.newbienudes.com/chat/ | |
| 21 | |
| 22 | |
| 23 Usage | |
| 24 ----- | |
| 25 See the help, 'nnchat --help' for available command line options. By | |
| 26 default the client connects to passion pit (TCP port 8003). By using | |
| 27 other ports (option -p) you can connect to "members only" (8003) and | |
| 28 free for all "main room" (8002) chats. | |
| 29 | |
| 30 Connect as registered user to members only chat: | |
| 31 > nnchat username password | |
| 32 | |
| 33 Connect as guest to free for all main chat: | |
| 34 > nnchat -p 8002 AnonymousAndy "" | |
| 35 | |
| 36 | |
| 37 Keys | |
| 38 ---- | |
| 39 arrow left/right - Move cursor in the current buffer. | |
| 40 arrow up/down - Browse input history. | |
| 41 ctrl+left/right - Move cursor through words. | |
| 42 | |
| 43 ins - Toggle between insert and overwrite modes. | |
| 44 del - Delete one character at cursor position. | |
| 45 backspace - Delete one character left to the cursor position. | |
| 46 | |
| 47 F2 - Clear current edit buffer. | |
| 48 F5 - Toggle ignore mode on/off. | |
| 49 F8 - Toggle private chat mode on/off. | |
| 50 F9 - Quit. | |
| 51 | |
| 52 ctrl+L - Refresh/redraw screen. | |
| 53 | |
| 54 | |
| 55 Commands | |
| 56 -------- | |
| 57 /to <user> - Set target for private chat. Example: "/to foobar" | |
| 58 will set target to user "foobar". After this, pressing | |
| 59 function key F8 will toggle between private mode and | |
| 60 public. Private chat mode is indicated by "username>" | |
| 61 on the input line. | |
| 62 | |
| 63 /ignore [user] - Toggle user to/from ignore. "/ignore" without specified | |
| 64 username will list users currently on the ignore list. | |
| 65 When ignore mode is ENABLED (via function key F4), | |
| 66 no messages or actions from users on the list will be | |
| 67 displayed. However, they will go into log file, if | |
| 68 logging is active. | |
| 69 | |
| 70 /color <color> - Changes your current user color visible to OTHER people | |
| 71 using the regular NN chat. Of course, this does not | |
| 72 affect this client in any way, as user colors are | |
| 73 ignored. | |
| 74 | |
| 75 /save - Save current configuration (username, password, etc.) | |
| 76 Notice that this may be a risk, if your computer | |
| 77 has several users as just starting the client will | |
| 78 automatically log into the chat with your username and | |
| 79 password! | |
| 80 | |
| 81 /who - Lists all users on the chat currently. | |
| 82 | |
| 83 | |
| 84 Installation | |
| 85 ------------ | |
| 86 NNChat requires a curses library, preferably ncurses. It is | |
| 87 also possible to compile NNChat for Windows via MinGW and use | |
| 88 PDCurses instead, but this includes certain complexities in | |
| 89 build process (see Makefile.w32) | |
| 90 | |
| 91 1) Edit Makefile (optional) | |
| 92 | |
| 93 2) make / gmake | |
| 94 | |
| 95 3) ./nnchat --help |