https://github.com/varnamproject/varnam-windows
Type Indian languages easily on Windows!
https://github.com/varnamproject/varnam-windows
Last synced: over 1 year ago
JSON representation
Type Indian languages easily on Windows!
- Host: GitHub
- URL: https://github.com/varnamproject/varnam-windows
- Owner: varnamproject
- License: mit
- Created: 2023-11-10T18:22:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-21T04:05:31.000Z (over 2 years ago)
- Last Synced: 2024-04-14T09:04:37.496Z (over 2 years ago)
- Language: C++
- Size: 35.2 MB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VarnamIME for Windows
Easily type Indian languages on Windows using [Varnam transliteration engine](https://varnamproject.github.io/).
> This project is a hard-fork of [ime-rs](https://github.com/saschanaz/ime-rs) extended to support plugging [Varnam](https://github.com/varnamproject/govarnam) as the transliteration engine on native Windows IME.
---
### Installation
Download the latest executable "Varnam-Windows-Install.exe" from [Releases](https://github.com/varnamproject/varnam-windows/releases).
> [!NOTE]
Running the setup executable will prompt you for `Administrator` permissions, this is required to register Varnam as an IME service.
The Setup Wizard will guide you through choosing the installation path, choosing languages, and setting the IME environment up.
### Using Varnam
Varnam's Setup Wizard will automatically register the input method in your operating system. If "Varnam Windows" does not show up in your input language section drawer (`Win + Space`), follow these steps:
1. Open Settings.
2. Navigate to `Time & Language`, then select `Language`.
3. Click on `Add a language` and search for the desired language from the search window pop up.
4. Click on the installed language and select `Options`.
5. In the `Keyboard` options, click on `Add a keyboard` and select `Varnam Windows`.
6. `Varnam Windows` should now appear as an input method in your language selection drawer.
Make sure to enable Varnam by switching the toggle button in your Task Bar.
## Build
**Prerequisites:**
- Windows 64 bit
- [Visual Studio](https://visualstudio.microsoft.com/downloads/) (Including command-line utils: `lib.exe` and `gendef.exe`)
- [Rust](https://www.rust-lang.org/) and [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
- [Go](https://go.dev/)
- [msys64](https://www.msys2.org/)
- [PowerShell](https://www.microsoft.com/store/productId/9MZ1SNWT0N5D)
### Setup:
**1.** Open the project **Varnam Windows** by opening the file `cpp\VarnamWindows.sln` in Visual Studio.
**2.** Build and compile the bundle:
```
Build -> Build Varnam Windows
```
This should:
1. Build Govarnam, Rust native IME, and the SampleIME-cpp in sequence.
2. Build the necessary DLL, LIB, and PDB files into the `varnam-windows\cpp\x64\Debug` directory.
3. Fetch the latest language schemes from https://github.com/varnamproject/schemes.
4. Import words from the VLF files into the language schemes.
5. Setup language choice configuration.
**3.** Open "Command Prompt" as Administrator, navigate to `varnam-windows\cpp\x64\Debug` and register the DLL to install Varnam as the native IME for the supported languages.
```
regsvr32 "Varnam Windows.dll"
```
To unregister the DLL, run:
```
regsvr32 /u "Varnam Windows.dll"
```
**4.** Compile the `varnam-windows.iss` using [Inno Setup](https://jrsoftware.org/isinfo.php) to package and generate the Varnam Setup Wizard (`Varnam Windows Install.exe`).
---