trime

<!--
SPDX-FileCopyrightText: 2015 - 2026 Rime community

SPDX-License-Identifier: GPL-3.0-or-later
-->

# Trime

Rime IME for Android

![build](https://github.com/osfans/trime/actions/workflows/commit-ci.yml/badge.svg?branch=develop)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![GitHub release](https://img.shields.io/github/release/osfans/trime.svg)](https://github.com/osfans/trime/releases)
[![F-Droid release](https://img.shields.io/f-droid/v/com.osfans.trime.svg)](https://f-droid.org/packages/com.osfans.trime)
[![Latest build](https://img.shields.io/github/last-commit/osfans/trime.svg)](https://github.com/osfans/trime/releases/tag/nightly)

English | [简体中文](README_sc.md) | [繁體中文](README_tc.md)

## About

Trime is an Android input method frontend built on the [RIME] input method engine via JNI and written in Kotlin. It originated from the open-source [Android Traditional Chinese IME] project. It supports Android 8.0 and later, and is designed to help preserve the native languages of Chinese dialects while providing a universal platform for shape-based and phonetic-based input methods.

[Documentation](https://github.com/osfans/trime/wiki)

## Download

- Stable Channel <br>
  [<img alt='Get it on F-Droid' src='https://fdroid.gitlab.io/artwork/badge/get-it-on.png' height='80px'/>](https://f-droid.org/packages/com.osfans.trime)

- Nightly Channel [Download](https://github.com/osfans/trime/releases/tag/nightly)

- Canary Channel [Download](https://github.com/osfans/trime/actions)

- Configurations [rimerc](https://github.com/Bambooin/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 supported Wubi, Liangbi, and other shape-based input methods, and we branded it [_Tongwen Input Method Platform 2.0 (同文输入法平台 2.0)_](https://github.com/osfans/trime-legacy), which implies that phonetic-based and shape-based input methods share one platform, while dialects and Mandarin share a common set of characters.

Thanks to the [librime](https://github.com/rime/librime) project and JNI, we are now at version 3.x of TRIME, also known as _Tongwen Input Method (同文输入法)_.

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Getting Started for developer

### Prepare

#### Requirements:

- Android SDK and Android NDK
  * If you are new to Android development, please install [Android Studio](https://developer.android.com/studio). It will install and configure the required SDK, NDK, and CMake versions.

- JDK (OpenJDK) 17
- Python 3 (required by OpenCC to generate dictionary text files)

#### Prerequisites for Windows

Symbolic links will be created according to current buil