📝 修改Readme.md

2024-11-16 03:55:30 +00:00 · 2022-10-16 01:27:43 +08:00 · 2022-10-16 01:27:43 +08:00 · e8c7d3321f
commit e8c7d3321f
parent 556d2846cf
1 changed files with 21 additions and 80 deletions
--- a/README.md
+++ b/README.md
@ -1,97 +1,38 @@
 <p align="center">
-  <a href="https://github.com/KimigaiiWuyi/GenshinUID/"><img src="https://s2.loli.net/2022/01/31/kwCIl3cF1Z2GxnR.png" width="256" height="256" alt="GenshinUID"></a>
-</p>
-<h1 align = "center">GenshinUID 3.1</h1>
-<h4 align = "center">✨基于<a href="https://github.com/Ice-Cirno/HoshinoBot" target="_blank">HoshinoBot</a>/<a href="https://github.com/nonebot/nonebot2" target="_blank">NoneBot2</a>/<a href="https://bot.q.qq.com/wiki/#" target="_blank">QQ官方频道Bot</a>的原神多功能插件✨</h4>
-<div align = "center">
-        <a href="https://github.com/KimigaiiWuyi/GenshinUID/wiki" target="_blank">安装文档</a> &nbsp; · &nbsp;
-        <a href="https://github.com/KimigaiiWuyi/GenshinUID/wiki/File5-%E3%80%8C%E6%8C%87%E4%BB%A4%E5%88%97%E8%A1%A8%E3%80%8D" target="_blank">指令列表</a> &nbsp; · &nbsp;
-        <a href="https://github.com/KimigaiiWuyi/GenshinUID/issues/226">常见问题</a>
-</div>
-<p align="center">
-  <a><img src="https://s2.loli.net/2022/09/09/ZR4LTdNhpUmJHil.jpg"></a>
+  <a href="https://github.com/KimigaiiWuyi/GenshinUID/"><img src="https://s2.loli.net/2022/01/31/kwCIl3cF1Z2GxnR.png" width="256" height="256" alt="Fastapi_Genshin_Map"></a>
 </p>
+<h1 align = "center">Fastapi_Genshin_Map</h1>
+<h4 align = "center">✨一个基于<a href="https://github.com/MingxuanGame/GenshinMap" target="_blank">GenshinMap</a>的地图API✨</h4>

+## 丨安装

-## 丨我该如何安装该插件？
+> *首次启动会等待一段时间, 属于正常现象*
+1. `git clone`本项目到喜欢的位置
+2. `cd` 至 `fastapi_genshin_map`
+3. `python main.py`

-+ 如果你使用的是[Go-cqhttp](https://github.com/Mrs4s/go-cqhttp) & [HoshinoBot](https://github.com/Ice-Cirno/HoshinoBot)，**安装方法查看[此处](https://github.com/KimigaiiWuyi/GenshinUID/wiki/File1%E3%80%8CHoshinoBot%E7%9A%84%E5%AE%89%E8%A3%85%E3%80%8D)**。
-+ 如果你使用的是[Go-cqhttp](https://github.com/Mrs4s/go-cqhttp) & [NoneBot2](https://github.com/nonebot/nonebot2)，**安装方法查看[此处](https://github.com/KimigaiiWuyi/GenshinUID/wiki/File2%E3%80%8CNonebot2%E7%9A%84%E5%AE%89%E8%A3%85%E3%80%8D)**。（**开发者正在使用**）
+## 丨使用

-+ 如果你想在QQ官方的频道Bot使用此插件，你需要**做好以下准备**：
-    - 拥有QQ频道机器人的开发者账号（类型：私域）
-    - 拥有已经备案好的服务器地址（视情况后期官方放开本地图片发送而定）
-    - **腾讯频道Bot官方的文档**，查看[此处](https://bot.q.qq.com/wiki/#)
-    - 安装方法：基于官方的[PythonSDK](https://github.com/tencent-connect/botpy)，本插件的安装方法可自行摸索。
-
-## 丨我该如何获取Cookies？[#92](https://github.com/KimigaiiWuyi/GenshinUID/issues/92)（[@RemKeeper](https://github.com/RemKeeper)）
-
-```js
-var cookie = document.cookie;
-var Str_Num = cookie.indexOf('_MHYUUID=');
-cookie = '添加 ' + cookie.substring(Str_Num);
-var ask = confirm('Cookie:' + cookie + '\n\n按确认，然后粘贴发送给机器人');
-if (ask == true) {
-  copy(cookie);
-  msg = cookie
-} else {
-  msg = 'Cancel'
-}
-```
-
-1. 复制上面全部代码，然后打开https://bbs.mihoyo.com/ys/
-2. 在页面上右键检查或者Ctrl+Shift+i
-3. 选择控制台（Console），粘贴，回车，在弹出的窗口点确认（点完自动复制）
-4. 然后在和机器人的私聊窗口，粘贴发送即可
-
-**警告：Cookies属于个人隐私，其效用相当于账号密码，请勿随意公开！**
-
-## 丨获取米游社Stoken([AutoMihoyoBBS](https://github.com/Womsxd/AutoMihoyoBBS#%E8%8E%B7%E5%8F%96%E7%B1%B3%E6%B8%B8%E7%A4%BECookie))
-
-```js
-var cookie = document.cookie;
-var ask = confirm('Cookie:' + cookie + '\n\nDo you want to copy the cookie to the clipboard?');
-if (ask == true) {
-  copy("添加 stoken" + cookie);
-  msg = cookie
-} else {
-  msg = 'Cancel'
-}
-```
-
-1. 复制上面全部代码，然后打开http://user.mihoyo.com/
-2. 在页面上右键检查或者Ctrl+Shift+i
-3. 选择控制台（Console），粘贴，回车，在弹出的窗口点确认（点完自动复制）
-4. 然后在和机器人的私聊窗口，粘贴发送即可
-
-**警告：Cookies属于个人隐私，其效用相当于账号密码，请勿随意公开！**
+### 获取资源点地图(全)
+终结点：`/map/get_map`
+|  字段   | 类型  | 说明  |
+|  ----  | ----  | ----  |
+| resource_name  | str | 资源名称 |
+| map_id  | str/int | 地图ID |

 ## 丨感谢

- [PaimonBot](https://github.com/XiaoMiku01/PaimonBot) - 插件原始代码来自于它
- [YuanShen_User_Info](https://github.com/Womsxd/YuanShen_User_Info) - 米游社API来自于它
- *[MiniGG](https://www.minigg.cn/)* - Wiki API来自于它/插件初始化下载站来自于它
- [@MingxuanGame](https://github.com/MingxuanGame)
-  - [Nonebot2-beta1](https://github.com/KimigaiiWuyi/GenshinUID/tree/nonebot2-beta1)分支新建与维护
- [@shirokurakana](https://github.com/shirokurakana)
-  - [Nonebot2-beta1分支的修复与优化](https://github.com/KimigaiiWuyi/GenshinUID/pull/118)
- [@猫冬](https://bbs.mihoyo.com/ys/accountCenter/postList?id=74019947) - 原神攻略的**授权**使用
- [@blue菌hehe](https://bbs.mihoyo.com/ys/accountCenter/postList?id=160367110) - 参考面板的**授权**使用
- [@音尘绝LiuSXwww](https://bbs.mihoyo.com/ys/accountCenter/postList?id=271681956) - 怪物数据表的**授权**使用
- [@lgc233](https://github.com/lgc2333) - 众多优秀PR贡献
- [@CMHopeSunshine](https://github.com/CMHopeSunshine) - 随机图API提供
- [@Enka.Network](https://enka.shinshin.moe/) - 展柜面板的数据来源
- [@Ice-Cirno](https://github.com/Ice-Cirno) - Hoshino分支的修复与完善
- [@AMEKENN](https://github.com/AMEKENN) - 米游社签到部分的代码指导
- [@RemKeeper](https://github.com/RemKeeper) - 简易Cookies获取文档
- [@珊瑚宫千花](https://space.bilibili.com/398528056) - 角色别名Json提供
- [@wudifeixue](https://github.com/wudifeixue) - PR贡献 & Bug报告
- [@ZhouYingSASA](https://github.com/ZhouYingSASA) - PR贡献 & Bug报告
+- [GenshinMap](https://github.com/MingxuanGame/GenshinMap) - 没有这个项目就不会有这个作品
+
+## 丨许可证
+
+该项目以`GPL-3.0 license`开源, 这意味着使用该项目的项目也将以`GPL-V3`开源

 ## 丨其他

 + 如果对本插件有功能建议&Bug报告，欢迎提Issue & Pr，每一条都会详细看过
 + 如果本插件对你有帮助，不要忘了点个Star~
 + 本项目仅供学习使用，请勿用于商业用途
+ Bot项目: [GenshinUID](https://github.com/KimigaiiWuyi/GenshinUID)
 + [爱发电](https://afdian.net/@KimigaiiWuyi)
 + [GPL-3.0 License](https://github.com/KimigaiiWuyi/GenshinUID/blob/main/LICENSE) ©[@KimigaiiWuyi](https://github.com/KimigaiiWuyi)