{"id":15705613,"url":"https://github.com/lipraty/koishi-plugin-paimon","last_synced_at":"2025-05-12T18:27:53.532Z","repository":{"id":144649579,"uuid":"529937237","full_name":"Lipraty/koishi-plugin-paimon","owner":"Lipraty","description":"A koishi plugin for a certain anime game.","archived":false,"fork":false,"pushed_at":"2023-01-19T09:50:23.000Z","size":1765,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T01:42:29.282Z","etag":null,"topics":["chatbot","genshin","genshin-api","genshin-impact","koishi","koishi-plugin","yuanshen"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Lipraty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-28T17:50:46.000Z","updated_at":"2023-10-21T11:00:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"167af346-1d17-436c-925b-44ed7f7b7465","html_url":"https://github.com/Lipraty/koishi-plugin-paimon","commit_stats":{"total_commits":182,"total_committers":1,"mean_commits":182.0,"dds":0.0,"last_synced_commit":"b426cf57db1122122f8312ebcc2e18fc1c3e3fc9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lipraty%2Fkoishi-plugin-paimon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lipraty%2Fkoishi-plugin-paimon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lipraty%2Fkoishi-plugin-paimon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lipraty%2Fkoishi-plugin-paimon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lipraty","download_url":"https://codeload.github.com/Lipraty/koishi-plugin-paimon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253797227,"owners_count":21965846,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","genshin","genshin-api","genshin-impact","koishi","koishi-plugin","yuanshen"],"created_at":"2024-10-03T20:17:31.028Z","updated_at":"2025-05-12T18:27:53.493Z","avatar_url":"https://github.com/Lipraty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koishi-plugin-paimon\n\n[![npm](https://img.shields.io/npm/v/koishi-plugin-paimon?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-paimon)\n\n\u003e 这是一个已经停止更新的插件，所有功能将转移至 Koishi 官方插件： [koishi-plugin-genshin](https://github.com/koishijs/koishi-plugin-genshin)。敬请期待适用于 Koishi v4 的 Genshin 插件吧！\n\n## 安装\n\n```Shell\n#npm:\nnpm install koishi-plugin-paimon\n\n#or use yarn:\nyarn add koishi-plugin-paimon\n```\n\n### 所需`koishi`外部插件与依赖\n\n- `database`：用于存储用户数据\n- `koishi-plugin-puppeteer`：用于图片生成\n- `@koishijs/plugin-rate-limit`：用于指令速率限制\n\n如果未安装上述依赖，可以使用以下方法进行安装：\n\n\u003e koishi database能对接多种平台，请选择符合自身的数据库平台；名称为`@koishijs/plugin-database-[platform]`，下列示例以sqlite为例。\n\n```Shell\n#npm:\nnpm install koishi-plugin-puppeteer @koishijs/plugin-database-sqlite @koishijs/plugin-rate-limit\n\n#or use yarn:\nyarn add koishi-plugin-puppeteer @koishijs/plugin-database-sqlite @koishijs/plugin-rate-limit\n```\n\n## Paimon 服务\n\n通过`ctx.paimon`访问\n\n#### `paimon.login(uid, cookie?, dsalt?): Paimon`\n\n在使用其他api前应当先进行login，传入必要的参数以保证符合预期执行\n\n| Params  | Description            |\n| ------- | ---------------------- |\n| uid     | 游戏uid                |\n| cookie? | 米游社Cookie           |\n| dsalt?  | 虚拟设备信息所用的Salt |\n\n#### `paimon.render(def, elementType?)(...args): Promise\u003cstring | Buffer | h\u003e`\n\n请求后续所列出的某个API，并渲染为图片返回\n\n\u003e 这是一个柯里化的函数，第二个`(...args)`则是下列函数可能需要的参数。并根据elementType返回一个流动的`Promise\u003cT\u003e`\\\n\u003e 例如：`paimon.render('bbsSign', 'base64')(true)`。\n\n| Params       | Description                                                                            |\n| ------------ | -------------------------------------------------------------------------------------- |\n| def          | 需要请求的API，即下列所列出的函数名                                                    |\n| elementType? | 返回类型，默认为buffer（`base64` -\u003e `string`，`buffer` -\u003e `Buffer`, `element` -\u003e `h`） |\n\n\n#### `paimon.bbsSign(onlyInfo?): Promise\u003cSignInfo\u003e`\n\n执行米游社签到\n\n| Params    | Description                    |\n| --------- | ------------------------------ |\n| onlyInfo? | 不执行签到行为，只返回签到数据 |\n\n#### `paimon.memo(): Promise\u003cMemoInfo\u003e`\n\n查询米游社 每日便笺 内容\n\n#### `paimon.abyss(period?, level?): Promise\u003cAbyssInfo\u003e`\n\n查询米游社 深境螺旋 内容\n\n| Params  | Description              |\n| ------- | ------------------------ |\n| period? | 选择回顾上期或本期的战报 |\n| level?  | 单独限制该层信息         |\n\n#### `paimon.gachaImport(gachaDataJson): Promise\u003cvoid | boolan\u003e`\n\n导入原神抽卡记录进行分析\n\n| Params        | Description                                                                 |\n| ------------- | --------------------------------------------------------------------------- |\n| gachaDataJson | 以`gachaData-[uid]-[time].json`文件名的原神祈愿记录（genshin-gacha-export） |\n\n#### `paimon.note(month?): Promise\u003cNoteData\u003e`\n\n查询米游社旅行者札记\n\n## Paimon 命令\n\n插件命令以`paimon`开头，部分命令拥有参数`[uid]`，随后可接额外的选项与参数。\n\n\u003e 使用命令需要在插件设置中将 `useCommand` 设置为`true`。\n\n```Shell\npaimon[.subcommand] [uid] --option [option arg]\n```\n\n\u003e 具体用法可以发送`paimon -h`查看\n\n其中`[uid]`被视为一个可选参数，如果有该参数则会让paimon的行为限制在该uid内。\n\n- 指定的`[uid]`只能是已绑定的uid，如果未绑定该uid，则返回非绑定uid警告。\n- 当用户权限大于等于`master`选项所设置数值时，将无视限制。\n\n当然，为了方便使用，插件支持以快捷方式触发命令，发送`paimon`或`#帮助`即可获得一个支持的命令列表图片。就像Yunzai-bot一样。\n\nAll game data \u0026 pictures from ©mihoyo","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flipraty%2Fkoishi-plugin-paimon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flipraty%2Fkoishi-plugin-paimon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flipraty%2Fkoishi-plugin-paimon/lists"}