Skip to content

Commit 8289ae5

Browse files
committed
docs update of v13.5
1 parent 76cdb79 commit 8289ae5

File tree

4 files changed

+102
-2
lines changed

4 files changed

+102
-2
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,24 @@ You can use it to control the display of the terminal, such as text colour, back
150150
- `X-SSTP-PassThru-CommandForDisplay` (optional)
151151
Replace the displayed command with this content
152152
ghost can use this event to implement masks on password entry, syntax highlighting on normal reads, and other functions
153+
- `ShioriEcho.CommandPrompt`
154+
Events when the command prompt is updated
155+
- Return value
156+
- `X-SSTP-PassThru-Prompt` (optional)
157+
Replace the displayed command prompt with this content
158+
ghost can implement dynamic changes to the command prompt with this event
159+
- `ShioriEcho.CommandComplete`
160+
Event when the user presses `` at the far right of the command line
161+
- `Reference0`
162+
Commands collected by the terminal
163+
- `Reference1`
164+
The first character of the command where the cursor was when `` was pressed (starting value 0)
165+
- Return value
166+
- `X-SSTP-PassThru-Command` (optional)
167+
Replace the command with this content
168+
ghost can auto-complete commands with this event
169+
- `X-SSTP-PassThru-InsertIndex` (optional)
170+
Move the cursor to this position (or leave it unchanged if not provided)
153171

154172
### Command History
155173

@@ -172,3 +190,10 @@ You can use it to control the display of the terminal, such as text colour, back
172190
- Return value
173191
- `X-SSTP-PassThru-Command` (optional)
174192
Replace the command with this content
193+
- `ShioriEcho.CommandHistory.NextIndex`
194+
Event when the index is updated when the user presses ``
195+
- `Reference0`
196+
Index of the history command (in reverse order, starting value 0)
197+
- Return value
198+
- `X-SSTP-PassThru-Index` (optional)
199+
Update the index to this value

README_CN.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,24 @@ ghost_terminal通过`X-SSTP-PassThru-*`进行与人格间的信息沟通(见[
146146
- `X-SSTP-PassThru-CommandForDisplay`(可选)
147147
将显示的命令替换为此内容
148148
ghost可以通过此事件实现密码输入时的掩码、正常读入时的语法高亮、以及其他功能
149+
- `ShioriEcho.CommandPrompt`
150+
命令提示符更新时事件
151+
- 返值
152+
- `X-SSTP-PassThru-Prompt`(可选)
153+
将显示的命令提示符替换为此内容
154+
ghost可以通过此事件实现命令提示符的动态变化
155+
- `ShioriEcho.CommandComplete`
156+
用户于命令行最右端按下``时事件
157+
- `Reference0`
158+
终端所收集到的命令
159+
- `Reference1`
160+
按下``时光标所在命令的第几个字符(起始值0)
161+
- 返值
162+
- `X-SSTP-PassThru-Command`(可选)
163+
将命令替换为此内容
164+
ghost可以通过此事件实现命令的自动补全
165+
- `X-SSTP-PassThru-InsertIndex`(可选)
166+
将光标移动到此位置(若不提供则保持不变)
149167

150168
### 命令历史
151169

@@ -164,7 +182,14 @@ ghost_terminal通过`X-SSTP-PassThru-*`进行与人格间的信息沟通(见[
164182
- `ShioriEcho.CommandHistory.Get`
165183
命令历史获取时事件
166184
- `Reference0`
167-
历史命令的索引(倒序,起始值0)
185+
历史命令的索引(倒序,起始值0)
168186
- 返值
169187
- `X-SSTP-PassThru-Command`(可选)
170188
将命令替换为此内容
189+
- `ShioriEcho.CommandHistory.NextIndex`
190+
用户按压``时更新索引时事件
191+
- `Reference0`
192+
历史命令的索引(倒序,起始值0)
193+
- 返值
194+
- `X-SSTP-PassThru-Index`(可选)
195+
将索引更新为此数值

README_EN.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,24 @@ You can use it to control the display of the terminal, such as text colour, back
146146
- `X-SSTP-PassThru-CommandForDisplay` (optional)
147147
Replace the displayed command with this content
148148
ghost can use this event to implement masks on password entry, syntax highlighting on normal reads, and other functions
149+
- `ShioriEcho.CommandPrompt`
150+
Events when the command prompt is updated
151+
- Return value
152+
- `X-SSTP-PassThru-Prompt` (optional)
153+
Replace the displayed command prompt with this content
154+
ghost can implement dynamic changes to the command prompt with this event
155+
- `ShioriEcho.CommandComplete`
156+
Event when the user presses `` at the far right of the command line
157+
- `Reference0`
158+
Commands collected by the terminal
159+
- `Reference1`
160+
The first character of the command where the cursor was when `` was pressed (starting value 0)
161+
- Return value
162+
- `X-SSTP-PassThru-Command` (optional)
163+
Replace the command with this content
164+
ghost can auto-complete commands with this event
165+
- `X-SSTP-PassThru-InsertIndex` (optional)
166+
Move the cursor to this position (or leave it unchanged if not provided)
149167

150168
### Command History
151169

@@ -168,3 +186,10 @@ You can use it to control the display of the terminal, such as text colour, back
168186
- Return value
169187
- `X-SSTP-PassThru-Command` (optional)
170188
Replace the command with this content
189+
- `ShioriEcho.CommandHistory.NextIndex`
190+
Event when the index is updated when the user presses ``
191+
- `Reference0`
192+
Index of the history command (in reverse order, starting value 0)
193+
- Return value
194+
- `X-SSTP-PassThru-Index` (optional)
195+
Update the index to this value

README_JP.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,24 @@ ghost_terminalの出力は、プレーンテキストではなく、仮想端末
148148
- `X-SSTP-PassThru-CommandForDisplay` (オプション)
149149
表示されているコマンドをこの内容に置き換えます。
150150
ゴーストはこのイベントを利用して、パスワード入力時のマスク、通常読み上げ時のシンタックスハイライトなどの機能を実装することができます。
151+
- `ShioriEcho.CommandPrompt`
152+
コマンドプロンプトが更新されたときのイベント
153+
- 戻り値
154+
- X-SSTP-PassThru-Prompt` (オプション)
155+
表示されているコマンドプロンプトをこの内容で置き換える
156+
ゴーストはこのイベントでコマンドプロンプトを動的に変更することができます。
157+
- `ShioriEcho.CommandComplete`
158+
ユーザーがコマンドラインの右端にある `` を押したときのイベント
159+
- `Reference0`
160+
端末が収集したコマンド
161+
- `Reference1`
162+
カーソルがある位置で `` を押したときのコマンドの最初の文字(開始値は0)。
163+
- 戻り値
164+
- `X-SSTP-PassThru-Command` (オプション)
165+
コマンドをこの内容で置き換える
166+
ゴーストは、このイベントでコマンドをオートコンプリートすることができます。
167+
- `X-SSTP-PassThru-InsertIndex` (オプション)
168+
カーソルをこの位置に移動させる(提供されない場合はそのままにする)
151169

152170
### コマンド履歴
153171

@@ -163,10 +181,17 @@ ghost_terminalの出力は、プレーンテキストではなく、仮想端末
163181
履歴コマンドのインデックス(逆順、開始値0)
164182
- 戻り値
165183
無視される、**ただし、sakura scriptは正常に実行される**
166-
- `ShioriEcho.CommandHistory.Get` の略です。
184+
- `ShioriEcho.CommandHistory.Get`
167185
コマンドヒストリーを取得したときのイベント
168186
- `Reference0`
169187
履歴コマンドのインデックス(逆順、開始値0)
170188
- 戻り値
171189
- `X-SSTP-PassThru-Command` (オプション)
172190
コマンドをこの内容で置き換える
191+
- `ShioriEcho.CommandHistory.NextIndex`
192+
ユーザが `` を押したときにインデックスが更新されるときのイベント
193+
- `Reference0`
194+
履歴コマンドのインデックス(逆順、開始値0)
195+
- 戻り値
196+
- `X-SSTP-PassThru-Index` (オプション)
197+
インデックスをこの値に更新する

0 commit comments

Comments
 (0)