Merge remote-tracking branch 'vayn/master'
[gaetalk.git] / README.mkd
blob8bdf216373688d3a0e0575a74718a7ea9561dd9b
1 介绍
2 ====
3 **gaetalk** 是一个基于[Google App Engine][GAE]的群聊应用,旨在建立一个自由友好的聊天交流平台。目前版本为 **0.3**,正在积极开发中,[最新开发版][github]在 lilydjwg@appspot.com 运行。
5 特性列表
6 ========
7 * 添加好友即加入,删除即退出
8 * 消息历史记录
9   * 显示离线时的消息
10 * 消息收发
11   * 暂停接收信息
12   * 管理员禁言
13   * 刷屏者自动禁言
14   * 可使用时间单位(s, m, h, d)
15 * 私信
16 * 成员可以设置
17   * 命令前缀
18   * 消息的昵称显示格式
19   * 是否接受私信
20 * help 区分长短两种帮助类型
21 * mail 命令,发送通知邮件 (TODO)
22 * 评分机制 (TODO)
23 * 自动屏蔽离开自动回复的消息(待完善)
25 功能列表
26 ========
28 主帮助
29 ------
30 (`help long` 命令的结果)
32 * admin:        将某人添加为管理员
33 * block:        封禁某个 ID,参数为用户昵称或者 ID(如果不是已经加入的 ID 的话),以及封禁原因
34 * chatty:       消息数排行
35 * fakeresource: 假装在线,人工加入一个新的资源,使程序认为你总是在线。使用 offline 命令可删除所有资源的记录。
36 * groupstatus:  设置群状态
37 * help: 显示本帮助。参数 long 显示详细帮助,也可指定命令名。
38 * iam:  查看自己的信息
39 * intro:        设置自我介绍信息
40 * kick: 删除某人。他仍可以重新加入。
41 * lsadmin:      管理员列表
42 * lsblocked:    列出被封禁用户名单
43 * m:    发私信,需要昵称和内容两个参数。私信不会以任何方式被记录。用户可使用 set 命令设置是否接收私信。
44 * nick: 更改昵称,需要一个参数,不能使用大部分标点符号,最长 16 字节
45 * notice:       发送群通告。只会发给在线的人,包括 snoozing 者。
46 * offline:      假装离线,让程序认为你的所有资源已离线。如在你离线时程序仍认为你在线,请使用此命令。
47 * old:  聊天记录查询,可选一个数字参数。默认为最后20条。特殊参数 OFFLINE (不区分大小写)显示离线消息(最多 100 条)
48 * online:       在线成员列表。可带一个参数,指定在名字中出现的一个子串。
49 * quiet:        禁言某人,参数为昵称和时间(默认单位秒)
50 * quit: 删除用户数据。某些自称“不作恶”的公司的客户端会不按协议要求发送删除好友的消息,请 gtalk 官方客户端用户使用此命令退出。参见 http://xmpp.org/rfcs/rfc3921.html#rfc.section.6.3 。
51 * set:  设置参数。参数格式 key=value;不带参数以查看说明。
52 * snooze:       暂停接收消息,参数为时间(默认单位为秒)。再次发送消息时自动清除
53 * topic:        查看或设置群主题
54 * topic:        查看群主题
55 * unadmin:      取消某人管理员的权限
56 * unblock:      解封某个 ID
57 * whois:        查看用户信息,参数为用户昵称
59 设置选项
60 --------
61 * allowpm:      设置是否接收私信,参数为 y(接收)或者 n(拒绝)
62 * nickpattern:  设置昵称显示格式,用 %s 表示昵称的位置
63 * prefix:       设置命令前缀
65 安装与配置
66 ==========
67 1. 修改`app.yaml`文件的第一行,可选地修改下版本名称`version`;
68 2. 修改`config.py`文件。**注意**要严格遵循 Python 的语法;
69 3. 上传应用到 GAE,添加`appid@appspot.com`为好友即可。
71 [GAE]:http://code.google.com/appengine/
72 [github]:https://github.com/lilydjwg/gaetalk