My RIME
Chinese IME powered by RIME.
If you want to distribute your own IME, see customize.
If you want to deploy schemas dynamically (online, like how you deploy in Desktop/Mobile platforms), see deploy.
Self host
Download latest artifact built by GitHub Actions.
Development workflow
My RIME can be built on Linux.
Install node
You may use nvm to install node.
Install pnpm and dev dependencies
npm i -g pnpm
pnpm i
Install RIME dependencies
apt install libboost-dev \
libboost-filesystem-dev \
libboost-regex-dev \
libboost-system-dev \
libyaml-cpp-dev \
libleveldb-dev \
libmarisa-dev \
libopencc-dev
Install emsdk
https://emscripten.org/docs/getting_started/downloads.html
Get submodule
It's not recommended to clone recursively, as many boost libs are not needed.
pnpm run submodule
Get font
Uncommon characters are rendered using 花园明朝.
pnpm run font
Build wasm
pnpm run native
pnpm run schema
export ENABLE_LOGGING=ON # optional
pnpm run lib
pnpm run wasm
Run develop server
pnpm run dev
The app is accessible at http://localhost:5173
Optionally, go to http://localhost:5173/?debug=on or turn on Advanced
switch so that you can send raw key sequences to librime,
e.g. {Shift+Delete}
, {Release+a}
. This feature is better used when you set ENABLE_LOGGING=ON
in the previous step.
Lint
pnpm run lint:fix
Check type
pnpm run check
Build
pnpm run build
Test
pnpm run test
Preview
pnpm run preview
Deploy (maintainer only)
# publish IMEs
declare -a packages=(
... # targets output by pnpm run schema
)
for package in "${packages[@]}"; do
pushd public/ime/$package
npm publish
popd
done
# set VERSION to avoid CDN and browser caching old version
export LIBRESERVICE_CDN=https://cdn.jsdelivr.net/npm/@libreservice/my-rime@VERSION/dist/
export RIME_CDN=https://cdn.jsdelivr.net/npm/@rime-contrib/
vercel build --prod
npm publish
vercel deploy --prebuilt --prod
Docker
docker build \
--build-arg ENABLE_LOGGING=ON \
-t my-rime .
docker run --name my-rime -d my-rime
Let's say the IP address of the container is 172.17.0.2 (got by docker inspect my-rime | grep IPAddress
), then My RIME is accessible at http://172.17.0.2/.
License
AGPLv3+