LunaTranslator

https://docs.lunatranslator.org
Admin
LunaTranslator is a comprehensive translation software that uses game text hooking, OCR, and...
Tokens:13,236
Snippets:187
Trust Score:5.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### JIT HOOK Special Code Format

Source: https://docs.lunatranslator.org/cht/hooksettings.html

Specifies the format for Just-In-Time (JIT) hooks, including parameter indexing, specific engine information (Unity, Yuzu, etc.), and argument details. Use this for hooking functions in JIT environments.

```plaintext
{H|B}{A|B|C|W|I|S|Q|M|U|V}[F][N][codepage#][padding+]arg_index[*deref_offset][:split_offset[*deref_offset]]@{info}:JIT:{UNITY|YUZU|PPSSPP|VITA3K|RPCS3}
arg_index is the parameter Index of the JIT function. M is C# string, only available for Unity.
UNITY's info is: [Component]:[Namespace]:[ClassName]:[FunctionName]:[ArgCount].
YUZU, PPSSPP, VITA3K, RPCS3's info is the simulated address.
```

--------------------------------

### /api/tts

Source: https://docs.lunatranslator.org/cht/apiservice.html

Converts text to speech. Returns the audio data in binary format.

```APIDOC
## GET /api/tts

### Description
Converts the provided text into speech and returns the audio data in binary format.

### Method
GET

### Endpoint
/api/tts

### Parameters
#### Query Parameters
- **text** (string) - Required - The text to convert to speech.
```

--------------------------------

### /api/list/dictionary

Source: https://docs.lunatranslator.org/cht/apiservice.html

Lists all available dictionaries.

```APIDOC
## GET /api/list/dictionary

### Description
Retrieves a list of all dictionaries currently available.

### Method
GET

### Endpoint
/api/list/dictionary
```

--------------------------------

### Custom Python Processing

Source: https://docs.lunatranslator.org/cht/textprocess.html

Allows for complex text manipulation using a custom Python script. A template file 'mypost.py' is generated in the 'userconfig' directory if it doesn't exist.

```python
def POSTSOLVE(line):
    # 請在這裡編寫自訂處理
    return line

```

--------------------------------

### /api/textinput

Source: https://docs.lunatranslator.org/cht/apiservice.html

Processes input text. Requires the 'text' parameter.

```APIDOC
## GET /api/textinput

### Description
Processes the provided input text. This endpoint requires the 'text' query parameter.

### Method
GET

### Endpoint
/api/textinput

### Parameters
#### Query Parameters
- **text** (string) - Required - The input text to process.
```

--------------------------------

### /api/ws/text/origin

Source: https://docs.lunatranslator.org/cht/apiservice.html

WebSocket endpoint that continuously streams all captured original text.

```APIDOC
## WebSocket /api/ws/text/origin

### Description
Establishes a WebSocket connection that continuously streams all captured original text as it is acquired.

### Endpoint
/api/ws/text/origin
```

--------------------------------

### /api/mecab

Source: https://docs.lunatranslator.org/cht/apiservice.html

Parses text using the Mecab morphological analyzer. Returns the analysis result.

```APIDOC
## GET /api/mecab

### Description
Parses the input text using the Mecab morphological analyzer and returns the analysis result.

### Method
GET

### Endpoint
/api/mecab

### Parameters
#### Query Parameters
- **text** (string) - Required - The text to be parsed by Mecab.
```

--------------------------------

### Direct Memory Read Format

Source: https://docs.lunatranslator.org/cht/hooksettings.html

Specifies the format for directly reading memory, including string types and memory addresses. Use this for reading raw string data from memory.

```plaintext
R{S|Q|V|U}[codepage#]@addr
R is the flag for direct memory read.
S is default ASCII string, Q is UTF-16, U is UTF-32, V is UTF-8.
```

--------------------------------

### /api/list/translator

Source: https://docs.lunatranslator.org/cht/apiservice.html

Lists all available translators.

```APIDOC
## GET /api/list/translator

### Description
Retrieves a list of all translators currently available.

### Method
GET

### Endpoint
/api/list/translator
```

--------------------------------

### /api/dictionary

Source: https://docs.lunatranslator.org/cht/apiservice.html

Queries a dictionary for a given word. Returns results from a specific dictionary or streams results from all dictionaries.

```APIDOC
## GET /api/dictionary

### Description
Queries a dictionary for a specific word. If a dictionary ID is provided, it returns the JSON object for that dictionary's result. If no ID is specified, it streams results from all dictionaries as JSON objects.

### Method
GET

### Endpoint
/api/dictionary

### Parameters
#### Query Parameters
- **word** (string) - Required - The word to look up in the dictionary.
- **id** (string) - Optional - The ID of the dictionary to query.
```

--------------------------------

### HOOK Special Code Format

Source: https://docs.lunatranslator.org/cht/hooksettings.html

Defines the syntax for inline and VEH hooks, specifying data types, endianness, string types, and memory offsets. Use this for direct memory access and string manipulation hooks.

```plaintext
{H|B}{A|B|C|W|I|S|Q|U|V}[F][N][codepage#][padding+]data_offset[*deref_offset][:split_offset[*deref_offset]]@addr[:module[:func]]
H is Inline Hook, B is VEH Hook
Single character: A/B are little-endian/big-endian MBCS, C is UTF-8, W is UTF-16, I is UTF-32.
String: S is default ASCII string, Q is UTF-16, U is UTF-32, V is UTF-8.
F: Append newline after reading each string.
N: Ignore context.
Data offset for registers:
     * 32-bit EAX -4, ECX -8, EDX -C, EBX -10, ESP -14, EBP -18, ESI -1C, EDI -20
     * 64-bit RAX -C, RBX -14, RCX -1C, RDX -24, RSP -2C, RBP -34, RSI -3C, RDI -44, R8 -4C, R9 -54, R10 -5C, R11 -64, R12 -6C, R13 -74, R14 -7C, R15 -84
```

--------------------------------

### /api/ws/text/trans

Source: https://docs.lunatranslator.org/cht/apiservice.html

WebSocket endpoint that continuously streams all translation results.

```APIDOC
## WebSocket /api/ws/text/trans

### Description
Establishes a WebSocket connection that continuously streams all translation results as they are generated.

### Endpoint
/api/ws/text/trans
```

--------------------------------

### /api/ocr

Source: https://docs.lunatranslator.org/cht/apiservice.html

Performs Optical Character Recognition (OCR) on an image. Expects a JSON request with a Base64 encoded image.

```APIDOC
## POST /api/ocr

### Description
Performs Optical Character Recognition (OCR) on an image. The request must be a POST request with a JSON body containing the 'image' field, which holds the Base64 encoded image data.

### Method
POST

### Endpoint
/api/ocr

### Parameters
#### Request Body
- **image** (string) - Required - Base64 encoded image data.
```

--------------------------------

### Complex Duplicate Line Removal (HOOK Mode)

Source: https://docs.lunatranslator.org/cht/textprocess.html

Handles more complex scenarios where lines may repeat an inconsistent number of times, attempting to deduplicate accurately.

```text
恵麻さん……ううん、恵麻ははにかむように私の名前を呼ぶ。恵麻さん……ううん、恵麻ははにかむように私の名前を呼ぶ。恵麻さん……ううん、恵麻ははにかむように私の名前を呼ぶ。なんてニヤニヤしていると、恵麻さんが振り返った。私は恵麻さんの目元を優しくハンカチで拭う。私は恵麻さんの目元を優しくハンカチで拭う。
```

--------------------------------

### /api/translate

Source: https://docs.lunatranslator.org/cht/apiservice.html

Translates text using a specified or the fastest available translator. Returns the translator ID, name, and translation result.

```APIDOC
## POST /api/translate

### Description
Translates the provided text. If a translator ID is specified, it uses that translator; otherwise, it uses the fastest available translator. The response is in JSON format and includes the translator's ID, name, and the translation result.

### Method
POST

### Endpoint
/api/translate

### Parameters
#### Query Parameters
- **text** (string) - Required - The text to be translated.
- **id** (string) - Optional - The ID of the translator to use.
```

--------------------------------

### Remove Braces and Pronunciation Annotations

Source: https://docs.lunatranslator.org/cht/textprocess.html

Cleans text by removing pronunciation annotations within curly braces, often used in game scripts.

```text
「{恵麻/えま}さん、まだ{起き/おき}てる？」
```

```text
「{恵麻:えま}さん、まだ{起き:おき}てる？」
```

--------------------------------

### Remove Repeated Lines (HOOK Mode)

Source: https://docs.lunatranslator.org/cht/textprocess.html

Filters out entire lines that are repeated consecutively, suitable for text that is rapidly refreshed multiple times.

```text
恵麻さんは再び液タブへ視線を落とす。恵麻さんは再び液タブへ視線を落とす。恵麻さんは再び液タブへ視線を落とす。
```

--------------------------------

### Embedded Special Code Format

Source: https://docs.lunatranslator.org/cht/hooksettings.html

Defines the syntax for embedded hooks, specifying conversion options for Chinese characters and string handling. Use this to embed other HOOK or JIT special codes.

```plaintext
E[D][S][N|O]HOOKCODE
E is the marker for embedded, HOOKCODE is JIT special code or HOOK special code.
D: Convert Chinese characters to Japanese character set during writing.
S: Use the text extraction method specified by HOOKCODE during extraction.
N: Create a new string and swap the string pointer during writing.
O: Overwrite the original string during writing.
```

--------------------------------

### Character-by-Character Repetition Removal (HOOK Mode)

Source: https://docs.lunatranslator.org/cht/textprocess.html

Filters text where each subsequent character redraws all preceding characters, often seen when drawing characters one by one.

```text
恵麻恵麻さ恵麻さん恵麻さんは恵麻さんは再恵麻さんは再び恵麻さんは再び液恵麻さんは再び液タ恵麻さんは再び液タブ恵麻さんは再び液タブへ恵麻さんは再び液タブへ視恵麻さんは再び液タブへ視線恵麻さんは再び液タブへ視線を恵麻さんは再び液タブへ視線を落恵麻さんは再び液タブへ視線を落恵麻さんは再び液タブへ視線を落ととす恵麻さんは再び液タブへ視線を落とす。
```

--------------------------------

### Remove Repeated Characters (HOOK Mode)

Source: https://docs.lunatranslator.org/cht/textprocess.html

Filters out consecutively repeated characters, useful for text hooked from games where characters might be drawn multiple times.

```text
恵恵恵麻麻麻さささんんんははは再再再びびび液液液タタタブブブへへへ視視視線線線ををを落落落とととすすす。。。
```

--------------------------------

### Filter Non-Japanese Characters (Shift_JIS)

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes characters that cannot be encoded using the Shift_JIS character set, useful for Japanese games with garbled text.

```text
エマさんԟのイԠラストは全部大好き！
```

--------------------------------

### Unicode Normalization

Source: https://docs.lunatranslator.org/cht/textprocess.html

Normalizes Unicode characters to their equivalent forms, resolving issues with different representations of the same character.

```text
？？？（Ｉ ｇｕｅｓｓ ｈｅ ｄｏｅｓｎ’ｔ ｗａｎｔ ｔｏ ｔａｌｋ ｔｏ ｓｔｒａｎｇｅｒｓ．．．）
```

--------------------------------

### Substring Repetition Removal (HOOK Mode)

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes repeated substrings that occur due to functions being called repeatedly with decreasing string lengths.

```text
恵麻さんは再び液タブへ視線を落とす。麻さんは再び液タブへ視線を落とす。さんは再び液タブへ視線を落とす。んは再び液タブへ視線を落とす。は再び液タブへ視線を落とす。再び液タブへ視線を落とす。び液タブへ視線を落とす。液タブへ視線を落とす。タブへ視線を落とす。ブへ視線を落とす。へ視線を落とす。視線を落とす。線を落とす。を落とす。落とす。とす。す。。
```

--------------------------------

### Filter Characters Except Japanese Quotation Marks

Source: https://docs.lunatranslator.org/cht/textprocess.html

Keeps only Japanese quotation marks and their content, removing other characters.

```text
こなみ「ひとめぼれってやつだよね……」
```

--------------------------------

### Filter Newline Characters

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes newline characters. If the source language is not Japanese, newlines are replaced with spaces to prevent word merging.

```text


```

--------------------------------

### Filter Control Characters

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes ASCII control characters from the text.

```text

```

--------------------------------

### Filter Digits

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes all numeric digits (0-9) from the text.

```text
0123456789
```

--------------------------------

### Filter English Letters

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes all English alphabet characters (A-Z and a-z) from the text.

```text
ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
```

--------------------------------

### Filter English Punctuation

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes standard English punctuation marks from the text.

```text
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
```

--------------------------------

### Filter Angle Brackets (HTML Tags)

Source: https://docs.lunatranslator.org/cht/textprocess.html

Removes HTML tags enclosed in angle brackets, commonly found in text hooked from web-based game engines like TyranoScript.

```text
<div>
```

```text
</div>
```

```text
<div id="dsds">
```
Tokens:
Raw