IPA Game is a desktop-based game where the player needs to classify items that appear on bubbles floating in a window view. The player needs to classify symbols of the International Phonetic Alphabet (IPA). The symbols that appear in the game will describe consonants that appear in the English language.
Instruction Manual
Requirements Document
Architecture Document
Testing Document
Time Tracking
The app has been built using Python version 3.6.0. Versions below that may not work as expected.
- Install dependencies with the command:
poetry install
- To use the existing mock database, keep the
.envdatabase filename intact. To use a different database, change the value of DATABASE_FILENAME. - Start the app with the command:
poetry run invoke start
Starting the game may take several seconds in the current version.
Try to stop each bubble from reaching the right edge of the screen. The bubble disappears when the symbol displayed on it has been classified correctly by dragging its corresponding class button until it reaches the bubble. Each correct collision awards 10 points and each wrong collision results in a 2 point penalty. The player can try again after a failed attempt.
After each symbol has been correctly classified, the game ends with a banner displaying the final score and asking for a nickname.
After entering the nickname, top 5 scores are shown. The game has 24 rounds.
In order to make testing the application easier, there is a button in the top right corner that displays the correct answer when clicked.
Start the app:
poetry run invoke start
Run tests:
poetry run invoke test
Create a test coverage report:
poetry run invoke coverage-report
The covarage report will be created in a repository called htmlcov.
Analyze static code quality with pylint:
poetry run invoke lint
Reformat the code using autopep8:
poetry run invoke format