https://github.com/easyime/pime

Develop input methods for Windows easily with Python and node.js
https://github.com/easyime/pime

chinese ime tsf windows-10

Last synced: about 1 year ago
JSON representation

Develop input methods for Windows easily with Python and node.js

• Host: GitHub
• URL: https://github.com/easyime/pime
• Owner: EasyIME
• License: other
• Created: 2014-08-27T19:10:24.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-12-06T01:17:44.000Z (over 1 year ago)
• Last Synced: 2025-04-11T04:57:54.154Z (about 1 year ago)
• Topics: chinese, ime, tsf, windows-10
• Language: Python
• Homepage:
• Size: 110 MB
• Stars: 1,382
• Watchers: 84
• Forks: 226
• Open Issues: 342
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Authors: AUTHORS.txt

Awesome Lists containing this project

README

          
# PIME

[![Build status](https://ci.appveyor.com/api/projects/status/ju8c225nt9qgxeee?svg=true)](https://ci.appveyor.com/project/EasyIME/PIME)

[![GitHub release](https://img.shields.io/github/release/EasyIME/PIME.svg)](https://github.com/EasyIME/PIME/releases)

Implement input methods easily for Windows via Text Services Framework:

*   LibIME contains a library which aims to be a simple wrapper for Windows Text Service Framework (TSF).

*   PIMETextService contains an backbone implementation of Windows text service for using libIME.

*   The python server part requires python 3.x and pywin32 package.

All parts are licensed under GNU LGPL v2.1 license.

# Development

## Tool Requirements

*   [CMake](http://www.cmake.org/) >= 3.0

*   [Visual Studio 2019](https://visualstudio.microsoft.com/vs)

*   [git](http://windows.github.com/)

## How to Build

*   Get source from github.

        git clone https://github.com/EasyIME/PIME.git

        cd PIME

        git submodule update --init

*   Use the following CMake commands to generate Visual Studio project.

        cmake -G "Visual Studio 16 2019" -A Win32 

        cmake -G "Visual Studio 16 2019" -A x64 

*   Open generated project with Visual Studio and build it.

## TSF References

*   [Text Services Framework](http://msdn.microsoft.com/en-us/library/windows/desktop/ms629032%28v=vs.85%29.aspx)

*   [Guidelines and checklist for IME development (Windows Store apps)](http://msdn.microsoft.com/en-us/library/windows/apps/hh967425.aspx)

*   [Input Method Editors (Windows Store apps)](http://msdn.microsoft.com/en-us/library/windows/apps/hh967426.aspx)

*   [Third-party input method editors](http://msdn.microsoft.com/en-us/library/windows/desktop/hh848069%28v=vs.85%29.aspx)

*   [Strategies for App Communication between Windows 8 UI and Windows 8 Desktop](http://software.intel.com/en-us/articles/strategies-for-app-communication-between-windows-8-ui-and-windows-8-desktop)

*   [TSF Aware, Dictation, Windows Speech Recognition, and Text Services Framework. (blog)](http://blogs.msdn.com/b/tsfaware/?Redirected=true)

*   [Win32 and COM for Windows Store apps](http://msdn.microsoft.com/en-us/library/windows/apps/br205757.aspx)

*   [Input Method Editor (IME) sample supporting Windows 8](http://code.msdn.microsoft.com/windowsdesktop/Input-Method-Editor-IME-b1610980)

## Windows ACL (Access Control List) references

*   [The Windows Access Control Model Part 1](http://www.codeproject.com/Articles/10042/The-Windows-Access-Control-Model-Part-1#SID)

*   [The Windows Access Control Model: Part 2](http://www.codeproject.com/Articles/10200/The-Windows-Access-Control-Model-Part-2#SidFun)

*   [Windows 8 App Container Security Notes - Part 1](http://recxltd.blogspot.tw/2012/03/windows-8-app-container-security-notes.html)

*   [How AccessCheck Works](http://msdn.microsoft.com/en-us/library/windows/apps/aa446683.aspx)

*   [GetAppContainerNamedObjectPath function (enable accessing object outside app containers using ACL)](http://msdn.microsoft.com/en-us/library/windows/desktop/hh448493)

*   [Creating a DACL](http://msdn.microsoft.com/en-us/library/windows/apps/ms717798.aspx)

# Install

*   Copy `PIMETextService.dll` to C:\Program Files (X86)\PIME\x86\.

*   Copy `PIMETextService.dll` to C:\Program Files (X86)\PIME\x64\.

*   Copy the folder `python` to `C:\Program Files (X86)\PIME\`

*   Copy the folder `node` to `C:\Program Files (X86)\PIME\`

*   Use `regsvr32` to register `PIMETextService.dll`. 64-bit system need to register both 32-bit and 64-bit `PIMETextService.dll`

        regsvr32 "C:\Program Files (X86)\PIME\x86\PIMETextService.dll" (run as administrator)

        regsvr32 "C:\Program Files (X86)\PIME\x64\PIMETextService.dll" (run as administrator)

*   NOTICE: the `regsvr32` command needs to be run as Administrator. Otherwise you'll get access denied error.

*   In Windows 8, if you put the dlls in places other than C:\Windows or C:\Program Files, they will not be accessible in metro apps.

# Uninstall

*   Use `regsvr32` to unregister `PIMETextService.dll`. 64-bit system need to unregister both 32-bit and 64-bit `PIMETextService.dll`

        regsvr32 /u "C:\Program Files (X86)\PIME\x86\PIMETextService.dll" (run as administrator)

        regsvr32 /u "C:\Program Files (X86)\PIME\x64\PIMETextService.dll" (run as administrator)

*   Remove `C:\Program Files (X86)\PIME`

*   NOTICE: the `regsvr32` command needs to be run as Administrator. Otherwise you'll get access denied error.

# Bug Report

Please report any issue to [here](https://github.com/EasyIME/PIME/issues).