From 555b7a42edc0ee0eef4da8c441d3c426cf3d5e56 Mon Sep 17 00:00:00 2001
From: CDN18 <cardinal@codeword.info>
Date: Fri, 14 Apr 2023 15:49:03 +0800
Subject: [PATCH] docs: create README

---
 README.md | 190 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 190 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef2c918
--- /dev/null
+++ b/README.md
@@ -0,0 +1,190 @@
+# Owu Bot 说明书
+- **[一、常用功能](#一常用功能)**
+  - **[1. ChatGPT](#1-chatgpt)**
+- **[二、群内娱乐](#二群内娱乐)**
+  - **[1. 今日动漫列表](#1-今日动漫列表)**
+  - **[2. 今日人品](#2-今日人品)**
+  - **[3. 发病文学](#3-发病文学)**
+  - **[4. 狗屁不通生成器](#4-狗屁不通生成器)**
+  - **[5. 抽象话生成](#5-抽象话生成)**
+  - **[6. 人生重开模拟器](#6-人生重开模拟器)**
+  - **[7. Meme绘制](#7-meme绘制)**
+- **[三、实用工具](#三实用工具)**
+  - **[1. Tex](#1-tex)**
+  - **[2. 翻译](#2-翻译)**
+  - **[3. Ins视频下载](#3-ins视频下载)**
+  - **[4. YouTube视频预览](#4-youtube视频预览)**
+  - **[5. Bilibili视频预览](#5-bilibili视频预览)**
+  - **[6. 热榜](#6-热榜)**
+  - **[7. Wolfram Alpha计算](#7-wolfram-alpha计算)**
+  - **[8. TTS语音合成](#8-tts语音合成)**
+- **[四、游戏相关](#四游戏相关)**
+  - **[1. Apex](#1-apex)**
+  - **[2. Steam挂刀行情](#2-steam挂刀行情)**
+  - **[3. Steam状态](#3-steam状态)**
+  - **[4. Steam游戏查询](#4-steam游戏查询)**
+
+## 一、常用功能
+
+### 1. ChatGPT
+
+- Owu Bot接入了OpenAI的`GPT-3.5-Turbo`模型。
+- 私聊状态下，直接发送消息便可与ChatGPT对话（推荐）
+- 群聊状态下，需要“@”bot并发送消息来与ChatGPT对话。
+
+## 二、群内娱乐
+
+### 1. 今日动漫列表
+
+- 用法：发送`/今日动漫`
+
+### 2. 今日人品
+
+- 用法：发送`/jrrp`
+
+### 3. 发病文学
+
+- 用法：`/发病 <发病对象>`
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/643902509983f.png)
+
+### 4. 狗屁不通生成器
+
+- 用法：`/nonsense <文章主题>`
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/643902509a117.png)
+
+### 5. 抽象话生成
+
+- 用法：`/abstract <原来的话>`
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/643902509c61e.png)
+
+### 6. 人生重开模拟器
+
+- 用法：`@bot /remake`
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/64390250f3038.png)
+
+### 7. Meme绘制
+
+- 用法：
+  - P站风格图片：`#ph <文字>`
+  - 灰白照：`#bw <文字> <图片>`或先发送`#bw <文字>`，然后再发送图片。
+  - 5000兆：`#5000兆 <文字>`或`#5000兆 <上半部分文字> <下半部分文字>`
+  - Emoji合成：发送任意两个emoji（不支持的emoji不会发送）
+  - %0合成：发送`#0`，再发送图片
+  - osu生成：发送`#osu <文字>`
+  - marble大理石滤镜：`#marble <图片>`。或先发送`#marble`，然后再发送图片。
+  - 假闪照：`#flash <图片>`。或先发送`#flash`，然后再发送图片。
+  - 图像腐蚀：`erode <图片>`。或先发送`#erode`，然后再发送图片。
+
+## 三、实用工具
+
+### 1. Tex
+
+- 用法：`/tex <你要发送的Tex源码>`
+- 示例：
+
+![](https://osraw-img.owu.one/2023/04/14/6439024fad0e7.png)
+
+### 2. 翻译
+
+- 目前接入了百度翻译
+
+- 用法：`/translate <-s 源语言（可选）> <-t 目标语言（可选）> <你要翻译的文字>`
+
+- 常用语言代码：中文为`zh`、英文为`en`
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/6439024fad5c6.png)
+
+  ![](https://osraw-img.owu.one/2023/04/14/6439024faf21e.png)
+
+### 3. Ins视频下载
+
+- 在群聊中直接发送带视频的Ins动态链接即可。
+- 此功能经常出错，如果Bot没有回复请考虑更换其它方法
+
+### 4. YouTube视频预览
+
+- 在群聊中直接发送YouTube视频链接即可。
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/6439025103eec.png)
+
+### 5. Bilibili视频预览
+
+- 在群聊中直接发送Bilibili视频链接即可
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/6439025146998.png)
+
+### 6. 热榜
+
+- 用法：
+
+  - B站热榜：发送`/blibli-list`
+  - 【暂不可用】微博热榜：发送`/weibo-hot`
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/643902514118b.png)
+
+### 7. Wolfram Alpha计算
+
+- 用法：`/alpha <计算指令或表达式>`
+
+- 计算指令仅支持英文。
+
+- 示例：
+
+  ![](https://osraw-img.owu.one/2023/04/14/643902500ebe7.png)
+
+### 8. TTS语音合成
+
+- 用法：`/tts <要说的话>`
+- 高级用法示例：
+  - 河南方言：`/tts -l zh-CN-henan -v zh-CN-henan-YundengNeural 河南人，都是神，创造不败的传闻`
+  - 东北方言：`/tts -l zh-CN-liaoning -v zh-CN-liaoning-XiaobeiNeural -r 1.15 你来！到沈阳大街指定没你好果子吃！`
+  - 陕西方言：`/tts -l zh-CN-shaanxi -v zh-CN-shaanxi-XiaoniNeural 他大舅他二舅都是他舅，高桌子低板凳都是木头。`
+  - 山东方言：`/tts -l zh-CN-shandong -v zh-CN-shandong-YunxiangNeural 看见没，还是咱沙东人素质高`
+  - 四川方言：`/tts -l zh-CN-sichuan -v zh-CN-sichuan-YunxiNeural 我日你个仙人板板`
+  - 东南地区口音（福建、台湾）：`/tts -l zh-TW -v zh-TW-HsiaoChenNeural 我发现你这个人真的好机车哟`
+  - 粤语：`/tts -l zh-HK -v zh-HK-WanLungNeural 万里长城永不倒，千里黄河水滔滔。江山秀丽，叠彩峰岭，问我国家哪像染病`
+- 高级用法示例中，`-l`参数后跟语言，`-v`参数后跟声音模型，`-r`参数后跟说话速度倍数。所有的可能取值详见[此处](https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=tts)
+
+## 四、游戏相关
+
+### 1. Apex
+
+- 查询当前Apex地图轮换：`/apexmap`
+- 查询当前Apex合成器内容：`/apexcraft`
+- 查询一名玩家的Apex战绩：`/apex <用户ID>`
+
+### 2. Steam挂刀行情
+
+- 挂刀行情：`/trad buff ['buff', 'igxe', 'c5', 'uupy'] `
+- 行情分析：`/行情分析`
+
+### 3. Steam状态
+
+- 监听用户在线状态
+- 创建监听：`/steam.watch <用户ID或个人页面地址>`
+- 查看本群已有监听：`/steam.list`
+- 删除监听：`/steam.delete <监听序号>`
+
+### 4. Steam游戏查询
+
+- 用法：`/查询 <游戏名>`