Open Chinese Convert 開放中文轉換

Introduction 介紹

Open Chinese Convert (OpenCC, 開放中文轉換) is an opensource project for conversions between Traditional Chinese, Simplified Chinese and Japanese Kanji (Shinjitai). It supports character-level and phrase-level conversion, character variant conversion and regional idioms among Mainland China, Taiwan and Hong Kong. This is not translation tool between Mandarin and Cantonese, etc.

中文簡繁轉換開源項目，支持詞彙級別的轉換、異體字轉換和地區習慣用詞轉換（中國大陸、臺灣、香港、日本新字體）。不提供普通話與粵語的轉換。

Discussion (Telegram): https://t.me/open_chinese_convert

Features 特點

• 嚴格區分「一簡對多繁」和「一簡對多異」。
• 完全兼容異體字，可以實現動態替換。
• 嚴格審校一簡對多繁詞條，原則爲「能分則不合」。
• 支持中國大陸、臺灣、香港異體字和地區習慣用詞轉換，如「裏」「裡」、「鼠標」「滑鼠」。
• 詞庫和函數庫完全分離，可以自由修改、導入、擴展。

Installation 安裝

Package Managers 包管理器

• Debian
• Ubuntu
• Fedora
• Arch Linux
• macOS (Homebrew)
• WinGet (winget install BYVoid.OpenCC) - WIP
• Bazel
• Node.js
• Python
• More (Repology)

Prebuilt 預編譯

• Windows (x86_64): OpenCC-1.2.1-alpha2 (SHA-256)

This is a Windows release intended for WinGet distribution. For details, see doc/windows-winget-release.md.

Usage 使用

Online demo 線上轉換展示

https://opencc.js.org/converter?config=s2t

Node.js

npm npm install opencc

JavaScript

const OpenCC = require('opencc');
const converter = new OpenCC('s2t.json');
converter.convertPromise("汉字").then(converted => {
  console.log(converted);  // 漢字
});

TypeScript

import { OpenCC } from 'opencc';
async function main() {
  const converter: OpenCC = new OpenCC('s2t.json');
  const result: string = await converter.convertPromise('汉字');
  console.log(result);
}

See demo.js and ts-demo.ts.

Python

pip install opencc (Windows, Linux, macOS)

import opencc
converter = opencc.OpenCC('s2t.json')
converter.convert('汉字')  # 漢字

C++

#include "opencc.h"

int main() {
  const opencc::SimpleConverter converter("s2t.json");
  converter.Convert("汉字");  // 漢字
  return 0;
}

Full example with Bazel

C

#include "opencc.h"

int main() {
  opencc_t opencc = opencc_open("s2t.json");
  const char* input = "汉字";
  char* converted = opencc_convert_utf8(opencc, input, strlen(input));  // 漢字
  opencc_convert_utf8_free(converted);
  opencc_close(opencc);
  return 0;
}

Document 文檔: https://opencc.byvoid.com/docs/

Command Line

• opencc --help
• opencc_dict --help
• opencc_phrase_extract --help

Others (Unofficial)

• Swift (iOS): SwiftyOpenCC
• iOSOpenCC (pod): iOSOpenCC
• Java: opencc4j
• Android: android-opencc
• PHP: opencc4php
• Pure JavaScript: opencc-js
• WebAssembly:
  • opencc-wasm (website)
  • wasm-opencc
• Browser Extension: opencc-extension
• Go (Pure): OpenCC for Go
• Dart (native-assets): opencc-dart

Configurations 配置文件

預設配置文件

• s2t.json Simplified Chinese to Traditional Chinese 簡體到繁體
• t2s.json Traditional Chinese to Simplified Chinese 繁體到簡體
• s2tw.json Simplified Chinese to Traditional Chinese (Taiwan Standard) 簡體到臺灣正體
• tw2s.json Traditional Chinese (Taiwan Standard) to Simplified Chinese 臺灣正體到簡體
• s2hk.json Simplified Chinese to Traditional Chinese (Hong Kong variant) 簡體到香港繁體
• hk2s.json Traditional Chinese (Hong Kong variant) to Simplified Chinese 香港繁體到簡體
• s2twp.json Simplified Chinese to Traditional Chinese (Taiwan Standard) with Taiwanese idiom 簡體到繁體（臺灣正體標準）並轉換爲臺灣常用詞彙
• tw2sp.json Traditional Chinese (Taiwan Standard) to Simplified Chinese with Mainland Chinese idiom 繁體（臺灣正體標準）到簡體並轉換爲中國大陸常用詞彙
• t2tw.json Traditional Chinese (OpenCC Standard) to Taiwan Standard 繁體（OpenCC 標準）到臺灣正體
• hk2t.json Traditional Chinese (Hong Kong variant) to Traditional Chinese 香港繁體到繁體（OpenCC 標準）
• t2hk.json Traditional Chinese (OpenCC Standard) to Hong Kong variant 繁體（OpenCC 標準）到香港繁體
• t2jp.json Traditional Chinese Characters (Kyūjitai) to New Japanese Kanji (Shinjitai) 繁體（OpenCC 標準，舊字體）到日文新字體
• jp2t.json New Japanese Kanji (Shinjitai) to Traditional Chinese Characters (Kyūjitai) 日文新字體到繁體（OpenCC 標準，舊字體）
• tw2t.json Traditional Chinese (Taiwan standard) to Traditional Chinese 臺灣正體到繁體（OpenCC 標準）

指定配置文件

通过环境变量OPENCC_DATA_DIR加载指定路径下的配置文件

OPENCC_DATA_DIR=/path/to/your/config/dir opencc --help

Experimental Plugins 試驗性插件

OpenCC 現已支援外部 C++ 分詞插件。當前第一個插件為 opencc-jieba， 可通過 s2twp_jieba.json、tw2sp_jieba.json 等插件配置啓用。

OpenCC now supports external C++ segmentation plugins. The first plugin is opencc-jieba, which can be enabled through plugin-backed configs such as s2twp_jieba.json and tw2sp_jieba.json.

注意：

• 該插件機制目前仍為試驗性功能。
• jieba 插件是可選組件，預設 OpenCC 構建、Python 套件和 Node.js 套件都不要求它。
• opencc-jieba 額外依賴 cppjieba 及其配套詞典資源，這些依賴僅在構建或分發該插件時需要。
• 在下一次正式發布版本之前，插件 ABI 仍可能發生變化，不應視為穩定介面。
• 我們預計從下一次正式發布版本開始，將插件 ABI 視為穩定介面。
• Windows 下插件必須與宿主 OpenCC 二進位使用 ABI 相容的工具鏈／執行時構建；MSVC 與 MinGW 產物不支援混用。

Notes:

• The plugin mechanism is currently experimental.
• The jieba plugin is optional and is not required for the default OpenCC build, Python package, or Node.js package.
• opencc-jieba additionally depends on cppjieba and its dictionary resources. These dependencies are only needed when building or distributing the plugin itself.
• The plugin ABI may still change before the next formal OpenCC release and should not yet be treated as stable.
• We expect to treat the plugin ABI as stable starting with the next formal OpenCC release.
• On Windows, plugins must be built with an ABI-compatible toolchain/runtime as the host OpenCC binary. Mixing MSVC-built hosts with MinGW-built plugins, or the reverse, is unsupported.

Build 編譯

Build with CMake

Linux & macOS

g++ 4.6+ or clang 3.2+ is required.

make

Windows Visual Studio:

build.cmd

Build with Bazel

bazel build //:opencc

Test 測試

Linux & macOS

make test

Windows Visual Studio:

test.cmd

Test with Bazel

bazel test --test_output=all //src/... //data/... //python/... //test/...

Benchmark 基準測試

make benchmark

Example results (from Github CI):

1: ------------------------------------------------------------------
1: Benchmark                        Time             CPU   Iterations
1: ------------------------------------------------------------------
1: BM_Initialization/hk2s        1.56 ms         1.56 ms          442
1: BM_Initialization/hk2t       0.144 ms        0.144 ms         4878
1: BM_Initialization/jp2t       0.260 ms        0.260 ms         2604
1: BM_Initialization/s2hk        23.8 ms         23.8 ms           29
1: BM_Initialization/s2t         25.6 ms         25.6 ms           28
1: BM_Initialization/s2tw        24.0 ms         23.9 ms           30
1: BM_Initialization/s2twp       24.6 ms         24.6 ms           28
1: BM_Initialization/t2hk       0.052 ms        0.052 ms        12897
1: BM_Initialization/t2jp       0.141 ms        0.141 ms         5012
1: BM_Initialization/t2s         1.30 ms         1.30 ms          540
1: BM_Initialization/tw2s        1.39 ms         1.39 ms          529
1: BM_Initialization/tw2sp       1.69 ms         1.69 ms          426
1: BM_Initialization/tw2t       0.089 ms        0.089 ms         7707
1: BM_Convert2M                   582 ms          582 ms            1
1: BM_Convert/100                1.07 ms         1.07 ms          636
1: BM_Convert/1000               11.0 ms         11.0 ms           67
1: BM_Convert/10000               113 ms          113 ms            6
1: BM_Convert/100000             1176 ms         1176 ms            1

Projects using OpenCC 使用 OpenCC 的項目

Please update if your project is using OpenCC.

• ibus-pinyin
• fcitx
• rimeime
• libgooglepinyin
• ibus-libpinyin
• alfred-chinese-converter
• GoldenDict
• China Biographical Database Project (CBDB)

License 許可協議

Apache License 2.0

Third Party Library 第三方庫

• darts-clone BSD License
• marisa-trie BSD License
• tclap MIT License
• rapidjson MIT License
• Google Test BSD License
• cppjieba MIT License
  • Optional dependency used by the experimental opencc-jieba plugin.
  • 試驗性 opencc-jieba 插件使用的可選依賴。

All these libraries are statically linked by default.

Change History 版本歷史

• NEWS

Links 相關鏈接

• Introduction 詳細介紹 https://github.com/BYVoid/OpenCC/wiki/%E7%B7%A3%E7%94%B1
• 現代漢語常用簡繁一對多字義辨析表 http://ytenx.org/byohlyuk/KienxPyan

Contributors 貢獻者

• BYVoid
• 佛振
• Peng Huang
• LI Daobing
• Kefu Chai
• Kan-Ru Chen
• Ma Xiaojun
• Jiang Jiang
• Ruey-Cheng Chen
• Paul Meng
• Lawrence Lau
• 瑾昀
• 內木一郎
• Marguerite Su
• Brian White
• Qijiang Fan
• LEOYoon-Tsaw
• Steven Yao
• Pellaeon Lin
• stony
• steelywing
• 吕旭东
• Weng Xuetian
• Ma Tao
• Heinz Wiesinger
• J.W
• Amo Wu
• Mark Tsai
• Zhe Wang
• sgqy
• Qichuan (Sean) ZHANG
• Flandre Scarlet
• 宋辰文
• iwater
• Xpol Wan
• Weihang Lo
• Cychih
• kyleskimo
• Ryuan Choi
• Prcuvu
• Tony Able
• Xiao Liang
• Frank Lin

Please feel free to update this list if you have contributed OpenCC.