duke

The Jedi Academy - User Guide

1. Introduction

The Jedi Academy is a Personal Assistant Chatbot that helps a person to keep track of his various tasks. The Jedi Academy is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). Continue reading to find out more about its features and usage!

2. Getting Started

1. Ensure you have Java 11 or above installed in your Computer.
2. Download the latest The Jedi Academy jar file here.
3. Copy the file to the folder you want to use as the home folder. Your tasks will be saved to and loaded from data/duke.txt located in the same folder.
4. Double-click the file to start the app. The GUI should appear in a few seconds.
5. Type the command in the command box and press Enter to execute it.
6. 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
  
  

3.1. Listing all Tasks: list

Lists all Tasks saved in hard drive currently

• Usage Format: list
  
  
  

3.2. Adding Todo Task: todo

Adds a Todo Task with the supplied Task Description

• Usage Format: todo DESCRIPTION
  • DESCRIPTION cannot be empty
• Example Usage:
  • todo cartwheel to school
    
    
    

3.3. Adding Deadline Task: deadline

Adds a Deadline Task with the supplied Task Description and DateTime the task has to be done by

• Usage Format: event DESCRIPTION /by DATETIME
  • DESCRIPTION cannot be empty
  • Format for DATETIME should preferably be dd/MM/yyyy HHmm
• Example Usage:
  • deadline assignment /by 14/07/2019 2359
    
    
    

3.4. Adding Event Task: event

Adds a Event Task with the supplied Task Description and DateTime the task is happening at

• Usage Format: event DESCRIPTION /at DATETIME
  • DESCRIPTION cannot be empty
  • Format for DATETIME should preferably be dd/MM/yyyy HHmm
• Example Usage:
  • event diving competition /at 21/07/2019 1400
    
    
    

3.5. Marking Task as Done: done

Marks a Task at the specified index in the task list as Done

• Usage Format: done INDEX
  • INDEX cannot be empty
  • INDEX should be an Integer from 1 to n, the number of tasks in the task list
• Example Usage:
  • done 2
    
    
    

3.6. Deleting Task: delete

Deletes a Task at the specified index in the task list

• Usage Format: delete INDEX
  • INDEX cannot be empty
  • INDEX should be an Integer from 1 to n, the number of tasks in the task list
• Example Usage:
  • delete 3
    
    
    

3.7. Finding Task: find

Finds the Tasks whose Task Description contains the supplied KEYWORD

• Usage Format: find KEYWORD
  • KEYWORD cannot be empty
• Example Usage:
  • find something
    
    
    

3.8. Exiting the Program: bye

Exits the Program

• Usage Format:
  bye
  
  
  

3.9. Saving/Loading Tasks

Tasks are saved in the hard disk automatically after any command that changes the task list.
Existing task list is also loaded from the hard disk automatically when The Jedi Academy starts up.
There is no need to save manually.

3.10. Detecting duplicate Tasks

Throws an error message when user tries to add a Task with an existing Task description:
"OOPS!!! Duplicate task already exists!"

4. Command Summary

• List: list
• Todo: todo DESCRIPTION
• Deadline: deadline DESCRIPTION /by DATETIME
• Event: event DESCRIPTION /at DATETIME
• Done: done INDEX
• Delete:delete INDEX
• Find: find KEYWORD
• Bye: bye