Skip to content

Latest commit

 

History

History
108 lines (92 loc) · 9.86 KB

README.md

File metadata and controls

108 lines (92 loc) · 9.86 KB
Raw

AnySoftKeyboard Add-On Packs

master latest build: CircleCI

    Gitter chat

This repo holds the Add-On API module and all the official language packs and themes for AnySoftKeyboard (in a mono-repo style). Each language is a set of two modules, pack and apk. pack is an Android library that holds all the information about the language pack (keyboards, dictionaries, receivers, etc.), while apk bundles that into an installable (and publishable) APK.

NOTE: this repo is in transition to mono-repo style. Some language-packs are in master while others are still in the old structure where each language-pack is a branch.

How to create a Language-Pack

Let's say you want to create a language-pack for Klingon. We'll call the pack klingon, and its locale is kl.

  1. Easiest way to start, is to duplicate one of the other packs: cp -R english klingon.
  2. Add the new modules to Gradle. Edit settings.gradle, add the line:
include ":languages:klingon:pack", ":languages:klingon:apk"
  1. At this point, you'll need to sync you Android Studio project.
  2. Rename the package names (com.anysoftkeyboard.english.* -> com.anysoftkeyboard.klingon.*:
    • Change package value in AndroidManifest.xml files (one in pack and the second in apk).
    • Move the PackBroadcastReceiver package to the right place.
  3. Rename the english_keyboards.xml and english_dictionary.xml files (under klingon/pack/src/main/res/xml) to klingon_keyboards.xml and klingon_dictionaries.xml.
  4. Replace the dictionary files under klingon/pack/dictionary with inputs matching your language (and remove what's not relevant):
    • Try to locate AOSP dictionary files (could be found at AOSP, or LineageOS) (you should use the XX_wordlist.combined.gz file).
    • If you have anything that was pre-built into a word-list XML, put those under klingon/pack/dictionary/prebuilt.
    • Add text files that will be parsed - word-counted - to generate word-list XMLs
  5. Generate the dictionary: ./gradlew :languages:klingon:pack:makeDictionary. This will create the following files (which should not checked into the repo):
    • raw resources under klingon/pack/src/main/res/raw/klingon_words_?.dict
    • IDs resource array under klingon/pack/src/main/res/values/klingon_words_dict_array.xml
  6. Edit klingon_dictionaries.xml:
    • to point to the new array resource @array/klingon_words_dict_array
    • replace the id with a new GUID.
    • replace name and description
    • replace the locale
  7. Set the status-bar icon text at klingon/pack/build.gradle: ext.status_icon_text = "kl"
  8. Replace the flag at klingon/apk/flag with a, high-quality, png or svg, image of the flag. It should be named flag.png or flag.svg. Note that sometimes svg files are not converted correctly, but they will produce highest quality if successful.
  9. To generate the icons, you'll need ImageMagick installed on your path. Check out the installation page for details.
  10. Generate the icons: ./gradlew :languages:klingon:pack:generateLanguagePackIcons :languages:klingon:apk:generateStoreLogoIcon. This will generate the following files (which should be checked into the repo):
    • klingon/pack/src/main/res/drawable-*/ic_status_klingon.png
    • klingon/apk/src/main/res/mipmap-*/ic_launcher.png
    • klingon/apk/src/main/play/listings/en-US/graphics/feature-graphic/pack_store_feature_graphics.png
    • klingon/apk/src/main/play/listings/en-US/graphics/icon/pack_store_icon.png
  11. Edit the keyboard layouts to your language, remove what's not needed, and add new ones if you need. Make sure the names of the layouts include you pack-name (klingon).
  12. Edit klingon_keyboards.xml. For each of the layouts you want in your pack (the layouts you created in the previous step):
    • Generate a new GUID.
    • Set the locale value at defaultDictionaryLocale to match the value you used in klingon_dictionaries.xml.
    • Set the status-bar icon at iconResId to the generate icon @drawable/ic_status_kl
    • Update the texts (name and description).

At this point, you should be able to build an APK that can be installed on your device:

./gradlew :languages:klingon:apk:assembleDebug

or directly install it on your connected device:

./gradlew :languages:klingon:apk:installDebug

Iterate on your pack until you feel it is good, and then create a PR to merge it to the master.

Publish pack

You can either publish by yourself, under your developer account and keep complete ownership, or you can let us (aka AnySoftKeyboard organization) do it.

Play Store Publish by AnySoftKeyboard organization

TO DO!!!

Languages in this repo

  1.  Afrikaans_oss: Source • Play Store
  2.  Armenian2: Source • Play Store
  3.  Brazilian: Source • Play Store
  4.  Catalan: Source • Play Store
  5.  Czech: Source • Play Store
  6.  English: Source
  7.  Finnish: Source • Play Store
  8.  French: Source • Play Store
  9.  Greek: Source • Play Store
  10.  Hebrew: Source • Play Store
  11.  Indonesian: Source • Play Store
  12.  Italian: Source • Play Store
  13.  Nias: Source
  14.  Ossturkish: Source • Play Store
  15.  Persian: Source • Play Store
  16.  Romanian: Source • Play Store
  17.  Russian2: Source • Play Store
  18.  Sardinian: Source • Play Store
  19.  Serbian: Source
  20.  Spain: Source • Play Store
  21.  Tamazight: Source • Play Store

License

Copyright 2018 Menny Even-Danan

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.