Kardz v1.0.0
README

Binary Distribution

Kardz - Portable character-based language flash cards using MIDP
Copyright (c) 2006 Nicholas Chihau Yang


Kardz is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Kardz is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

About

Kardz is a character-based language flash card program for your cell phone or other mobile device (uses Java MIDP 2.0) that I wrote in roughly 1-2 weeks.  Each card consists of a character entry and an answer entry.  Character entries can be used for any character-based language.  Answer entries are in English.  Features include:

  • No dependency on language font files
  • Support for selecting card subsets through defining categories
  • Support for newlines in card definitions
  • Scrolling support for cards that won't fit on the screen
  • Easy toggling between English and the currently selected language
  • Randomization and resetting of card order
  • Jumping to any specified card number
  • Ability to save state of card order and current card on program exit
  • Relatively easy setup to include other languages
  • Relatively small JAR file size
  • Coded using MIDP Game API to optimize user interaction

I've been using Kardz for Chinese, Japanese, and Korean, but it can be extended to any character-based language, such as, for example, Thai or Hebrew.  I originally designed Kardz for intended use with East Asian languages, but technically, any Romanized alphabet can be used as well, since they are all character-based (English, French, Spanish, Portuguese, etc.).

Since characters are drawn based on a bitmap file, technically, any set of characters or custom drawings may be used.  In this fashion, Kardz allows users to create custom alphabets if desired.  You could create your own language with smiley faces and weird dingbats as characters for all I care.  There is absolutely no dependency on any font files.

I'm including examples of 3 languages in this distribution (Chinese, Japanese, and Korean).  The flash card sets are minimal, so most likely, you will want to generate your own card data.  See the source code documentation for details on how to do this.

Please send me comments, suggestions, and any feedback!  I'd appreciate it a lot.  ^_^

 

Back to top

Requirements

  • MIDP 2.0, must exist on the device you want to run this on
  • Method of uploading to mobile device (USB cable, Bluetooth, email, etc.)

 

Back to top

How To Use

Buttons

  • LEFT - Go to previous card
  • RIGHT - Go to next card
  • UP - Scroll up
  • DOWN - Scroll down
  • FIRE/SELECT - Toggle answer

Menu

  • Reset Order - Rearranges cards in the same order as the data file
  • Randomize - Randomizes card order
  • Goto Card # - Allows user to type in a card number to jump directly to that card
  • Choose Category - Allows user to include/exclude cards in specific categories; card ordering will be reset
  • Del Saved Data - Deletes save-state data from the phone's database; useful when dealing with large stacks that take up too much memory from storing card orderings or categories

About

  • Shows About screen, credits and copyright information

Exit

  • Save State - Select "Yes" if you want Kardz to remember the current card ordering, selected categories, and the current card you are on

 

Back to top

Gallery

  List of suite content.  Three languages are included in this distribution.     Sample Japanese card with menu options showing.
             
  Go To Card input screen.     Category selection screen.
             
  Korean on a grayscale phone.     Chinese on a QWERTY device.
             
  Yes, it really works on my Motorola V180.     About screen on my V180.
             
  Japanese card on my V180.     Answer card on my V180.
             
  Menu selection on my V180.     Category selection on my V180.

 

Back to top

Troubleshooting

I'm getting Exceptions when I run the program.

Check the path of the PNG files.  Make sure that they are located in the same path you specified when you ran DataGen.

When I upload to my mobile device, the program doesn't work.

Did you remember to choose the menu selection Project -> Package -> Create Package?

 

Back to top