Skip to content

yilverdeja/canto-numbers

Repository files navigation

Canto Numbers

Canto Numbers is an open-source game designed to help users learn how to distinguish numbers in Cantonese by listening to their pronunciation. This fun and educational game allows users to test their knowledge and improve their skills in a gamified environment.

How to Play

  1. Type in the number you hear in Cantonese.
  2. Submit your guess to see if it's correct.
  3. You will be notified with a sound whether your guess is correct or not.

Current Features

Canto Numbers currently offers the following features:

  • Guess Categories with hints
    • Numbers from 0 to 1000
    • Time in 12-hour format from 1:00 to 12:59
    • Multiple Digits
    • Money from cents, dimes to a combination of dollars and cents
    • Dates in a dd/mm format
  • Generate Category Audio with text
    • Numbers from 0 to 999,999,999,999
    • Time from 1:00 to 12:59
    • Single to Multiple Digits
    • Money from 0.01 to 1000.99
    • Dates in a dd/mm format
  • Keep track of your correct and missed guesses with a counter score, which is saved on your local host.
  • See simple session stats within the stats page
  • Requires sound to listen to the audio.
  • Available on both desktop and mobile devices.
  • Change hints and text type between Jyutping, Yale or Chinese Traditional Characters via Settings

To-Do

Future implementations:

  • Add unit tests.
  • Expanding the range of numbers.
  • Adding a stats dashboard to see progress.
  • Incorporating more audio variations for each number.
    • Manage a single mp3 and json file for all variations
    • Create a system to play different variations in play & practice
  • Add different number categories
    • integers
    • time
    • money
    • digits
    • dates
    • math
  • Add a Learn Page for each category
  • Create custom game settings for more personalized approach
  • User Profiles to save data

Contribution

We welcome contributions from the community to make Canto Numbers even better. If you'd like to contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure that the code is well-documented.
  4. Test your changes thoroughly.
  5. Submit a pull request, describing the changes you've made and why they are valuable.

Thank you for considering contributing to Canto Numbers! Together, we can make learning Cantonese numbers a fun and engaging experience for everyone.

About

Learn to distinguish numbers in Cantonese

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published