Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions DataFile.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Wow..much emptiness
6 changes: 6 additions & 0 deletions Updates.txt
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,9 @@ Things maybe wanted to implement
2. Time bot has been running
Seperate usercommands


Bug fixes
Update 1-1
Fix bug where bot dont save memory when closed
Fix bug where cannot see past certain amount of items

118 changes: 72 additions & 46 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,57 @@
# User Guide
This is a brief introduction on how to use "Toki Toki Task Bot".

##What is Duke?
Duke is a task bot build to keep track of all your task and schedules.

## What is Duke?
Duke is a task bot built to keep track of all your task and schedules.
Users can add and delete their tasks and Duke will keep track of all your task for you.

##Who is Yuri?
![Image of Yuki](https://github.com/Deunitato/duke/blob/master/src/main/resources/images/meanGirl.jpeg)
Yuri is personality build on top of Duke, the original bot. Yuri aims to ensure that you as a user understand her pain of keeping track of all your task. Even thou she is supposed to track the task for you, she will not hesitate to express her displeasure at your laziness and irresponsibility in handling your own to do list.
## Who is Yuri?
![Image of Yuki](https://github.com/Deunitato/duke/blob/master/src/main/resources/images/meanGirl.jpeg?raw=true)


Yuri is personality built on top of Duke, the original bot. Yuri aims to ensure that you as a user understand her pain of keeping track of all your task.
Even though she is supposed to track the task for you, she will not hesitate to express her displeasure at your laziness and irresponsibility in handling your own to do list.

## Installing the Software
## Installing the Doki Doki Task Bot
Navigate to [github Releases](https://github.com/Deunitato/duke/releases) and download the latest release. Place the jar file into a new folder.
Opening the Jar file will show a welcome text from YURI.
![Image of startup] (https://i.imgur.com/WZ1yERF.png)

## Features
![Image of startup](https://i.imgur.com/WZ1yERF.png)

### Add and delete
Add your own tasks/deadlines/events
## Features

### List your own tasks
#### Create your own tasks
1. Create todo tasks
2. Create event tasks
3. Create deadline tasks
#### Organising your task
1. Listing
2. Mark your tasks as done
3. Find tasks
4. Delete tasks

#### List your own tasks
Ask Yuri to display the task that you have to do

### Check your statistic
#### Check your statistics
Yuri will also keep track of things that you did within the day and week.

### Tsundere Personality
Yuri will "hate" your laziness but still feel compled to serve you as your personal secretary.
1. Check the tasks done today/this week
2. Check number of types done
3. Check the task that expired

#### Tsundere Personality
Yuri will "hate" your laziness but still feel compelled to serve you as your personal secretary.

## Usage

Basic Usage of Yuri

### `bye` - Saves Yuri memory
Yuri requires you to say bye for her to remember what you say.

Example of usage:
## Usage

`bye`
Basic commands that Yuri will respond to.

### Creating your own tasks

### `TODO` - Creates an todo task
#### `TODO` - Creates an todo task

Adds a TODO Tasks into your list

Expand All @@ -50,35 +61,45 @@ Example of usage:

Expected outcome:

`sighs...am I your slave again?`
`sighssss...am I your slave again?`

### `Event` - Creates an event task
#### `Event` - Creates an event task

Creates a event and adds it into your list
Yuri also requires the date of the event as denoted by /at

Example of usage:

`event Anime Matsuri /at 12-01-2020`
`event Anime Matsuri /at 12/01/2020`

`event Anime Matsuri /at 12/01/2020 1200`

`event Anime Matsuri /at 1200`

Expected outcome:

`sighs...am I your slave again?`
`sighsssss...am I your slave again?`

### `Deadline` - Creates an deadline
#### `Deadline` - Creates an deadline

Creates a deadline and adds it into your list
Yuri also requires the date of the event as denoted by /by

Example of usage:

`event Homework /at 12-01-2020`
`event Homework /at 12/01/2020`

`event Homework /at 1200`

`event Homework /at 12/01/2020 1200`

Expected outcome:

`sighs...am I your slave again?`
`sighsssss...am I your slave again?`

### Organising your tasks

### `list` - Shows your list bucket
#### `list` - Shows your list bucket

Displays the list of task that you current have.

Expand All @@ -87,7 +108,7 @@ Example of usage:
`list`


### `Done` - Marks task as done
#### `Done` - Marks task as done

Marks the task signified by ID as done

Expand All @@ -99,18 +120,8 @@ Expected outcome:

`Okay whatever.. so you have completed this item.. so what? Marking item 1 as done `

### `Stats` - List out all the stats command

Shows the list of stats command you could use.
Examples are
1. Expired - list all the expired tasks
2. Week - List the tasks you have completed in the week

Example of usage:

`stats`

### `Find` - Searches for a task
#### `Find` - Searches for a task

Searches for tasks in your list

Expand All @@ -119,11 +130,14 @@ Example of usage:
`find home`

Expected outcome:

`Found this task in total:`
` 1. [T][X] Homework`

` 1. [T][✘] Homework`

`Found in total 1 tasks`

### `Delete` - Deletes your task
#### `Delete` - Deletes your task

Totally remove all records of your tasks

Expand All @@ -135,8 +149,20 @@ Expected outcome:

`Erasing your tracks are you?`

### Checking your statistics

### `Stats` - List out all the stats command

Shows the list of stats command you could use.
Examples of commands are
1. `Expired` - list all the expired tasks
2. `Week` - List the tasks you have completed in the week

Example of usage:

`stats`

#Sample Screenshots of Yuri
# Sample Screenshots of Yuri

## Adding Tasks

Expand Down
Binary file added docs/UI.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-architect
4 changes: 2 additions & 2 deletions memory.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ deadline~true~oooo /by 10/02/2020 1200~11/2/2020
todo~false~apple~1/1/1
deadline~true~d1 /by 12/01/2020~12/2/2020
todo~true~one more~12/2/2020
todo~false~eeee~1/1/1
todo~false~mytask~1/1/1
todo~false~to test delete button~1/1/1
event~false~anime matsuri /at 12/01/2020~1/1/1
3 changes: 2 additions & 1 deletion src/main/java/database/Storage.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class Storage {
*/
public static void memoryInit() {
try {
file = new File("memory.txt");
file = new File("DataFile.txt");
if (file.createNewFile()) {
System.out.println("Init new memory");
} else {
Expand Down Expand Up @@ -74,6 +74,7 @@ public static void saveMemory() throws DukeException {

if (mylist.size() == 0) {
overwrite("Wow..much emptiness");
assert mylist.size() == 0 : " Must be 0";
}
for (Task t: mylist) {
String[] splitted = t.toString().split(" ", 3);
Expand Down
14 changes: 5 additions & 9 deletions src/main/java/duke/DukeInit.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,11 @@ public class DukeInit {
+ "| |_| | |_| | < __/\n"
+ "|____/ \\__,_|_|\\_\\___|\n";*/
//got it from some text generator
private static String logo = "\n" +
"__ __ _ _ ______ _____ \n" +
"\\ \\ / /| | | || ___ \\|_ _|\n" +
" \\ V / | | | || |_/ / | | \n" +
" \\ / | | | || / | | \n" +
" | | | |_| || |\\ \\ _| |_ \n" +
" \\_/ \\___/ \\_| \\_| \\___/ \n" +
" \n" +
" ";
private static String logo = " _ _ _ _ ___ _ \n" +
" | | | | | | | . \\ | |\n" +
" \\ / | ' | | / | |\n" +
" |_| `___' |_\\_\\ |_|\n" +
" \n";
/**
* Initalises bot.
*/
Expand Down
9 changes: 9 additions & 0 deletions src/main/java/duke/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

import java.io.IOException;

import commands.CommandInvoker;
import database.Storage;

import javafx.application.Application;
import javafx.fxml.FXMLLoader;
import javafx.scene.Scene;
Expand Down Expand Up @@ -38,4 +41,10 @@ public void start(Stage stage) {
}
}

@Override
public void stop() throws Exception {
Storage.saveMemory();
CommandInvoker.stop();
super.stop();
}
}
2 changes: 1 addition & 1 deletion src/main/resources/view/DialogBox.fxml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<fx:root alignment="TOP_RIGHT" maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" prefHeight="182.0" prefWidth="400.0" styleClass="chatBox" stylesheets="@styles.css" type="javafx.scene.layout.HBox" xmlns="http://javafx.com/javafx/11.0.1" xmlns:fx="http://javafx.com/fxml/1">
<children>
<Label fx:id="dialog" alignment="TOP_RIGHT" styleClass="chatBubCharVersion" stylesheets="@styles.css" text="Label" textAlignment="CENTER" wrapText="true">
<Label fx:id="dialog" alignment="TOP_RIGHT" styleClass="chatBubCharVersion" stylesheets="@styles.css" text="Label" wrapText="true">
<padding>
<Insets bottom="2.0" right="20.0" />
</padding>
Expand Down
3 changes: 2 additions & 1 deletion src/main/resources/view/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
}

.label{
-fx-padding: 5;
-fx-padding: 10;

}

/*Taken from http://fxexperience.com/2011/12/styling-fx-buttons-with-css/*/
Expand Down