README.md

Chronology - Timeline-based Story Planner

A tool to organize and visualize the chronology of your story.

(Created as end-of-term assignment for 2110215 PROG METH course, Academic Year 2019, Chulalongkorn University)

Table of contents

• Features
• Project Dependencies
• Installation
• Usage
• Documentation

Features

Organize your story into components

• Create multiple color-coded storylines that can be visualized together.
• Compose each storyline out of multiple events.
• Group events into chapters.

Visualize flow of events

• Events are shown in chronological order - sorted by date and time!
• Storylines and chapters are color coded throughout the app.

Project Dependencies

• JavaSE 13 or later
• JavaFX 14
• JFXtras 10.0
• JSONSimple 1.1.1

Installation

A JavaFX installation is required. Clone and run Chronology.jar on command line using java -jar --module-path <PATH_TO_YOUR_JAVAFX> --add-modules javafx.controls,javafx.fxml Chronology.jar.

Usage

View full guide in project report: https://docs.google.com/document/d/1zvO2xRvUixVaHdnJgo1K5mitnjTlQNSftcyJAPXwWVE/edit?usp=sharing

Documentation

Please refer to the Javadoc at https://chronology-javadoc.firebaseapp.com/.