Mercurial > hg > nnchat
annotate README.txt @ 254:269135d58acd
Change default port to 8005 (new main room).
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Thu, 28 Apr 2011 16:30:58 +0300 |
parents | ec1ffa2043ec |
children | 00b0eb4ac656 |
rev | line source |
---|---|
5 | 1 NNChat - extremely simple NN chat applet compatible client |
2 ========================================================== | |
200 | 3 Written and designed by Anonymous Finnish Guy |
4 (C) Copyright 2008-2010 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 |
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. | |
7 | 29 |
30 Connect as registered user to members only chat: | |
66 | 31 > nnchat username password |
7 | 32 |
33 Connect as guest to free for all main chat: | |
66 | 34 > nnchat -p 8002 AnonymousAndy "" |
0 | 35 |
38 | 36 |
44 | 37 Keys |
38 ---- | |
157 | 39 arrow left/right - Move cursor in the current buffer. |
40 arrow up/down - Browse input history. | |
44 | 41 ctrl+left/right - Move cursor through words. |
42 | |
173 | 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. | |
52 | 46 |
200 | 47 tab(ulator) - Try to complete a username. For example "an<tab>" |
48 would check the userlist for usernames beginning with | |
49 "an" and replace this with the first match. Subsequent | |
50 tab-keypresses will "cycle" around other matches. | |
51 | |
44 | 52 F2 - Clear current edit buffer. |
171
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
53 F5 - Toggle ignore mode on/off. |
192 | 54 F7 - Clear current PRV target, if any. |
157 | 55 F8 - Toggle private chat mode on/off. |
44 | 56 F9 - Quit. |
57 | |
171
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
58 ctrl+L - Refresh/redraw screen. |
35b1714eb3b2
Change F1 functionality to proper Insert key.
Matti Hamalainen <ccr@tnsp.org>
parents:
166
diff
changeset
|
59 |
44 | 60 |
157 | 61 Commands |
62 -------- | |
63 /to <user> - Set target for private chat. Example: "/to foobar" | |
64 will set target to user "foobar". After this, pressing | |
65 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
|
66 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
|
67 on the input line. |
157 | 68 |
69 /ignore [user] - Toggle user to/from ignore. "/ignore" without specified | |
70 username will list users currently on the ignore list. | |
200 | 71 When ignore mode is ENABLED (via function key F5), |
157 | 72 no messages or actions from users on the list will be |
73 displayed. However, they will go into log file, if | |
74 logging is active. | |
75 | |
76 /color <color> - Changes your current user color visible to OTHER people | |
77 using the regular NN chat. Of course, this does not | |
78 affect this client in any way, as user colors are | |
79 ignored. | |
80 | |
81 /save - Save current configuration (username, password, etc.) | |
82 Notice that this may be a risk, if your computer | |
83 has several users as just starting the client will | |
84 automatically log into the chat with your username and | |
85 password! | |
86 | |
87 /who - Lists all users on the chat currently. | |
88 | |
89 | |
38 | 90 Installation |
91 ------------ | |
157 | 92 NNChat requires a curses library, preferably ncurses. It is |
93 also possible to compile NNChat for Windows via MinGW and use | |
94 PDCurses instead, but this includes certain complexities in | |
95 build process (see Makefile.w32) | |
38 | 96 |
97 1) Edit Makefile (optional) | |
98 | |
99 2) make / gmake | |
100 | |
101 3) ./nnchat --help |