BrawlyDuke User Guide
part of the CS2103T module Individual Project (IP). BrawlyDuke is a task management Chatbot to help keep track of you activities.
BrawlyDuke was designed with one of my favourite mobile games Brawl Stars
Features
- Add various types of task to the bot.
- Delete tasks that are no longer relevant/completed.
- List out all the tasks on your list.
- Complete tasks and mark them as done.
- Search for tasks in the list through keywords.
- Help on how to use the Chatbot.
- Exit the application and have your data saved. ##
Add Tasks
Users will be able to add various different types of tasks:
- todo a generic task
- deadline a task with a specific date to be completed
- event a task with a specific location
Todo
Usage
todo <task description>
Example
todo go swim
Expected Outcome
Got it I have added this task:
[T][✘] go swim
you now have 1 task on the list
Deadline
Usage
deadline <task description> /by <YYYY-MM-DD>
Example
deadline finish math homework /by 2020-10-10
Expected Outcome
Got it I have added this task:
[D][✘] finish math homework (by:Oct 10 2020)
you now have 1 task on the list
Event
Usage
event <task description> /at <task location>
Example
event go run /at East Coast Park
Expected Outcome
Got it I have added this task:
[E][✘] go run (at:East Coast Park)
you now have 1 task on the list
##
Delete Tasks
Users will be able to delete tasks based on the index in the list.
####delete
Usage
delete <task index>
Example
delete 1
Expected outcome
Noted I've removed this task
[T][✘]go swim
You now have 2 tasks on the list
##
List Tasks
Users will be able to view the full list of tasks that they have added.
####list
Usage and example
list
Expected Outcome
Here are the tasks in your list:
1.[T][✘]go swim
2.[T][✘]go run
...
##
Complete Tasks
Users will be able to mark tasks as completed based on the index in the list.
done
Usage
done <task index>
Example
done 1
Expected Outcome
I have marked this as done:
[✓]go run
##
Search Tasks
Users will be able to search for tasks based on the keyword, and tasks in the list.
####find
Usage
find <keyword>
Example
find run
Expected Outcome
[T][✓]go run
[E][✘]go run (at:East Coast Park)
##
Help
Users will be able to ask for help for specific tasks.
####help
Example and Usage
help
Expected Outcome
Here are the available commands:
-todo <description>
-deadline <description> /by YYYY-MM-DD
...
For more specific instructions for tasks you can use:
help todohelp deadlinehelp task##
###Bye Users will be able to exit the application and have their tasks saved.
####bye Example and Usage
bye
Expected Outcome
Bye have a good day!
application will be closing shortly