Typing the Dictionary

A game that measures typing speed and accuracy while you type random dictionary entries.
Check it out »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Uninstallation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Typing the Dictionary is a small JavaFX program where you type random dictionary entries. While typing your words-per-minute, accuracy and number of words typed are tracked and displayed.

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You will need the following software installed to use this program.

• Java

  From the command line, enter java –version to see if you have Java installed on your computer.

  If Java is installed, you will see something like:

  java version "17.0.5" 2022-10-18 LTS
  Java(TM) SE Runtime Environment (build 17.0.5+9-LTS-191)
  Java HotSpot(TM) 64-Bit Server VM (build 17.0.5+9-LTS-191, mixed mode, sharing)
  

  Java may not be installed if you see something like:

  'java' is not recognized as an internal or external command, operable program or batch file.
  

  You can follow the instructions here to download and install it.

• JavaFX

  Most users don't have JavaFX installed. You might not have it installed if you see the following message when you try to run the program from the command line.

  JavaFX runtime components are missing, and are required to run this application
  

  Instructions to install JavaFX can be found here.

Installation

1. From the Git repo, download the TypingTheDictionary.jar file located in the out/artifacts/TypingTheDictionary_jar folder.
2. There are two ways to run this file:
   1. Run the .jar file directly.
   2. Using the command line
      1. Navigate to the directory where you downloaded the file.
      2. Type java -jar TypingTheDictionary.jar and press Enter.

Uninstallation

To uninstall this program:

• Delete the .jar file.

If you want to keep your global data in the event that you may later reinstall Typing the Dictionary, do not delete the saved user data.

To delete the saved user data:

1. Navigate to your User home directory:
   • Windows: \Users\<username>
   • Mac: /Users/<username>
   • Linux: /home/<username> or /usr/home/<username>
2. Delete the folder .typingthedictionary.

(back to top)

Usage

Session Data

Session data is the data from the current play session. When you are typing dictionary entries, you will see session data.

Global Data

Global data is the data from all your play sessions combined. On the starting screen of the program, global data is displayed, so you can see your overall statistics.

WPM Calculation

Words-per-minute is calculated using an average word length of 5 letters, not your actual word count. The calculation also factors in your accuracy. The less accurate you are, the lower the WPM. This is typically how WPM calculations are done.

(back to top)

Roadmap

• Scalable, resizable GUI.
• Confirmation before resetting user data.
• Reviewing instructions does not reset current displayed entry.
• Button to flag dictionary entry for review, with notes feature.
• Function to upload own dictionary files and select between dictionaries (checkbox, to use multiple dictionaries simultaneously).

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

(back to top)

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 this better, 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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Andrew Cate - LinkedIn - Website

Project Link: https://github.com/AndrewJCate/Typing-The-Dictionary

(back to top)

Acknowledgments

• README Template

(back to top)