Alxjlv / VARpedia

Prototype for the VARpedia Java application

VARpedia Final Release

Welcome to VARpedia! An application designed to help out senior citizens in memory retention, or even if they just wanted to learn something new!

We recommend checking out the important user information section below before using the application

Important user information:

1. To run our program, navigate to the 'Program' folder and run varpedia.sh script using bash varpedia.sh

2. This was run & developed on the UG4 lab computers

3. This relies on FFmpeg of version at least 4 - some lab computers run FFmpeg version 4, some run ffmppeg version 2. Check the ffmpeg version with ffmpeg -version. You may need to switch to another lab computer (sorry).

4. Included with the Jar is the hidden .bin folder. Inside here is the Music directory, keys.txt, User-Manual.pdf and a font file called Montserrat-Regular.ttf. Please do not delete any of these files or the application will not run as expected

5. This was developed on Java 8 with JavaFX. This code may not work if you have OpenJDK etc.

6. Our target audience is the Elderly

If you want to compile our code:

1. Retrieve our Repo from https://github.com/Alxjlv/VARpedia

2. Add your public Flickr API key to a new file called keys.txt in the folder .bin. This should be in the format FLICKR_PUBLIC = YOUR_KEY_HERE. Only put the key in there, nothing else.

3. To compile, you will need to import the Gradle project in IntelliJ. Our Repo includes our build.gradle so hopefully that works for you. Then type gradle fatJar to compile with dependencies

4. The jar will be in the build/lib folder. chmod +x the jar and use java -jar to run it

Music Attribution:

1. Loving Men by The_Stereo_Inspectors (c) copyright 2018 Licensed under a Creative Commons Attribution Noncommercial (3.0) license. http://dig.ccmixter.org/files/The_Stereo_Inspectors/58932 Ft: Ciggiburns
2. Big Star (Classic Rock) by Whitewolf (c) copyright 2019 Licensed under a Creative Commons Attribution Noncommercial (3.0) license. http://dig.ccmixter.org/files/Whitewolf225/60046 Ft: Admiral Bob
3. Free Music And Free Beer by Aussens@iter (c) copyright 2018 Licensed under a Creative Commons Attribution Noncommercial (3.0) license. http://dig.ccmixter.org/files/tobias_weber/57290 Ft: Admiral Bob, Bill Ray
4. Countryside Summer Joyride by Kara Square (c) copyright 2017 Licensed under a Creative Commons Attribution Noncommercial (3.0) license. http://dig.ccmixter.org/files/mindmapthat/56281 Ft: Javolenus

Code Attribution:

1. Code for changeListener for stage: https://stackoverflow.com/questions/38216268/how-to-listen-resize-event-of-stage-in-javafx
2. Code for setting background image: https://stackoverflow.com/questions/9738146/javafx-how-to-set-scene-background-image