Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MakinoharaShoko committed Jul 1, 2024
1 parent 46f6540 commit 59a99fc
Show file tree
Hide file tree
Showing 6 changed files with 115 additions and 2 deletions.
40 changes: 39 additions & 1 deletion src/en/webgal-script/dialogue.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,44 @@ Example:
『[笑顔](えがお)』なんて、『[笑う](わらう)』なんて、[誰](だれ)でも[出来](でき)るもん…!
```

## Text Enhancement Syntax

In WebGAL 4.5.3, the "text enhancement syntax" feature has been added. This syntax allows you to add text styles to specific text.

Text enhancement syntax is an enhancement to a specific piece of text. Text enclosed in [] and followed by () as a text enhancement description is text that conforms to the text enhancement syntax definition.

In simple terms, it takes the following form:

```
(Text)[style-alltext=font-style:italic\; style=color:#66327C\; ruby=wen ben]
```

This means that the font size of this text is smaller, and it is bold, the color is #005CAF, and it has phonetic annotations and tooltips.

For different parameters in the text enhancement syntax, use spaces to separate them, and the form is always `argk=argv`.

It is important to note that because ; is the comment syntax of WebGAL, you need to add \ to escape it in the text enhancement syntax, which becomes \;.

### Scope of Style Effects for Different Parameters

![text-enhance](text-enhance.png)

In the previous example syntax, notice that there are two different parameters that can define styles for text: `style` and `style-alltext`.

The reason for distinguishing the scope of text styles is that in order to provide a better stroke effect for text, WebGAL divides a character into three layers: text, stroke, and placeholder.

Text is the topmost part and the main part. The stroke is below the text and is covered by the text to provide a white stroke without destroying the internal shape of the text. The bottom layer is a transparent placeholder that provides positioning.

In short, if you only need to change the text color, you only need to use the `style` parameter. If you want to apply effects such as italics, text size, internal and external margins, you need to set the effects for `style-alltext` at the same time.

**Special note: Due to a bug in version 4.5.3, it is currently not possible to apply only the style-alltext parameter, because the text enhancement syntax is only activated when the syntax `style=` is detected.**

### Compatibility with Phonetic Annotations

For compatibility with the previous syntax, if the syntax `style=` is not recognized, then we will treat the `()[]` syntax as a phonetic annotation.

If the new text enhancement syntax is used, the phonetic annotation is written in the `ruby=` parameter, as illustrated in the example above.

## Close the Text Box

Sometimes, for some special performance effects, you may want to temporarily close the text box, so you can use the following instructions to close the text box:
Expand Down Expand Up @@ -131,4 +169,4 @@ In this way, the game can return to the title interface.
## Cinematic Mode (Test Feature)

Use `filmMode:enable;` to enable cinematic mode.
Use `filmMode:none;` to disable cinematic mode.
Use `filmMode:none;` to disable cinematic mode.
Binary file added src/en/webgal-script/text-enhance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 39 additions & 1 deletion src/ja/webgal-script/dialogue.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,44 @@ WebGAL:はじめまして、{name}さん!
『[笑顔](えがお)』なんて、『[笑う](わらう)』なんて、[誰](だれ)でも[出来](でき)るもん…!
```

## テキスト拡張文法

WebGAL 4.5.3 では、「テキスト拡張文法」機能が追加されました。この文法を使用すると、一部のテキストにテキストスタイルを追加できます。

テキスト拡張文法は、特定のテキストを拡張したものです。 `[]` で囲まれ、その後に `()` で囲まれたテキスト拡張記述が続くテキストは、テキスト拡張文法の定義に準拠しています。

簡単に言うと、次の形式になります。

```
(テキスト)[style-alltext=font-style:italic\; style=color:#66327C\; ruby=wen ben]
```

これは、このテキストのフォントサイズが小さく、太字で、色が #005CAF で、ルビとヒントがあることを表しています。

テキスト拡張文法の異なるパラメータは、スペースで区切られ、常に `argk=argv` の形式になります。

特に注意が必要なのは、`;` は WebGAL のコメント構文であるため、テキスト拡張構文で `;` を使用するには、`\;` のようにエスケープする必要があることです。

### 異なるパラメータに対応するスタイルの適用範囲

![text-enhance](text-enhance.png)

前のサンプル構文では、`style``style-alltext` の 2 つのパラメータを使用してテキストのスタイルを定義できることに注意してください。

テキストスタイルの適用範囲を区別したのは、WebGAL では、テキストに優れた縁取り効果を提供するために、1 つの文字をテキスト、縁取り、プレースホルダーの 3 つのレイヤーに分割しているためです。

テキストは最上位レイヤーにあり、主要部分でもあります。縁取りはテキストの下にあり、テキストで覆われており、白い縁取りを提供するために使用されますが、文字の内部形状は壊しません。最下層は、配置を提供するための透明なプレースホルダーです。

簡単に言うと、テキストの色のみを変更する場合は、`style` パラメータのみを使用する必要があります。斜体、テキストサイズ、内外の余白などの効果を適用する場合は、`style-alltext` にも効果を設定する必要があります。

**特に注意:バージョン 4.5.3 のバグのため、現在、`style-alltext` パラメータのみを適用することはできません。`style=` などの構文が検出された場合にのみ、テキスト拡張構文が有効になります。**

### ルビとの互換性

以前の構文との互換性を保つため、`style=` などの構文が認識されない場合は、`()[]` 構文はルビと見なされます。

新しいテキスト拡張構文を使用した場合、ルビは `ruby=` パラメータに記述されます。上記の例でも説明されています。

## テキストボックスを閉じる

特殊な演出効果のために、一時的にテキストボックスを閉じたい場合があります。そのため、次のコマンドを使用してテキストボックスを閉じることができます。
Expand Down Expand Up @@ -131,4 +169,4 @@ end;
## 映画モード(テスト機能)

`filmMode:enable;`を使用して映画モードを有効にします。
`filmMode:none;`を使用して映画モードを無効にします。
`filmMode:none;`を使用して映画モードを無効にします。
Binary file added src/ja/webgal-script/text-enhance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions src/webgal-script/dialogue.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,43 @@ WebGAL:很高兴遇见你,{name}!
『[笑顔](えがお)』なんて、『[笑う](わらう)』なんて、[誰](だれ)でも[出来](でき)るもん…!
```

## 文本拓展语法

在 WebGAL 4.5.3 中,加入了“文本拓展语法”功能。该语法可以为部分文字添加文本样式。

文本拓展语法是对某段特定文本的增强。被[]包裹的,且后面跟随着()作为文本增强描述的文本是符合文本拓展语法定义的文本。

简单来说,形如以下形式:

```
(文本)[style-alltext=font-style:italic\; style=color:#66327C\; ruby=wen ben]
```
这代表这段文本的字体大小是偏小的,并应用了加粗,颜色为 #005CAF,并具有注音和提示。

对于文本拓展语法中的不同参数,使用空格分开,并且形式总是 `argk=argv` 这样的形式

特别需要注意的是,由于 ; 是 WebGAL 的注释语法,所以在文本拓展语法中应用 ; 需要加 \ 转义,成为 \;

### 不同参数对应的样式作用范围

![text-enhance](text-enhance.png)

在先前的示例语法中,注意到,有两个不同的参数可以为文本定义样式:`style``style-alltext`

为文本样式区分作用域,是因为 WebGAL 为了为文本提供更好的描边效果,将一个字分为了三层——文本、描边和占位。

文本是最上层的部分,也是主要部分。描边在文本下方,被文本覆盖,用于提供白色描边且不至于破坏文字的内部形状。最下层是提供定位的透明占位符。

简而言之,如果你只需要修改文本颜色,只需要使用 `style` 参数。如果你想要应用斜体、文本大小、内外边距等效果,你则需要同时为 `style-alltext` 设置效果。

**特别注意:由于4.5.3 版本中的一个 bug,目前不能只应用 style-alltext 参数,因为只有检测到 style= 这样的语法,才会启动文本拓展语法**

### 与注音的兼容性

为了兼容先前的语法,如果没有识别到 `style=` 这样的语法,则我们会将 `()[]` 语法视为注音。

如果使用了新的文本拓展语法,注音则写在 `ruby=` 参数里,上面的示例也说明了这一点。

## 关闭文本框

有时候,为了一些特殊的演出效果,可能你希望临时关闭文本框,所以你可以使用以下指令来关闭文本框:
Expand Down
Binary file added src/webgal-script/text-enhance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 59a99fc

Please sign in to comment.