Mercurial > hg > nnchat
annotate README.txt @ 349:8662c07455be
Added tag dev-0_9_6 for changeset f3572f4f73d1
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Thu, 23 Jun 2011 01:37:43 +0300 |
| parents | e97c764927ce |
| children |
| rev | line source |
|---|---|
| 5 | 1 NNChat - extremely simple NN chat applet compatible client |
| 2 ========================================================== | |
| 200 | 3 Written and designed by Anonymous Finnish Guy |
| 260 | 4 (C) Copyright 2008-2011 Anonymous Finnish Guy |
| 7 | 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 ------------- | |
| 44 | 13 A simple NCurses-based client compatible with NewbieNudes.com chatroom |
| 60 | 14 protocol. There is a basic line-editing interface with some bells and |
| 157 | 15 whistles, such as a input history, logging to file, ignore lists, |
| 16 persistent configuration, etc. | |
| 7 | 17 |
|
166
8bb12c22fe05
Add note and link to the original Flash-based chat.
Matti Hamalainen <ccr@tnsp.org>
parents:
157
diff
changeset
|
18 The original Flash-based chat client can be accessed through NN website: |
|
8bb12c22fe05
Add note and link to the original Flash-based chat.
Matti Hamalainen <ccr@tnsp.org>
parents:
157
diff
changeset
|
19 |
|
8bb12c22fe05
Add note and link to the original Flash-based chat.
Matti Hamalainen <ccr@tnsp.org>
parents:
157
diff
changeset
|
20 http://www.newbienudes.com/chat/ |
|
8bb12c22fe05
Add note and link to the original Flash-based chat.
Matti Hamalainen <ccr@tnsp.org>
parents:
157
diff
changeset
|
21 |
| 7 | 22 |
| 23 Usage | |
| 24 ----- | |
| 157 | 25 See the help, 'nnchat --help' for available command line options. By |
|
255
00b0eb4ac656
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
200
diff
changeset
|
26 default the client connects to main room (TCP port 8005). By using |
|
00b0eb4ac656
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
200
diff
changeset
|
27 other ports (option -p) you can connect to "passion pit" (8003). |
| 7 | 28 |
| 29 Connect as registered user to members only chat: | |
| 66 | 30 > nnchat username password |
| 7 | 31 |
| 32 Connect as guest to free for all main chat: | |
|
255
00b0eb4ac656
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
200
diff
changeset
|
33 > nnchat -p 8003 AnonymousAndy "" |
|
00b0eb4ac656
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
200
diff
changeset
|
34 |
|
00b0eb4ac656
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
200
diff
changeset
|
35 You can also leave out the username and password from the commandline, |
|
00b0eb4ac656
Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
200
diff
changeset
|
36 NNChat will prompt for those if necessary. |
| 0 | 37 |
| 38 | 38 |
| 44 | 39 Keys |
| 40 ---- | |
| 157 | 41 arrow left/right - Move cursor in the current buffer. |
| 42 arrow up/down - Browse input history. | |
| 44 | 43 ctrl+left/right - Move cursor through words. |
| 44 | |
| 173 | 45 ins - Toggle between insert and overwrite modes. |
| 46 del - Delete one character at cursor position. | |
| 47 backspace - Delete one character left to the cursor position. | |
| 52 | 48 |
| 200 | 49 tab(ulator) - Try to complete a username. For example "an<tab>" |
| 50 would check the userlist for usernames beginning with | |
| 51 "an" and replace this with the first match. Subsequent | |
| 52 tab-keypresses will "cycle" around other matches. | |
| 53 | |
| 44 | 54 F2 - Clear current edit buffer. |
|
171
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
55 F5 - Toggle ignore mode on/off. |
| 192 | 56 F7 - Clear current PRV target, if any. |
| 157 | 57 F8 - Toggle private chat mode on/off. |
| 44 | 58 F9 - Quit. |
| 59 | |
|
171
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
60 ctrl+L - Refresh/redraw screen. |
|
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
61 |
| 44 | 62 |
| 157 | 63 Commands |
| 64 -------- | |
| 65 /to <user> - Set target for private chat. Example: "/to foobar" | |
| 66 will set target to user "foobar". After this, pressing | |
| 67 function key F8 will toggle between private mode and | |
|
171
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
68 public. Private chat mode is indicated by "username>" |
|
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
69 on the input line. |
| 157 | 70 |
| 71 /ignore [user] - Toggle user to/from ignore. "/ignore" without specified | |
| 72 username will list users currently on the ignore list. | |
| 200 | 73 When ignore mode is ENABLED (via function key F5), |
| 157 | 74 no messages or actions from users on the list will be |
| 75 displayed. However, they will go into log file, if | |
| 76 logging is active. | |
| 77 | |
| 78 /color <color> - Changes your current user color visible to OTHER people | |
| 79 using the regular NN chat. Of course, this does not | |
| 80 affect this client in any way, as user colors are | |
| 81 ignored. | |
| 82 | |
| 83 /save - Save current configuration (username, password, etc.) | |
| 84 Notice that this may be a risk, if your computer | |
| 85 has several users as just starting the client will | |
| 86 automatically log into the chat with your username and | |
| 87 password! | |
| 88 | |
| 89 /who - Lists all users on the chat currently. | |
| 90 | |
| 91 | |
| 38 | 92 Installation |
| 93 ------------ | |
| 157 | 94 NNChat requires a curses library, preferably ncurses. It is |
| 95 also possible to compile NNChat for Windows via MinGW and use | |
| 96 PDCurses instead, but this includes certain complexities in | |
| 97 build process (see Makefile.w32) | |
| 38 | 98 |
| 99 1) Edit Makefile (optional) | |
| 100 | |
| 101 2) make / gmake | |
| 102 | |
| 103 3) ./nnchat --help |