{"id":15771530,"url":"https://github.com/lipraty/koishi-plugin-eula","last_synced_at":"2025-04-21T04:31:07.093Z","repository":{"id":65281308,"uuid":"589170711","full_name":"Lipraty/koishi-plugin-eula","owner":"Lipraty","description":"为你的 Koishi bot 添加一个 EULA(End-user licence agreement, 最终用户许可协议)","archived":false,"fork":false,"pushed_at":"2023-10-31T07:21:38.000Z","size":46,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T03:46:44.479Z","etag":null,"topics":["eula","koishi","koishi-plugin","koishijs"],"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":"2023-01-15T10:04:02.000Z","updated_at":"2023-10-21T11:00:40.000Z","dependencies_parsed_at":"2023-01-16T05:45:32.093Z","dependency_job_id":"834464f0-eb93-403c-878d-818c05cb9eee","html_url":"https://github.com/Lipraty/koishi-plugin-eula","commit_stats":{"total_commits":30,"total_committers":1,"mean_commits":30.0,"dds":0.0,"last_synced_commit":"5b0f5a12c129006a413442fa7b6b19635b5d195f"},"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-eula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lipraty%2Fkoishi-plugin-eula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lipraty%2Fkoishi-plugin-eula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lipraty%2Fkoishi-plugin-eula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lipraty","download_url":"https://codeload.github.com/Lipraty/koishi-plugin-eula/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249996082,"owners_count":21358057,"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":["eula","koishi","koishi-plugin","koishijs"],"created_at":"2024-10-04T15:03:02.861Z","updated_at":"2025-04-21T04:31:06.867Z","avatar_url":"https://github.com/Lipraty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koishi-plugin-eula\n\n[![npm](https://img.shields.io/npm/v/koishi-plugin-eula?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-eula) ![Rating](https://badge.koishi.chat/rating/koishi-plugin-eula)\n\n为你的 Koishi bot 添加一个 EULA(End-user licence agreement)\n\n## 普通用户直接使用\n\n在插件市场中搜索 `eula` 点击添加即可。\n\n## 开发扩展 eula 能力 (1.0+)\n\n首先需要添加 eula 开发模式依赖：\n\n``` shell\n# yarn:\n\nyarn add koishi-plugin-eula -d\n\n# or use npm\n\nnpm i koishi-plugin-eula -d\n```\n\n并且可以在 `package.json` 中加入如下 koishi 字段来声明 eula 依赖：\n\n``` json\n//package.json\n\n...\n  \"koishi\": {\n    ...,\n    \"service\": {\n      \"required\": [..., \"eula\"]\n    },\n    ...\n  },\n...\n```\n\n然后，在您的插件中引入类型依赖来获得类型提示\n\n以及添加 using 引用来让 koishi 正确的加载插件顺序：\n\n``` TypeScript\nimport {} from 'koishi-plugin-eula'\n\nexport const using = ['eula', ...]\n```\n最后，在您的插件中通过 `eula/update` 事件来获得 eula 状态，并根据状态自行调整：\n\n``` TypeScript\nctx.on('eula/update', (session: Session, eula: boolean) =\u003e {\n    //more core\n})\n```\n\n经过如上方式便可在您的插件中使用 eula 流程，或者基于 eula 的认证能力扩展出更多的玩法。\n\n## API\n\n### 服务：eula\n\n#### `ctx.eula.vertify()`\n\n\u003e 一般情况下，更推荐使用 `eula/update` 事件来获得认证状态，这将得到完整 Session 支持\n\n验证该用户是否同意过 `eula`\n\n- userId: `number` 用户 id，即 session.user.id\n\n### 扩展事件\n\n事件：`eula/before`\n\n命令触发 eula 流程**前**发生该事件\n\n事件：`eula/update`\n\n当用户回复 eula 后触发，这将传入一个 eula boolean 来告知用户同意与否\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flipraty%2Fkoishi-plugin-eula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flipraty%2Fkoishi-plugin-eula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flipraty%2Fkoishi-plugin-eula/lists"}