fastapi_genshin_map/README.md

<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="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`

## 丨使用

### 获取资源点地图(全)
终结点：`/map/get_map`
|  字段   | 类型  | 说明  |
|  ----  | ----  | ----  |
| resource_name  | str | 资源名称 |
| map_id  | str/int | 地图ID |
| is_cluster | bool | 是否使用聚类算法 |

## 丨感谢

- [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)

## 丨返回图示例
![测试.jpg](https://s2.loli.net/2022/10/17/D2cI5tQdgVk3Uuz.jpg)