Skip to content

💖一套业务逻辑,多个平台支持!异步核心框架GsCore,为插件编写提供完善平台支持、核心数据库统一、复用游戏查询逻辑、网页控制台,支持Bot列表: NoneBot2 & HoshinoBot & ZeroBot & YunZaiBot & Koishi

License

Notifications You must be signed in to change notification settings

Genshin-bots/gsuid_core

Repository files navigation

⚙️GenshinUID Core 0.5.1

Code style: black Imports: isort Lint: flake8 pre-commit.ci status

KimigaiiWuyi/GenshinUID 的核心部分,平台无关,支持 HTTP/WS 形式调用,便于移植到其他平台以及框架。

本Readme的部分内容可能已经失效,请前往最新的详细文档查阅:

🎉详细文档

👉插件编写指南

安装Core

  1. git clone gsuid-core本体
git clone https://github.com/Genshin-bots/gsuid_core.git --depth=1 --single-branch
  1. 安装poetry
pip install poetry
  1. 安装所需依赖
# cd进入clone好的文件夹内
cd gsuid_core
# 安装依赖
poetry install
  1. 安装所需插件(可选)
# cd进入插件文件夹内
cd plugins
# 安装v4 GenshinUID
git clone -b v4 https://github.com/KimigaiiWuyi/GenshinUID.git --depth=1 --single-branch
  1. 启动gsuid_core(早柚核心)
# 在gsuid_core/genshin_core文件夹内
poetry run python core.py
# 或者(二选一即可)
poetry run core
  1. 链接其他适配端
  • 默认core将运行在localhost:8765端口上,如有需要可至config.json修改。
  • 在支持的Bot上(例如NoneBot2、HoshinoBot、ZeroBot、YunZaiBot等),安装相应适配插件,启动Bot(如果有修改端口,则需要在启动Bot前修改适配插件相应端口),即可自动连接Core端。

Docker部署Core(可选)

请先安装好Docker与Docker Compose

  1. git clone gsuid-core本体
git clone https://github.com/Genshin-bots/gsuid_core.git --depth=1 --single-branch
  1. 安装所需插件(可选)
# cd进入插件文件夹内
cd plugins
# 安装v4 GenshinUID
git clone -b v4 https://github.com/KimigaiiWuyi/GenshinUID.git --depth=1 --single-branch
  1. Docker Compose启动
# 进入项目根目录
docker-compose up -d
  • 默认core将运行在localhost:8765端口上,Docker部署必须修改config.json,如0.0.0.0:8765
  • 如果Bot(例如NoneBot2、HoshinoBot)也是Docker部署的,Core或其插件更新后,可能需要将Core和Bot的容器都重启才生效

About

💖一套业务逻辑,多个平台支持!异步核心框架GsCore,为插件编写提供完善平台支持、核心数据库统一、复用游戏查询逻辑、网页控制台,支持Bot列表: NoneBot2 & HoshinoBot & ZeroBot & YunZaiBot & Koishi

Topics

Resources

License

Stars

Watchers

Forks

Languages