LanguageCards

This is a flash card game for guessing translations or keyboard learning. Currently implemented is English Romaji to Japanese Hirigana/Katakana and typing exercises for each. Game experience will be improved upon!

Also if your interested in adding other flash cards for language learning, pull requests are welcome. Please keep some sort of organized collection for sets of cards (for instance the Japanese-Language Proficiency Test has different levels to complete, N1 through N5, which would each count as a collection).

Internationalization support is built in! Translators are welcome to make this game available in other languages.

Installation

Add this line to your application's Gemfile:

gem 'language_cards'

And then execute:

$ bundle

Or install it yourself as:

$ gem install language_cards

Usage

After installing the gem you can run the executable language_cards. If you clone the repo then use bin/language_cards.

Card Format

The cards are stored in YAML format. You can look in the cards directory for existing examples to follow. The first entry is a lnaguage name and it's okay if that already exists in another file. The entries below that must be unique for that language (eg: you can't have two Hiragana sub entries on Japanese). The next step in will have a mapping hash with exactly two entries. The first mapping entry is how the language is being mapped from key to value (eg "Romaji" => "Hiragana"). The next mapping entry is the representation of how this is to be mapped; the how is for whether you want to do a translation mapping key to value, or keyboard practice mapping value to value. This part of the mapping must be with the symbol entries of :k or :v. Along with the mapping entry you may puts all the keys and values for your cards. Just follow the below outline for a working example.

---
Japanese:
  Hiragana:
    mapping:
      - Romaji: Hiragana
        index: 
          - :k
          - :v
      - Hiragana: Hiragana
        index: 
          - :v
          - :v
    a: あ
    i: い
    u: う
    e: え
    o: お

In the example above we allow two mappings (game modes as-it-were). The first mapping is a translation mapping for people to write romaji to solve the Hiragana character, and the second is to actually type the Hiragana character in. As you can see the entries for the cards are bellow at the same level as mapping.

The first entry Japanese can be in any other cards file. The next level in where "Hiragana" is must be unique to the language Japanese and only in one file. If you mess up the mapping the error messages will be very clear about it. You may enter either one mapping, or two.

Development

Tests required moving forward with this project unless it's translation files.

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/danielpclark/language_cards. Translations of the game itself are kept in the locales folder. Flash cards are stored in YAML format in thecards folder.

License

The gem is available as open source under the terms of the MIT License.