Skip to content

realKarthikNair/GBoard-Dictionary-Maker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

GBoard-Dictionary-Maker

Make GBoard importable dictionaries with ease !


Table of Contents
  1. What is a GBoard Dictionary? Why do you need to make one?
  2. Point of this project
  3. Built With
  4. Features
  5. Installation
  6. Roadmap
  7. Contributing
  8. License
  9. Contact Us

What is a GBoard Dictionary? Why do you need to make one?

GBoard Dictionaries allow 'GBoard - The Google Keyboard' to suggest words/sentences based on partial inputs. They're basically like keybindings we can create to type out the "bigger stuffs" easily e.g. you type in "im" and GBoard shows you a suggestion on the keyboard bar "I am Jennifer"; Isn't that cool?

So how to create such a shortcut?

GBoard Settings>Dictionary>Personal Dictionary>All languages>Then tap on the "+" icon and create shortcuts.

Making several such custom shortcuts can increase your typing speed upto any extent and save you a lot of time, especially if you're leading a really busy life!

"Also that these shortcuts can be made with any language, or even emojis!"

(back to top)

"Okay that seems easy, so what's the point of this project?"

Well, imagine you have to make 100 such shortcuts. GBoard-Dictionary-Maker can create mutiple such shortcuts in bulk on a single window and then generate a GBoard importable zip rather than going back and forth to the GBoard Settings Menus.

Built With

(back to top)

Features

  1. Create Gboard importable dictionary file
  2. Edit existing zip/txt dictionary file given
  3. 100% made with Python and yes , it's FOSS

Installation

Prerequisites

  1. Python
  2. Tkinter (incase your installation of python didn't come with tkinter preinstalled)
    A simple Google search of the format "install Python/Tkinter on <your platform>" would lead you to the right pages
    e.g.,Google "Install Python on Windows" and "install Tkinter on Windows"

On Windows, Linux and BSD

Installation from the command line

git clone https://github.com/realKarthikNair/GBoard-Dictionary-Maker
cd GBoard-Dictionary-Maker
python3 main.py

manual installation: download the latest zip from 'releases'

  1. unzip it
  2. Open the folder
  3. Run main.py file

On Android

For now, use the legacy branch)

On MacOS

Normal installation should work, but we can't guarantee since the code is untested. Incase you encounter issues on Mac, kindly either help us by raising an issue and help us in extending compatibility. You can alternatively choose the legacy branch

(back to top)


How to import in Gboard?

Run the code , generate the zip, copy it to your mobile and import from Gboard settings>Dictionary>Personal Dictionary>All Languages>then choose import option from the drop-down menu

Roadmap

✅ Add a Graphical User Interface (GUI)
✅ Ability to add more shortcuts to existing dictionary zips
✅ Fix some graphical glitches in Linux (possibly in Mac OS and other UNIX derivatives too)
〚 〛 Support on Mac and Android
〚 〛 Documenting and further optimisation of code
〚 〛 Multi-language Support

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make GBoard-Dictionary-Maker, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

License

This software is being licensed on these terms

(back to top)


Built with love:

Support US