#TMK Typing Tutor

A comprehensive typing tutor application designed to help users master Shan language typing on PC. The lessons are inspired by the "Learn Tai Easy" e-book (ပပ်ႉႁဵၼ်းလိၵ်ႈတႆးၸဵဝ်းမေႃဝႆး).

This software is specifically developed to teach Shan language typing on computers for beginners and learners of all levels!

Features

• Multiple Keyboard Layouts: Supports SIL, Yunghkio, Kawsai (Panglong), Namkhone, and TMK Keyboard layouts
• Extensive Lesson System: Four progressive levels with numerous lessons covering basic to advanced Shan typing
• Multiple Themes: 14+ beautiful themes including Light, Dark, Ocean, Sunset, Neon, and more
• Progress Tracking: Detailed statistics and progress tracking for each lesson
• Customizable Experience: Adjustable settings for background music, error sounds, and keyboard preferences
• Certificate System: Earn certificates as you complete lessons and levels

How to Use

1. Registration/Login:

   • New users need to register an account with a username and password
   • Returning users canlog in with their existing credentials

2. Select Keyboard Layout:

   • Choose from 5 available keyboard layouts: SIL, Yunghkio, Kawsai (Panglong), Namkhone, or TMK Keyboard
   • The keyboard layout can be changed at any time in the settings

3. Choose Theme:

   • Select from 14+ visually appealing themes to personalize your experience
   • Themes include Light, Dark, Ocean, Sunset, Neon, and many more

4. Start Learning:

   • Progress through 4 levels of lessons, from basic to advanced Shan typing
   • Each lesson focuseson specific characters or typing techniques
   • Practice at your own pace and track your progress

5. Track Progress:

   • View detailed statistics for each lesson
   • Monitor your typing speed and accuracy
   • Earn certificates as you complete lessons and levels

6. Customize Settings: -Adjust background music volume or disable it completely

   • Enable or disable error sounds
   • Modify other preferences to suit your learning style

About

This project is called TMK Typing Tutor and is a computer software that can be installed on Windows, Linux and Mac OS and is developed by Sai Mao (TMKMuse) using JavaFX Technology.

The purpose of this project is to provide Shan people practice Shan typing on their own machine. Because there are 5 typing keyboards in Shan language, this project is designed to support them all. Using this software requires no keyboard installed but would be better if users do so.

This project is opensource and redistribution is allowed but reselling or redistribution with a cost in any way are strongly forbidden.

If users have issue and want to report, feel free to connect us via the following contacts:

• Email: [email protected]
• Facebook: TMK Muse

Credits

We would like to thank thefollowing people for their contributions to this project:

• LMS School for English (ႁူင်းႁဵၼ်းလူင်မူႉ) For the various support from Venerable Mendaka and Fohn C Kham.

-Shan Institute of Information Technology (SIIT) For the various advice from Sai Zom Tai and Sai Mawn Kham.

• Jao Kunheing (A J Kunheing) For providing fonts to use in this project

• Jao Tai Num For the helpwith Namkhone Keyboard and tutorials for Level 4 in it.

• Sai Tawng Pha (PL Dev) For the idea to create the keyboard and many uncountable helps and supports

Version History

Version 1.0

• Initial release (15/07/2023)

Version 1.1

• Released (22/07/2023)
• Added SIL, Yunghkio, Kawsai, and Namkhone keyboard layouts

Version 1.2

• Released (10/11/2023)
• Increased keyboard width for better visual experience
• Added dark and light theme options

Available Themes

The application offers a rich selection of 14+ visually appealing themes:

1. Light Theme
2. Dark Theme
3. Dark Blue Theme
4. Dark Green Theme
5. Crimson RedTheme
6. Ocean Theme
7. Frost Theme
8. Golden Theme
9. Midnight Theme
10. Monochrome Theme
11. Pastel Theme
12. Pinky Theme
13. Sunset Theme
14. Neon Theme
15. Green Theme

Each theme features carefullydesigned color schemes with gradient backgrounds and consistent UI elements for an enhanced user experience.

Screenshots

Dark Theme

Light Theme

Technology Stack

• Language: Java
• Framework: JavaFX
• Build Tool: Maven
• UI Design: FXML with CSS styling -Database: SQLite

Getting Started

Prerequisites

• Java 25 or higher
• Maven

Linux(Ubuntu/Debian) Additional Requirements

On Ubuntu or Debian-based systems, JavaFX Media Player requires gstreamer plugins to function properly. If you encounter media playback errors, you need to install the following packages:

sudo apt-get update
sudo apt-get install libgstreamer-plugins-base1.0-0 gstreamer1.0-plugins-base libgstreamer1.0-0

For some systems, you might also need additional gstreamer plugins:

sudo apt-get install gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly

Without these packages, the application may fail to start or throw errors related to media playback on Ubuntu systems.

Alternatively, you can import the project into your favorite IDE (IntelliJ IDEA, Eclipse, etc.) and run it from there.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.