docs(README): update README

docs(README): update README docs(README): update README for val.outpost54.top docs(README): update README docs(README): update README_EN docs(README): update README docs(README): add aifadian png
musnows · Jan 10, 2023 · dba7ab0 · dba7ab0
1 parent 2be993a
commit dba7ab0
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@
 ![python](https://img.shields.io/badge/Python-3.8%2B-green) ![commit](https://img.shields.io/github/last-commit/Aewait/Valorant-kaiheila-bot) ![release](https://img.shields.io/github/v/release/Aewait/Valorant-kaiheila-bot)
 [![khl server](https://www.kaiheila.cn/api/v3/badge/guild?guild_id=3566823018281801&style=3)](https://kaihei.co/oqz7Xg) ![githubstars](https://img.shields.io/github/stars/Aewait/Valorant-kaiheila-bot?style=social)
 
-<img src="https://api.outpost54.club/log_bot_img" height="55px" alt="机器人加入服务器及调用数量">
+<img src="./screenshot/log.png" height="55px" alt="Bot Log Image">
 </div>
 
 ## 功能
@@ -58,15 +58,13 @@
 
 更多vip用户的特殊功能
 
->「全新商店返回值」vip用户将获取到16-9的超帅商店返回值
+>* 「全新商店返回值」vip用户将获取到16-9的超帅商店返回值
+>* 「保存登录信息」vip用户登陆后，阿狸会自动保存您的cookie。在阿狸维护重启的时候，您的登录信息不会丢失
+>* 「早八商店提醒」阿狸将在早8点获取vip用户的每日商店并私聊发图给用户，同时会对这张图片进行缓存，当天使用/shop命令的时候，只需2s获取结果，三倍于普通用户的响应速度！
 >
->「保存登录信息」vip用户登陆后，阿狸会自动保存您的cookie。在阿狸维护重启的时候，您的登录信息不会丢失
+>目前商店查询背景图diy支持16-9(横屏)的图片，图片url获取：`PC端将图片上传到kook→点击图片→底部...处复制图片链接→使用/vip-shop命令设置背景` [教程图](https://img.kookapp.cn/assets/2022-12/nICYcewY8a0u00yt.png) 
 >
->「早八商店提醒」阿狸将在早8点获取vip用户的每日商店并私聊发图给用户，同时会对这张图片进行缓存，当天使用/shop命令的时候，只需2s获取结果，三倍于普通用户的响应速度！
->
->1.目前商店查询背景图diy支持16-9(横屏)的图片，图片url获取：`PC端将图片上传到kook→点击图片→底部...处复制图片链接→使用/vip-shop命令设置背景` [教程图](https://s1.ax1x.com/2022/09/12/vXD1Nq.jpg)
->
->2.请不要设置违规图片(擦边也不行)！若因为您上传违禁图片后导致阿狸被封，您将被剥夺vip并永久禁止兑换vip
+>请不要设置违规图片(擦边也不行)！若因为您上传违禁图片后导致阿狸被封，您将被剥夺vip并永久禁止兑换vip
 
 每日商店刷枪提醒功能需要用户**保持登录状态**，bot会在每天的`08:01`遍历列表，查看您的商店是否刷出了您想要的皮肤
 
@@ -85,7 +83,7 @@
 
 你可以在[screenshot](./screenshot)文件夹中找到对应的截图示例
 
-<img src="./screenshot/daily_shop.png" height="400px"> <img src="./screenshot/uinfo.png" weight="300px" height="200px">
+<img src="./screenshot/daily_shop.png" height="400px" alt="shop_img"> <img src="./screenshot/uinfo.png" weight="300px" height="200px" alt="vp_rp">
 
 <details>
 <summary>更多截图</summary>
@@ -101,22 +99,24 @@
 <img src="./screenshot/vip_daily_shop.png" height="300px" alt="vip_shop">
 </details>
 
-### valorant-api
+### valorant-shop-img-api
 
 > api源码见 [code_api](./code_api/)
 
 这个api是利用python写的小代码，主要还是复用了阿狸主代码中给商店画图的部分，支持自定义背景图
 
 ```
-https://api.outpost54.club/shop-img?token=密钥&account=账户&passwd=密码&img_src=自定义背景图的url
+https://val.outpost54.top/shop-img?token=密钥&account=账户&passwd=密码&img_src=自定义背景图的url
 
-因为该功能没啥人用，在这里提供一个测试密钥
+提供一个测试密钥
 da4ec652-4a25-11ed-bff2-525400c9274f
 ```
 api后台不会记录您的账户信息，如果请求`/shop-img`接口，图片将直接跳转到kook的图床；如果请求`/shop-url`接口，图片将以json（内含url）的方式返回
 
 > 咳咳，白嫖了kook的图床
 
+以下为请求 `/shop-url` 接口的返回格式示例，只有返回code为0才为正确返回；由于该接口的特殊性，暂不支持2fa用户
+
 ```json
 {
     "code": 0, 
@@ -125,7 +125,7 @@ api后台不会记录您的账户信息，如果请求`/shop-img`接口，图片
 }
 ```
 
-<img src="./screenshot/val_api_img.png" height="300px" alt="vip_shop">
+<img src="./screenshot/val_api_img.png" height="300px" alt="api_shop_img">
 
 ----
 
@@ -157,6 +157,8 @@ pip install -r requirements.txt
 - [x] 实现玩家商店刷枪的查询
 - [x] 实现当商店刷新某一把枪的时候提醒玩家
 - [x] 查看玩家的夜市
+- [x] 邮箱验证2fa登录
+- [ ] 通行证、每日任务的查询
 - [ ] 以类似抽卡的方式，用按钮、图片等等方式显示用户的夜市
 
 ~~由于很多人在使用类似商店查询软件后被ban，我决定正式停止相关功能的开发~~
@@ -165,7 +167,7 @@ pip install -r requirements.txt
 
 **如果您担心风险，请不要使用相关功能**！bot的`/vhelp`命令`/login`命令中有相关警告提示，使用即代表您同意了承担风险！
 
-<img src="./screenshot/issue_banned.png" width="580px" height="250px"/>
+<img src="./screenshot/issue_banned.png" height="250px" alt="issue screenshots">
 
 ----
 
@@ -184,3 +186,10 @@ pip install -r requirements.txt
 * [@staciax](https://github.com/staciax) for [Valorant-DiscordBot/issues/74](https://github.com/staciax/Valorant-DiscordBot/issues/74)
 
 
+### 支持本项目😘
+
+阿狸的支出主要为云服务器的费用，您的支持是对作者的最大鼓励！
+
+<a href="https://afdian.net/a/128ahri">
+    <img src="https://pic1.afdiancdn.com/static/img/welcome/button-sponsorme.jpg" alt="aifadian">
+</a >
diff --git a/README_EN.md b/README_EN.md
@@ -12,7 +12,7 @@ English | [简体中文](./README.md)
 ![python](https://img.shields.io/badge/Python-3.8%2B-green) ![commit](https://img.shields.io/github/last-commit/Aewait/Valorant-kaiheila-bot) ![release](https://img.shields.io/github/v/release/Aewait/Valorant-kaiheila-bot)
 [![khl server](https://www.kaiheila.cn/api/v3/badge/guild?guild_id=3566823018281801&style=3)](https://kaihei.co/oqz7Xg) ![githubstars](https://img.shields.io/github/stars/Aewait/Valorant-kaiheila-bot?style=social)
 
-<img src="https://api.outpost54.club/log_bot_img" height="55px" alt="Bot Log Image">
+<img src="./screenshot/log.png" height="55px" alt="Bot Log Image">
 </div>
 
 KOOK(once called kaiheila) is a Chinese voice communication software.
@@ -59,9 +59,11 @@ Recommended to use after the Valorant_Function is stable.
 |`/rts NO. point comment`|select skin_no. to rate a point(0~100) and leave a comment to it|
 |`/kkn`|checkout yesterday's heighest/lowest rate_point of daily shop |
 
-notify function require user to stay `login`, bot wil fetch your daily shop at `08:02 am GMT+8` .If the skin is in daily shop,bot will send a private message to user.
+notify function require user to stay `login`, bot wil fetch your daily shop at `08:01AM GMT+8` .If the skin is in daily shop, bot will send a private message to user.
 
-Because the bot is using in Chinese platform, the skin `name` only support `zh-TW`
+If the user is a vip, the bot will also send the full picture of the store on that day through private message.
+
+>Because the bot is only using in Chinese platform, the skin `name` only support `zh-TW`
 
 | Other        | Function                                                     |
 | --------------- | ------------------------------------------------------------ |
@@ -78,14 +80,14 @@ Because the bot is using in Chinese platform, the skin `name` only support `zh-T
 
 You can find image examples for the functions in [screenshot](./screenshot) floder.
 
-<img src="./screenshot/daily_shop.png" height="400px"> <img src="./screenshot/uinfo.png" weight="300px" height="200px">
+<img src="./screenshot/daily_shop.png" height="400px" alt="shop_img"> <img src="./screenshot/uinfo.png" weight="300px" height="200px" alt="vp_rp">
 
 <details>
 <summary>more screenshots</summary>
 
 <img src="./screenshot/bundle.png" alt="bundle">
 
-<img src="./screenshot/weather.png" alt="we">
+<img src="./screenshot/weather.png" alt="weather">
 
 <img src="./screenshot/lead.png" alt="leaderborad">
 
@@ -129,14 +131,14 @@ this background can be modified by vip-user,using picture they liked!
 
 ## About
 
-Since I have not studied python, many codes in this repo are modified and used according to others' tutorials
+Many codes in this repo are modified and used according to others' tutorials
 * KOOK_api base on [khl.py](https://github.com/TWT233/khl.py)
 * ValorantGameApi base on [frissyn/valorant.py](https://github.com/frissyn/valorant.py/)
 * Main fetch_code base on [ValorantClientAPI](https://github.com/HeyM1ke/ValorantClientAPI)
 * Fetch riot_auth_token base on [floxay/python-riot-auth](https://github.com/floxay/python-riot-auth)
 
 
-### Thanks🎁
+### Special Thanks🎁
 * [@DeeChael](https://github.com/DeeChael) for helping me debug
 * [@Edint386](https://github.com/Edint386) for adding PIL_code for `/shop` 
 * [@staciax](https://github.com/staciax) for [Valorant-DiscordBot/issues/74](https://github.com/staciax/Valorant-DiscordBot/issues/74)