https://github.com/easyime/nime
Implement input methods easily for Windows with nodejs
https://github.com/easyime/nime
Last synced: about 1 year ago
JSON representation
Implement input methods easily for Windows with nodejs
- Host: GitHub
- URL: https://github.com/easyime/nime
- Owner: EasyIME
- Created: 2016-02-02T17:35:54.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-22T06:52:26.000Z (about 9 years ago)
- Last Synced: 2025-03-25T05:51:24.517Z (about 1 year ago)
- Language: JavaScript
- Size: 180 KB
- Stars: 17
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
NIME
=============
[![npm][npm-image]][npm-url] [![Build Status][travis-ci-image]][travis-ci-url] [![Coveralls][coveralls-img]][coveralls-url]
Implement input methods easily for Windows with nodejs. It is another [PIME](https://github.com/EasyIME/PIME) server side.
## Require
#### PIME
Install PIME first. There are two ways to install.
- Install via [installer](https://github.com/EasyIME/PIME/releases)
- Build the PIME source code and register `PIMETextService.dll`. Please see [this](https://github.com/EasyIME/PIME#install) for more detail
| | PIME >= 0.14 && PIME <= 0.15 | PIME >= 0.16 |
| ------- | ---------------------------- | ------------ |
| Version | <= 0.3 | >= 0.4 |
There are `emojime` in PIME now. You can copy [emojime](https://github.com/EasyIME/emojime) into `example` folder for testing.
#### Node
- Node v6.x
## Development
- `npm i`
- `npm start`
It would start [meow](/example/meow/README.md) example server to help develop core library.
You can copy [emojime](https://github.com/EasyIME/emojime) into `example` folder for testing.
## Usage
```
npm install nime
```
> This is WIP project. You can see example in `./example`.
`ime.json` is to configure IME.
Example for implementing IME.
- [reduce-based](/example/meow/README.md): It uses the `textReducer` and `response` function to handle text and request.
## Reference
- [PIME](https://github.com/EasyIME/PIME)
- [Virtual-Key Codes](https://msdn.microsoft.com/zh-tw/library/windows/desktop/dd375731%28v=vs.85%29.aspx)
## License
The MIT License (MIT)
Copyright (c) 2016 Lee < jessy1092@gmail.com >
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[npm-image]: https://img.shields.io/npm/v/nime.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/nime
[travis-ci-image]: https://img.shields.io/travis/EasyIME/NIME.svg?style=flat-square
[travis-ci-url]: https://travis-ci.org/EasyIME/NIME
[coveralls-img]: https://img.shields.io/coveralls/EasyIME/NIME.svg?style=flat-square
[coveralls-url]: https://coveralls.io/github/EasyIME/NIME