koishijs / docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation for Koishi
Home Page: https://koishi.chat
License: Creative Commons Attribution Share Alike 4.0 International
Documentation for Koishi
Home Page: https://koishi.chat
License: Creative Commons Attribution Share Alike 4.0 International
/api/service/logger.md
还是旧版遗留
更新文档
No response
No response
演练厂:配置构型
页面的中核心概念
,基础类型
,高级类型
中各个页面的描述部分在刷新后会无法显示,在直接用链接访问的情况下也无法显示,但此时其他的页面内容显示正常
在前往其他页面刷新后(如演练厂:配置构型 > 演练场 > 配置构型
)再前往核心概念
,基础类型
,高级类型
中的页面,描述部分会出现,此时如果再刷新,描述部分会无法显示
https://koishi.chat/zh-CN/schema/meta/required.html (及核心概念
下的所有页面)
https://koishi.chat/zh-CN/schema/basic/number.html (及基础类型
下的所有页面)
https://koishi.chat/zh-CN/schema/advanced/intersect.html (及高级类型
下的所有页面)
You have created a wonderful project, but unfortunately is it relatively hard to use and learn for non-Chinese users.
Please consider adding at least partial translations of the main parts of the documentation.
No response
No response
提醒开发者在开发过程中避免写出 file:///
来拼接的形式
使用 pathToFileURL
方法解决此形式可能导致的问题
例如 permission 和 inventory 服务要如何实现国际化?其他插件有可以借鉴的实践吗?
現在 Node.js 官方網站已無「兩個巨大的按鈕」,應該修正表述
docs/zh-CN/manual/starter/boilerplate.md
Lines 31 to 37 in 0cd5f59
yarn
(should confirm!) and corepack
, also generally we recommend using Yarn Berry
Node.js 目前似乎會連同
yarn
(需確認) 和corepack
,并且我們現在推薦使用 Yarn Berry
docs/zh-CN/manual/starter/boilerplate.md
Lines 43 to 51 in 0cd5f59
文档中的描述是/wechatofficial,但源码中实际是/wechat-official
Steps to reproduce
https://koishi.chat/zh-CN/plugins/adapter/wechat-official.html
Expected behavior
应当与源码保持一致
4.16 起 server 已经不是内置服务了,因此有必要对相关文档进行调整:
docs/zh-CN/manual/recipe/search.md
Lines 15 to 20 in 2134e1d
Here, various types of plugins are listed with their display styles and icons in the plugin marketplace. However, text-based representation may not be very intuitive. I believe it can be replaced with the same set of icons used in the plugin marketplace.
这里列出了插件市场中各种类型的插件及其显示样式和图标。然而,基于文本的表示可能不是很直观。我相信它可以替换为插件市场中使用的同一组图标。
如题
de-DE的文档
例如
https://koishi.chat/de-DE/plugins/common/broadcast.html#%E6%8C%87%E4%BB%A4-broadcast
在点击左上角小图标时会跳转到 koishi.chat 而不是 koishi.chat/de-DE
export default Schema.object({
dict: Schema.dict(Boolean),
value2: Schema.union([])
})
我想让 dict 的所有 key,作为 value2 的选项。
Consider adding a new section to explain why and how to unpublish a plugin in publish.md.
Also move the phrase in the pathesis at the line below to there.
docs/zh-CN/guide/develop/publish.md
Line 65 in 6cf4aec
目前本仓库对应 https://docs.koishi.chat。
完成上述事项后将替换为 https://koishi.chat。
完成上述事项后将全面取代现有的链接。
文档中介绍了插件应当export一个Config interface,然后用schemastery对config进行验证,但是没有提到每个插件的config具体如何对应到koishi.yml的某个值,同时希望增加一下常见的嵌套插件的情况下的config的best practice
如题,部分 API 如 execute()
等 API 都不在文档内,一些已经存在在文档内 API 的类型和用法都不完全,希望可以将数据库 API 文档完善一下。
看了文档之后,我还是没明白这个东西应该怎么用,只知道了可以直接下载一个程序然后运行,在研究一会后发现运行之后好像会开一个40666的端口
有计划在这里(指文档)添加基本的使用说明吗?类似这样的语句:
程序在启动后会启动一个Web服务,可以直接访问它
程序在桌面环境启动后会用浏览器打开管理面板
可选的图标:
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -1 104 106" data-site="upload.wikimedia">
<path fill="#231f20" d="M51.87 0C23.71 0 0 22.83 0 51v52.81l51.86-.05c28.16 0 51-23.71 51-51.87S80 0 51.87 0Z"/>
<path fill="#fff9ae" d="M52.37 19.74a31.62 31.62 0 0 0-27.79 46.67l-5.72 18.4 20.54-4.64a31.61 31.61 0 1 0 13-60.43Z"/>
<path fill="#00aeef" d="M77.45 32.12a31.6 31.6 0 0 1-38.05 48l-20.54 4.7 20.91-2.47a31.6 31.6 0 0 0 37.68-50.23Z"/>
<path fill="#00a94f" d="M71.63 26.29A31.6 31.6 0 0 1 38.8 78l-19.94 6.82 20.54-4.65a31.6 31.6 0 0 0 32.23-53.88Z"/>
<path fill="#f15d22" d="M26.47 67.11a31.61 31.61 0 0 1 51-35 31.61 31.61 0 0 0-52.89 34.3l-5.72 18.4Z"/>
<path fill="#e31b23" d="M24.58 66.41a31.61 31.61 0 0 1 47.05-40.12 31.61 31.61 0 0 0-49 39.63l-3.76 18.9Z"/>
<deepl-alert xmlns=""/><deepl-alert xmlns=""/><deepl-alert xmlns=""/><style xmlns="http://www.w3.org/1999/xhtml" id="ld0y9r61.7c">rt.katakana-terminator-rt::before { content: attr(data-rt); }</style></svg>
<svg id="koishi" width="1024" height="1024" viewBox="0 0 512 512"
xmlns="http://www.w3.org/2000/svg">
<circle cx="256" cy="256" r="256" fill="#53489C"/>
<path d="M448.15,218.52a278,278,0,0,1-17.71,61.42,40.16,40.16,0,0,0,25-4,40,40,0,0,1-33.07,21.45,280.06,280.06,0,0,1-39.12,58.33,8,8,0,0,0-1.06,8.9L401,401l-36.37-18.77a8,8,0,0,0-8.9,1.06,280.06,280.06,0,0,1-58.33,39.12A40,40,0,0,1,276,455.48a40.16,40.16,0,0,0,4-25,278,278,0,0,1-61.42,17.71A25,25,0,0,1,193.87,471a25,25,0,0,0,8.69-20.66,281.77,281.77,0,0,1-56,.5C301.54,432,432,301.54,450.84,146.55a281.77,281.77,0,0,1-.5,56A25,25,0,0,0,471,193.87,25,25,0,0,1,448.15,218.52Z" fill="#FFFFFF"/>
</svg>
使用自定义事件时需要先导入相应的适配器,建议将其补充到文档中
Line 19 in 0cd5f59
Should explain what cordis
is or add a link to cordis documents.
应当解释
cordis
是什么,或者添加一个链接到 cordis 的文档
讲一讲我发现/遇到的问题吧。
https://koishi.chat/manual/advanced/workspace.html
以 开发模式 重新运行你的项目,你会立即在网页控制台的配置界面中看到 example 插件。只需点击启用,你就可以实现与机器人的对话了:
创建example插件的时候,以开发模式重新运行项目,并不会立即在网页控制台的配置界面中看到 example 插件。需要在koishi.yml添加example:{},或者在插件配置
的右上角点添加插件
才能看到 example 插件。
另外我有一些小的pr想提,没有找到大致的操作流程。
我目前的流程如下:
添加插件
添加music插件[W] app duplicate plugin detected: music
music hi
,控制台报错2022-12-09 13:19:33 [W] session music hi
TypeError: Cannot read properties of undefined (reading '_data')
at Internal._executeMatcher (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\core\src\internal.ts:206:42)
at Session.<anonymous> (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\core\src\internal.ts:150:14)
at Lifecycle.emit (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\events.ts:100:16)
at Context.<anonymous> (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\context.ts:73:27)
at Internal._process (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\core\src\internal.ts:282:14)
at next (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\core\src\internal.ts:342:22)
...
2022-12-09 13:20:21 [I] app apply plugin music:aninfx
2022-12-09 13:20:22 [W] app TypeError: Cannot read properties of undefined (reading 'define')
at Object.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\plugin-help\src\index.ts:65:12)
at MainScope.MainScope.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:251:36)
at MainScope.start (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:281:12)
at MainScope.restart (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:67:10)
at MainScope.setup (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:246:10)
at MainScope (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:209:22)
at Map.plugin (C:\Users\allegray\koishi-bot\test\kois...
2022-12-09 13:20:22 [W] app TypeError: Cannot read properties of undefined (reading 'define')
at Object.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\plugin-sandbox\src\index.ts:119:12)
at MainScope.MainScope.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:251:36)
at MainScope.start (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:281:12)
at MainScope.restart (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:67:10)
at MainScope.setup (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:246:10)
at MainScope (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:209:22)
at Map.plugin (C:\Users\allegray\koishi-bot\test\...
2022-12-09 13:20:22 [W] app TypeError: Cannot read properties of undefined (reading 'extend')
at MetaProvider (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\plugin-status\src\meta.ts:34:15)
at MainScope.MainScope.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:255:24)
at MainScope.start (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:281:12)
at MainScope.restart (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:67:10)
at MainScope.setup (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:246:10)
at MainScope (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:209:22)
at Map.plugin (C:\Users\allegray\koishi-bot\test\koi...
2022-12-09 13:20:22 [W] app TypeError: Cannot read properties of undefined (reading 'tables')
at SQLiteDriver (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@minatojs\driver-sqlite\src\index.ts:94:43)
at Object.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\core\src\database.ts:197:20)
at MainScope.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:251:36)
at ForkScope.start (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:177:32)
at ForkScope (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:171:10)
at MainScope.fork (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:223:12)
at Map.plugin (C:\Users\allegray\koishi-bot\test\koishi...
2022-12-09 13:20:22 [W] app TypeError: Cannot read properties of undefined (reading 'command')
at Context.<anonymous> (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\context.ts:73:21)
at Object.apply (c:\Users\allegray\koishi-bot\test\koishi-app\plugins\music\src\index.ts:59:7)
at MainScope.MainScope.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:251:36)
at MainScope.start (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:281:12)
at MainScope.restart (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:67:10)
at MainScope.setup (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:246:10)
at MainScope (C:\Users\allegray\koishi-bot\test\koishi-app\node...
2022-12-09 13:20:22 [E] app TypeError: Cannot read properties of undefined (reading 'define')
at Object.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\@koishijs\cli\src\worker\daemon.ts:61:12)
at MainScope.MainScope.apply (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:251:36)
at MainScope.start (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:281:12)
at MainScope.restart (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:67:10)
at MainScope.setup (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:246:10)
at MainScope (C:\Users\allegray\koishi-bot\test\koishi-app\node_modules\cordis\src\scope.ts:209:22)
at Map.plugin (C:\Users\allegray\koishi-bot\test\kois...
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
换成bvid插件也是一样的错。
但是换成novelai插件的话就一切正常,换成novelai插件我第3步改成了执行git clone https://github.com/koishijs/novelai-bot plugins/novelai
。
需要更新文档。
https://koishi.chat/zh-CN/guide/i18n/crowdin.html#%E9%A1%B9%E7%9B%AE%E7%BB%93%E6%9E%84
应当从两个角度介绍:
并给出对应的 crowdin.yml 文件。
Telegram文档改进
- 使用 /setprivacy 开启 Privacy Mode(不然机器人只能收到特定消息)
...
如果启动机器人后发现收不到不带 / 的消息,这很可能是由于 Privacy Mode 未开启。如果开启后仍然收不到消息,请尝试将机器人从群组中移除后重新加入。
这段是不是有些问题?开启Privacy Mode是仅能接受带斜杠的消息吧,应该是Privacy Mode设置为DISABLED
No response
No response
目前许多被强制 2FA 的账号没法按照官网上的流程跑通发版,需要 npm login
,使用 --otp
或生成 token。
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.