Skip to content

Latest commit

 

History

History
375 lines (255 loc) · 9.43 KB

UserGuide.adoc

File metadata and controls

375 lines (255 loc) · 9.43 KB

Dukemon - User Guide

By: SErebros Since: September 2019 Licence: MIT

1. Introduction

We aim to streamline and gamify the process of learning words or definitions through the use of self-created flash cards.

The general flow of the program is as follows:

  1. Create your word bank.

  2. Add flash cards, each containing a word and a meaning, into your word bank.

  3. Configure settings, or modify word bank as you wish.

  4. Start the game.

  5. The meaning of the card will appear and you will have to key in the answer in a given time.

  6. At the end of the game, statistics of your game session appears, so you can know how well you did.

  7. Revisit the word bank to beat your previous high score.

You write your own words and meaning into a word bank. You can also import a word bank given to him from a file.
During the game, you are prompted with a meaning and you have to answer with a word. Depending on the game mode, there may also be time restrictions and hints given. Answer correctly as quickly as possible and to score as much as you can!
You can view your statistics afterwards to review your performance! Revisit word banks which you scored badly.

2. Quick Start

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest Dukemon.jar here.

  3. Copy the file to the folder you want to use as the home folder for your Dukemon.

  4. Double-click the file to start the app. Enjoy learning!

Ui

+ . Type the command in the command box and press Enter to execute it.
e.g. typing help and pressing Enter will open the help window. . Some example commands you can try to get familiar with the app :

  • create WORD_BANK : Create an empty word bank.

  • bank WORD_BANK : Select this particular bank.

  • add w/WORD m/MEANING : Add a flash card into the word bank.

  • list : List all cards in the word bank.

  • start [DIFFICULTY] : Starts the game with a selected difficulty. Default difficulty will be selected if none is keyed in.

  • guess ANSWER : Input your answer according to the meaning given.

  • stop : Stops the game.

  • exit : Exits the app.

    1. Refer to Section 3, “Features” for details of each command.

3. Features

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add w/WORD, WORD is a parameter which can be used as
    add w/Charmander m/Fire starter pokemon.

  • Items in square brackets are optional e.g w/WORD [t/TAG] can be used as
    add w/Squirtle m/Water starter pokemon t/Water type or as
    add w/Squirtle m/Water starter pokemon.

  • Items with …​ after them can be used multiple times including zero times e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/CS2040, t/CS2040 t/GRAPH etc.

  • Parameters can be in any order e.g. if the command specifies w/WORD m/MEANING, m/MEANING w/WORD is also acceptable.

3.1. Load commands

3.1.1. To enter loading page : load

Changes the app mode to load, so that the user can perform load commands.

3.1.2. Create new word bank : create

Creates a new word bank with specified name.

Format: create WORD_BANK
Examples:

  • create CS2040

  • create Biology

3.1.3. Remove a word bank : remove

Removes a new word bank with specified name.

Format: remove WORD_BANK
Examples:

  • Remove Gen 3 pokemon

  • Remove Vocabulary

3.1.4. Import a word bank : import

Import the word bank from a specified file path on your system.
Note that you can use '\' and '\\' for windows.

Format: import w/WORD_BANK f/FILE_PATH
Examples:

  • import w/cs2040_graph f/~/downloads

  • import w/fire pokemons f//Users/chrischenhui/data

3.1.5. Export a word bank : export

Export the word bank to a specified file path on your system.

Format: export w/WORD_BANK f/FILE_PATH
Examples:

  • export w/ma1101r theorems f/~

  • export w/biology definitions f/~/downloads

3.1.6. Bank a word bank : bank

Choose the word bank you want to work with.

Format: bank WORD_BANK Examples:

  • bank CS2040

  • bank Biology

3.2. Flash card commands

3.2.1. Help : help

Shows help

Format: help

3.2.2. Adding a flash card : add

Adds a new word-description pair to the word bank.

Format: add w/WORD m/MEANING

ℹ️
 There can be duplicate words, but duplicate meanings will be rejected.

Examples:

  • add w/Elephant m/Has a long nose

  • add w/Newton’s third law of motion m/Every action will produce and equal and opposite reaction

  • add w/Kopi Luwak m/Coffee produced from the coffee beans found in the faeces of a civet cat

3.2.3. Deleting a flash card : delete

Deletes the specified word from the data set.

Format: delete w/card

  • Deletes the word at the specified INDEX.

  • The index refers to the index number shown in the displayed person list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • delete 2
    Deletes the 2nd word in the data set.

  • delete 1
    Deletes the 1st word in the results of the /find command.

3.2.4. Viewing a word bank’s content : list

Views the content of a data set.
Format: list

3.2.5. Clear a word bank’s content : clear

Views the content of a data set.
Format: clear

3.2.6. Editing a data set’s content : edit

Edits a flash card.

Format: edit flashcardname

Examples:

  • edit List of animals

  • edit Teeth

Locating a word/description: find

Finds entry whose word or description contain any of the given keywords.
Format: /find KEYWORD [MORE_KEYWORDS]…​

  • The search is case insensitive. e.g hans will match Hans

  • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans

  • Both word and description will be searched

  • Only full words will be matched e.g. Han will not match Hans

  • Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

  • find long
    Returns entries containing elephant and giraffe.

  • find mammal fish bird
    Returns any entries containing mammal, fish or bird in its descriptions or words.

3.2.7. Exit the game : exit

3.3. Game commands

3.3.1. Start new game session : start

Starts a game session with the selected word bank.
You select your word bank from the load command : bank WORD_BANK

Format: start [difficulty]

3.3.2. Guess the answer : guess

Input your answer for the prompted word, given a meaning.

Format: guess WORD

3.3.3. Skip a word : skip

Stops current game session (all progress will be lost) and returns to the home page.

Format: stop

3.3.4. Stop game session : stop

Stops current game session (all progress will be lost) and returns to the home page.

Format: stop

3.4. Changing settings : settings

Goes into the settings menu.
Format: /settings

3.4.1. Changing the theme : theme

Changes the theme of the UI.
Format: /theme dark/light

Examples:

  • /theme dark
    Changes the UI theme to dark.

  • /theme light
    Changes the UI theme to light.

3.4.2. Turning hints on/off : hints

Turns hints on or off.
Format: /hints on/off

Examples:

  • /hints on
    Turns hints on.

  • /hints off
    Turns hints off.

3.4.3. Changing difficulty : difficulty

Changes the difficulty of the game.
Format: /difficulty low/medium/high

Examples:

  • /difficulty low
    Changes the difficulty to low. (Timer = 30 seconds)

  • /difficulty medium
    Changes the difficulty to medium. (Timer = 20 seconds)

  • /difficulty high
    Changes the difficulty to high. (Timer = 10 seconds)

3.5. Navigating back : back

At any point in time, if there is a previous screen, navigates back to that screen. add home to navigate back to the home page.
Format: /back [home]

Examples:

  • /back

  • /back home

3.6. Saving the data

Dukemon data are saved in the hard disk automatically after any command that changes the data.
These commands are generally load commands. There is no need to save manually. Statistics are also stored automatically.

3.7. Leaderboard [coming in v2.0]

View and compare your statistics with peers on the internet.

3.8. User profiles [coming in v2.0]

Have more than one account to monitor statistics on the same computer

4. FAQ

Q: How do I transfer my word bank to my friend?
A: Export your word bank to your computer, then transfer him the file. He can then import the file into his Dukemon.

Q: How do I pronounce your app name?
A: Think Pokemon.

5. Command Summary

Type of command Command name Parameters

Home Command

help

bank

WORD_BANK

create

WORD_BANK

remove

WORD_BANK

import

w/WORD_BANK f/FILE_PATH

export

w/WORD_BANK f/FILE_PATH

Card Command

list

add

w/WORD_BANK m/meaning [t/TAG]

edit

INT w/WORD_BANK m/meaning [t/TAG]

delete

INT

find

clear

exit

Game Command

guess

ANSWER

skip

stop

Settings Command

difficulty

EASY/NORMAL/HARD

theme

DARK/LIGHT

hints

ON/OFF

avartar

INT

Switch Command

home

open

start

[DIFFICULTY]

setting