KPS files

Used by:

Keyman Developer.

Description:

A .KPS file is a Keyman package source file.

Details:

A .KPS file is created using the Package Editor in Keyman Developer. It specifies what files are to be included in the package. It is compiled into a Keyman Package file (.KMP).

Distributed with keyboard:

No. This is a development file and should not be distributed.

File format

A keyboard package file contains one or more keyboards, along with readme files, fonts (if your keyboard requires a custom font), and any other files you wish to include. You should create a package file to bundle your keyboard with fonts and help into a simple, single file that is easy for an end-user to install.

A lexical model package file contains a single lexical model, optionally also fonts and/or documentation.

In addition to your own files, the package will contain a metadata file named "kmp.json", which lists the details Keyman requires for installation. The package file is a ZIP compatible archive.

The optional <Strings> section of the file can be included to customise the text in the bootstrap installer. The default strings are found in the file: strings.xml. You can add your own strings for a given package which are used when compiling as a bundled installer.

Keyman for Windows

Keyman for Windows can install keyboard package files, including installing fonts, creating Start Menu shortcuts, and adding appropriate registry entries for uninstallation.

On Windows, the context menu for a package file has one additional entry: "Install".

Keyman for macOS

Keyman for macOS can install package files with fonts and keyboards, and shortcuts in the package will be available through the keyboard's entry in Keyman Configuration.

Keyman for Linux

Keyman for Linux can install package files with fonts and keyboards.

Keyman for Android and Keyman for iPhone and iPad

Keyman mobile applications can install the same package files as Keyman for Windows; the package must contain a touch-compatible keyboard (keyboard file with a .js extension).

Package file contents

A package can have a variety of different files contained within. The following files and file types are recognized by the package installer:

*.kmx (Keyman for Windows, Linux, and macOS only)

Keyboard files. Each of these will be installed. Keyman Configuration will not allow installation or uninstallation of a single keyboard from a package. They will always be treated as a group for installation and uninstallation.

*.kvk (Keyman for Windows, Linux, and macOS only)

On Screen Keyboard files, associated with each keyboard file.

*.js (mobile only)

Touch layout Keyboard files. When Keyman mobile applications install a keyboard package, all included keyboards will be installed as a group. With Keyman Developer 10+, the keyboard version information is in kmp.json, and no longer within the JS file names.

welcome.htm

Introductory help for the keyboard, HTML format. This will normally be displayed when the package is installed by the user, and is also the entry point for help when accessed via Keyman's help system or Keyman Configuration.

readme.htm

Displayed before a package is installed, together with brief metadata about the package, to allow the user to determine if they wish to continue installation of the package.

kmp.inf (required by Keyman 9 and earlier versions)

A Windows .ini format file that lists each of the files in the package, together with metadata.

kmp.json

A JSON format file containing metadata for the keyboard package such as package version, keyboard versions, and listing each of the files in the package. For more explanation of the structure of the JSON file, please read the metadata documentation.

*.ttf, *.otf, *.ttc

Truetype font files that will be installed with the package, and uninstalled when the package is removed. On mobile, these fonts will be available only within the Keyman app and the on-screen-keyboard, not in other apps.

Share the package file

The best way to distribute a package is to distribute it through Keyman Cloud, which makes it available on keyman.com and in the Keyboard Download interface inside the Keyman apps:

• Share a keyboard package
• Share a lexical model package

It is also possible to share a .kmp package through other means. Once the keyboard package .kmp file is created, you can share it via external storage devices (USB drive, SD card, etc). You can also share the package file via a cloud storage system (Google Drive, Dropbox or similar service), then share the link to your device via text, note or email. Alternatively, you can upload the .kmp file to a public facing website.