Skip to content

ArabicIME/arabic-ime

Repository files navigation

بسم الله الرحمان الرحيم

In the name of Allah, the Ever Merciful, Dispenser of Mercy

Arabic (including its dialects) is a language spoken by roughly 440 million native speakers. It is also the language of the Qur'an which extends the importance of this language to almost a quarter of the world's population. Though one of the main purposes of IMEs are to cater to languages with characters that exceed the number of keys on a keyboard, many people, including native arabic speakers do not have access to keyboards with Arabic characters. This is the case even though arabic keyboard layouts exist. In order to ease the lives of everyone who needs to type in Arabic using non-Arabic keyboard layouts.

arabic-ime is an Arabic IME based on the PIME project

Build status GitHub release

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

How to Build

  • Get source from github.

    git clone https://github.com/ArabicIME/arabic-ime.git
    cd arabic-ime
    
  • Use the following CMake commands to generate Visual Studio project.

    cmake -G "Visual Studio 16 2019" -A Win32 . -B "build"
    cmake -G "Visual Studio 16 2019" -A x64 . -B "build64"
    
  • Open a generated project with Visual Studio and build it. You'll need to build both for 64-bit.

Install

  • Build release version of PIMETextService.dll (both 64 bit and 32 bit versions are required).
  • Compile <path to arabic-ime>\installer\installer.nsi with NSIS.
  • Run the installer

Uninstall

  • Run the uninstaller C:\Program Files (x86)\PIME\Uninstall.exe

Quick testing of the python code

  • Instead of copying python over to C:\Program Files(x86)\PIME, create a hardlink to your checked out python folder. Use the following in the PIME directory:

    mklink /J python <path to repo>\arabic-ime\python
    
  • Restart PIMELauncher to test your changes.

TSF References

Windows ACL (Access Control List) references

Bug Report

Please report any issue to here.

About

An Arabic input method editor

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors