mincomk/risuai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed example code error in plugin docs (#694)

Browse Source 
# PR Checklist
- [ ] Have you checked if it works normally in all models? *Ignore this
if it doesn't use models.*
- [ ] Have you checked if it works normally in all web, local, and node
hosted versions? If it doesn't, have you blocked it in those versions?
- [ ] Have you added type definitions?

It's just a docs change.

# Description
Fixed example code in the plugin docs to match with Plugin Syntax.
This commit is contained in:
kwaroran
2024-12-28 05:36:01 +09:00
committed by GitHub
parent 663f89617a c841538c51
commit b1e915d4cb
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
plugins.md
View File

@@ -9,7 +9,7 @@ A plugin is a js file with a header. for example:
```js
//@name exampleplugin
//display-name: Example Plugin
//@display-name Example Plugin
// Plugin code here
```
@@ -118,7 +118,7 @@ Adds a risu script handler to the plugin.
- `type: string` - The handler type. one of `display`, `output`, `input`, `process`
- `display` - The handler will be called when the data is displayed.
- `output` - The handler will be called when the data is outputted by the AI model.
- `input` - The handler will be called when the data is inputted to the user.
- `input` - The handler will be called when the data is inputted by the user.
- `process` - The handler will be called when creating actual request data.
- `func: (content:string) => string|null|undefined|Promise<string|null|undefined>` - The handler function.
- `content: string` - The content to handle.
@@ -163,4 +163,4 @@ The plugin system has been updated to V2. The following changes have been made:
- `addCharaJs` function has been removed. use `addRisuScriptHandler` instead.
- `risuLog` function has been removed. use `console.log` instead.
- Many security restrictions have been removed.
- `@risu-name`, `@risu-display-name`, `@risu-arg` headers has been removed. use `@name`, `@display-name`, `@arg` instead. if it's not present, it will be ran as V1 plugin.
- `@risu-name`, `@risu-display-name`, `@risu-arg` headers has been removed. use `@name`, `@display-name`, `@arg` instead. if it's not present, it will be ran as V1 plugin.