Skip to content

XKCD Viewer is a small desktop Java application that reads comics from the xkcd site and displays them onscreen.

License

Notifications You must be signed in to change notification settings

lacraig2/XKCDViewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XKCD Viewer

XKCD Viewer is a lightweight Java application that reads comics from the website xkcd.com and displays them on screen. The program gives you the ability to scroll through the comics in a small window. The program has been updated with the ability to tell you, at startup, the number of comics that the use has missed since their last time using the program.

####Navigation:

  • Use the left arrow (or "a" key) to move to the previous comic
  • Use the right arrow (or "d" key) to move to the next comic
  • Use the "r" key to move to a random comic
  • Use the Escape key to exit the program.

####Dependencies/Requirements:

  1. Java Runtime Environment at least 1.8
  2. Connection to the internet (specifically access to xkcd.com)
  3. Jsoup 1.8.3 (HTML parser) (the program will download this at build time (only for Unix operating systems), but you will need access to the website)
  4. SQLite Database (the program will download this at build time (only for Unix operating systems), but you will need access to the website)
  5. At least 6 mb of storage space for the program itself
  6. Ample storage space for temporary downloaded images.

####To build this project:

On a Unix-based operating system (OSX, Linux, or anything running bash):

  1. run "build.sh" in the main project (you should only need to run this once).
  2. run "run.sh" to start the program.

On a Windows machine:

  1. Download Jsoup 1.8.3 (Direct link)
  2. Download SQLite Database 3.8.11.1 (Direct Link)
  3. Make two folders: libs and bin directly inside the main XKCDViewer folder
  4. Put both jar files in the libs folder.
  5. To build the project run the following command from the base of your project

javac -cp "libs/*" -d "bin" src/*.java

  1. To run the project run the following command from the bin folder of your project

java -classpath "../libs/*:." Main

####Features to be added:

  1. A background worker that checks if a new comic has been added every x minutes (x set by user).
  2. The ability to use the program at startup on multiple operating systems.

####Screenshots:

picture 1 picture 2

About

XKCD Viewer is a small desktop Java application that reads comics from the xkcd site and displays them onscreen.

Resources

License

Stars

Watchers

Forks

Packages

No packages published