osfans/trime

Trime

Rime IME for Android

English | 简体中文 | 繁體中文

About

Trime is originally a frontend of open-source Android Traditional Chinese IME, based on RIME input method framework and written in Java/Kotlin with JNI. It is designed to protect the native language of various local dialects of Chinese and is a universal shape-based and phonetic-based input method platform.

Documentation

Download

• Stable Channel
  

• Nightly Channel Download

• Canary Channel Download

• Configurations rimerc

History

TRIME is the abbreviation of Tongwen RIME or ThaeRv Input Method.

From the beginning, TRIME was written for TaeRv Pinyin, and named TaeRv Input Method (泰如输入法).

Then, we created an input method platform with some code tables, such as Wu dialect (吴语). We renamed it to Chinese Character Dialect Input Method (汉字方言输入法).

Later, it supports Wubi and Liangbi and other shape-based input method, we branded it Tongwen Input Method Platform 2.0 (同文输入法平台 2.0), which implies that the phonetic-based and shape-based input method on one platform, while dialects and Mandrain share one kind of characters.

Benefit from the librime project by JNI, we are now in version 3.0 of TRIME aka Tongwen Input Method (同文输入法).

Your are now welcome to contribution ~ !

Getting Started for developer

Prepare

Requirements:

• Android SDK and Android NDK

  • If you are new to Android development, please install Android Studio.

• JDK (OpenJDK) 17

• Python 3 (required by OpenCC to generate dictionary text files)

Prerequisites for Windows

Symbolic links will be created according to current build configurations, developers need:

• Enable Developer Mode so that symlinks can be created without administrator privilege.

• Enable symlink support for git:

  git config --global core.symlinks true
  

If you cannot or wouldn't like to enable anything, it doesn't matter. Copying will be used instead when error on creating symbolic links.

Build

1. Clone this project and fetch all submodules:

git clone [email protected]:osfans/trime.git
git submodule update --init --recursive
# use partial clone to save time
git submodule update --init --recursive --filter=blob:none

2. Debug version without signature:

# On Linux or macOS
make debug

# On Windows
.\gradlew assembleDebug

3. Release version with signture:

Create keystore.properties file which contains following contents for signing information:

storePassword=myStorePassword
keyPassword=mykeyPassword
keyAlias=myKeyAlias
storeFile=myStoreFileLocation

Then, you may run:

# On Linux or macOS
make release

# On Windows
.\gradlew assembleRelease

Troubleshooting

Target "boost_log_setup" links to target "Boost::coroutine" but the target was not found.

Run make clean on Linux or macOS, or run .\gradlew clean on Windows.

Other issues:

1. Try make clean
2. Make sure your repo is up-to-date. If one or more submodules are modified, also make sure they are compatible with the current version.
3. If the problem still exists(very unlikely), try to make a new clone.
4. Check if this is there is an issue/PR related to your problem. If yes, try their solutions.
5. If none of them works, you may make an issue to ask for help.(optional)

Acknowledgments

• Developer: osfans
• Contributors: boboIqiqi、Bambooin、senchi96、heiher、abay、iovxw、huyz-git、tumuyan、WhiredPlanck、nopdan...
• Wiki Editors: xiaoqun2016、boboIqiqi...
• Translators: 天真可爱的满满 (Chinese Traditional), 点解 (English) ...
• Keyboard Designers: 天真可爱的满满、皛筱晓小笨鱼、吴琛 11、熊猫阿 Bo、默默ㄇㄛ ˋ...
• Donations: See QR Code in Releases
• Community: Netizens who feedback in Issues、QQ Group (811142286)、QQ Group (224230445)、Tieba、Google Play、Telegram...
• Projects: RIME、OpenCC、Android Traditional Chinese IME and so on.

Third Party Libraries

• Boost C++ Libraries (Boost Software License)
• darts-clone (New BSD License)
• LevelDB (New BSD License)
• libiconv (LGPL License)
• marisa-trie (BSD License)
• glog (New BSD License)
• OpenCC (Apache License 2.0)
• RIME (BSD License)
• snappy(BSD License)
• utfcpp (Boost Software License)
• yaml-cpp (MIT License)
• Android Traditional Chinese IME (Apache License 2.0)