Skip to content

Commit 54b3e13

Browse files
committed
doc update
1 parent 8289ae5 commit 54b3e13

File tree

4 files changed

+24
-0
lines changed

4 files changed

+24
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ Any ghost_terminal output will be rendered by a virtual terminal sequence, rathe
6161
Reference: [Console Virtual Terminal Sequences](https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences)
6262
You can use it to control the display of the terminal, such as text colour, background colour, font, etc.
6363

64+
### Default behaviour
65+
66+
Most of the events in the following events will use the default behaviour if not implemented by ghost
67+
In other words, **if you want your ghost to support terminal, you only need to implement the `ShioriEcho` event.**
68+
The rest of the events should only be defined if you want to change the default behaviour or provide a richer experience
69+
6470
### Start/End
6571

6672
- `ShioriEcho.Begin`

README_CN.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ ghost_terminal通过`X-SSTP-PassThru-*`进行与人格间的信息沟通(见[
5757
参考:[虚拟终端序列](https://learn.microsoft.com/zh-cn/windows/console/console-virtual-terminal-sequences)
5858
你可以使用它来控制终端的显示效果,如文字颜色、背景色、字体等。
5959

60+
### 默认行为
61+
62+
在以下事件中大多数事件如果ghost没有实现,terminal将使用默认行为
63+
换言之,**如果你想你的ghost支持terminal,你只需要实现`ShioriEcho`事件即可**
64+
其余事件只在你想要更改默认行为或者提供更为丰富的体验时才需要进行定义
65+
6066
### 启动、终止
6167

6268
- `ShioriEcho.Begin`

README_EN.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ Any ghost_terminal output will be rendered by a virtual terminal sequence, rathe
5757
Reference: [Console Virtual Terminal Sequences](https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences)
5858
You can use it to control the display of the terminal, such as text colour, background colour, font, etc.
5959

60+
### Default behaviour
61+
62+
Most of the events in the following events will use the default behaviour if not implemented by ghost
63+
In other words, **if you want your ghost to support terminal, you only need to implement the `ShioriEcho` event.**
64+
The rest of the events should only be defined if you want to change the default behaviour or provide a richer experience
65+
6066
### Start/End
6167

6268
- `ShioriEcho.Begin`

README_JP.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ ghost_terminalの出力は、プレーンテキストではなく、仮想端末
5959
参考:[コンソールの仮想ターミナル シーケンス](https://learn.microsoft.com/ja-jp/windows/console/console-virtual-terminal-sequences)
6060
文字色、背景色、フォントなど、端末の表示を制御するために使用できます。
6161

62+
### デフォルトの動作
63+
64+
以下のイベントのほとんどは、ghostが実装していない場合、デフォルトの挙動を使用します。
65+
言い換えれば、**あなたのゴーストがターミナルをサポートしたい場合、`ShioriEcho`イベントだけを実装する必要があります**
66+
残りのイベントは、デフォルトの動作を変更したい場合や、より豊かな体験を提供したい場合にのみ定義する必要があります。
67+
6268
### 開始、終了
6369

6470
- `ShioriEcho.Begin`

0 commit comments

Comments
 (0)