Rebase Commit

.gitignore

@@ -0,0 +1,14 @@
+TamoStudy/.project
+
+*.class
+bin/
+.classpath
+.project
+.github/workflows/firebase-hosting-merge.yml
+.github/workflows/firebase-hosting-pull-request.yml
+TamoStudy Web/.firebaserc
+TamoStudy Web/firebase.json
+.DS_Store
+*.jar
+TamoStudy/.idea/vcs.xml
+TamoStudy/.idea/misc.xml

.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,8 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.release=disabled
+org.eclipse.jdt.core.compiler.source=1.8

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 narlock
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,206 @@
+<!-- Author: @narlock -->
+
+<a href="https://instagram.com/narlockdev" style="padding:10px;"><img src="https://raw.githubusercontent.com/narlock/TamoStudy/main/README%20Assets/instagramApp.png" alt="Instagram" align="right" width="60"></a>
+<a href="https://twitter.com/narlockDev" style="padding:10px;"><img src="https://raw.githubusercontent.com/narlock/TamoStudy/main/README%20Assets/twitterApp.png" align="right" width="60"></a>
+<a href="https://youtube.com/narlock"><img src="https://raw.githubusercontent.com/narlock/TamoStudy/main/README%20Assets/youtubeApp.png" alt="YouTube" align="right" width="60"></a>
+<a href="https://tamostudy.com"><img src="https://raw.githubusercontent.com/narlock/TamoStudy/main/TamoStudy/assets/TAMOSTUDY_ICON.png" alt="TamoStudy logo" title="TamoStudy" align="right" width="60"></a>
+
+# TamoStudy
+
+[![Latest Release](https://img.shields.io/github/v/release/narlock/TamoStudy)](https://github.com/narlock/TamoStudy/releases/)
+[![Downloads](https://img.shields.io/github/downloads/narlock/TamoStudy/total.svg)](https://github.com/narlock/TamoStudy/releases/)
+[![Latest Commit](https://img.shields.io/github/last-commit/narlock/TamoStudy)](https://github.com/narlock/TamoStudy/commits/main)
+[![Discord](https://discordapp.com/api/guilds/821757961830793236/widget.png?style=shield)](https://discord.gg/eEbEYbXaNS)
+
+**TamoStudy** is a free, open source work and study timer designed to enhance productivity, incorporating an enjoyable virtual pet to motivate users to concentrate on their tasks. Programmed utilizing **Java 8**, development for this application began in January of 2021.
+
+## 🚀 **Features**
+
+### 👋 **Welcome Screen**
+
+An improved program launcher. Allows the user to select either local study and the soon-to-be-developed online study.
+
+<p align="center">
+  <img src="./README%20Assets/WelcomeScreen.png" width="75%"/>
+</p>
+
+Global settings can be change using the cog at the top-right including resetting the default profile, setting the global language, and to receive update notifications.
+
+### 👥 **Local Profile Loader**
+
+<p align="center">
+  <img src="./README%20Assets/ProfileLoader.png" width="75%"/>
+</p>
+
+### ⏰ **Focus Timers**
+
+Simple, customizable countdown timers for deep focus work.
+> **Note**
+> Selecting the 'Peaceful' difficulty will allow you to 'pause' the timer during focus sessions. This is shown in the Pomodoro image below. If you select any other difficulty, you will not get this option, as shown in the remaining timer images.
+
+- *Pomodoro*: The popular *[pomodoro technique](https://en.wikipedia.org/wiki/Pomodoro_Technique)* that breaks work into intervals. For a number of sessions, focus for a specified amount of time, then take a break for a specified amount of time.
+
+<p align="center">
+  <img src="./README%20Assets/Pomodoro.png" width="75%"/>
+</p>
+
+- *Custom Interval Countdown*: Customize the number of minutes and the number of a seconds in a single focus session.
+
+<p align="center">
+  <img src="./README%20Assets/CustomInterval.png" width="75%"/>
+</p>
+
+- *5-Interval Countdown*: Easily choose a focus time from a selection of factors of 5 minutes.
+
+<p align="center">
+  <img src="./README%20Assets/5Interval.png" width="75%"/>
+</p>
+
+- *Stopwatch*: A standard stopwatch timer which counts up. The implementation in TamoStudy counts the amount of cycles (100 minutes) studied. The timer will appear back to 0 minutes and 0 seconds after each cycle.
+
+<p align="center">
+  <img src="./README%20Assets/Stopwatch.png" width="75%"/>
+</p>
+
+Upon completing focus sessions, you will receive Tamo Tokens! With Tamo Tokens, you can purchase food for your virtual pet and additional customization! To keep your Tamo happy, you must complete your desired focus sessions!
+
+### 🛍️ **Shop**
+
+Meet Kath, the owner of the TamoStudy shop! Kath provides the user access to food to feed their tamo as well as backgrounds and borders for customization!
+
+<p align="center">
+  <img src="./README%20Assets/Shop.png" width="75%"/>
+</p>
+
+- Beside the Tamo Token lies the price of the specified item.
+- Food Item Guide:
+  - Onigiri replenishes 1 hunger point.
+  - Chicken plate replenishes 2 hunger points.
+  - Cheesecake replenishes 10 hunger points.
+- Purchasing an item will allow it to appear in the user's inventory.
+
+### 🌇 **Inventory**
+
+The user's inventory allows for items to be stored and used when the user desires. The user can utilize the "Select" button next to the background of their choice to apply the background to their Tamo! If the user selects a food item, they can utilize the "Feed" button to feed the Tamo. This view also allows the user to read up on the items they have in their inventory.
+
+<p align="center">
+  <img src="./README%20Assets/Inventory.png" width="75%"/>
+</p>
+
+### 📈 **Statistics**
+
+- View your statistics while using TamoStudy!
+
+<p align="center">
+  <img src="./README%20Assets/Statistics.png" width="70%"/>
+</p>
+
+- TamoStudy tracks daily, monthly, and all-time focus. The user can highlight over the boxes at the bottom to track how long they have studied in the past.
+
+### 🥇 **Achievements**
+
+- Unlock achievements during your use of TamoStudy!
+
+<p align="center">
+  <img src="./README%20Assets/Achievements.png" width="70%"/>
+</p>
+
+- The following is a list of achievements you can earn in TamoStudy:
+  1. **The Beginning** - Achieve total focus time of 24 hours.
+  2. **Nothing can stop us!** - Achieve total focus time of 72 hours.
+  3. **Never give up!** - Achieve total focus time of 240 hours.
+  4. **Focus Ascension** - Achieve total focus time of 1200 hours.
+  5. **Cosmetics** - Purchase and change your Tamo's border.
+  6. **Scenery Change** - Purchase and change your Tamo's background.
+  7. **From the Beginning** - Update profile from previous TamoStudy release.
+  8. **Tamo Full** - Achieve maximum Tamo hunger.
+  9. **Tamo Love** - Achieve maximum Tamo happiness.
+  10. **Dedicated** - Focus for 1+ hours for 3 days consecutively.
+  11. **Building Consistency** - Focus for 1+ hours for 7 days consecutively.
+  12. **Tamo Scholar** - Focus for 1+ hours for 30 days consecutively.
+
+### ⚙️ **Settings**
+
+- Change the settings of TamoStudy to match your preferences!
+
+<p align="center">
+  <img src="./README%20Assets/Settings.png" width="70%"/>
+</p>
+
+- For Windows users only, there is an option to toggle Discord Rich Presence.
+
+### 📖 **Tamo History**
+
+- Upon a Tamo being deceased, a new feature has been introduced where you can view your previous Tamos.
+
+<p align="center">
+  <img src="./README%20Assets/TamoHistory.png" width="70%"/>
+</p>
+
+### 🤖 Discord Rich Presence
+This implementation utilizes the [DiscordRPC JAR](https://github.com/Vatuu/discord-rpc). <u>Discord Rich Presence is only supported on **Windows** devices</u>. Development in the future will be explored so that macOS devices are supported.
+- This feature can be enabled or disabled on Windows devices in the settings menu. A refresh of the application may need to be taken depending on whether you turn it on or off.
+- The following is a collection of images that your status can be expected to show while using TamoStudy with Discord Rich Presence:
+
+<p align="center">
+  <img src="./README%20Assets/DiscordRPC.png" width="70%"/>
+</p>
+
+- Note: If your computer is utilizing a lot of RAM / CPU power while using TamoStudy, it is recommended that you turn off the Discord RPC feature from the settings menu to improve performance.
+
+## 🛠️ **Setup TamoStudy**
+
+### 📃 Requirements
+
+1. Supported Operating Systems
+
+      TamoStudy has been tested on the following operating systems:
+      - Windows XP, 10, 11
+      - Linux (Ubuntu 20.04 LTS)
+      - macOS (Monterary, Ventura)
+
+2. Java Runtime Environment
+
+    TamoStudy was developed utilizing the Java programming language. An installation of the Java Runtime Environment is required to run Java applications. TamoStudy runs on Java 8. A download for Java can be found [here](https://www.java.com/en/download/).
+
+### 🛜 **Downloading TamoStudy**
+
+To download TamoStudy, read through the download page [here](https://github.com/narlock/TamoStudy/releases) and select the proper TamoStudy file to download corresponding to your operating system from this page. This file contains the entire application and can be opened utilizing the Java Runtime Environment.
+
+- **Windows**
+  - Download the `TamoStudy.exe` file.
+  - Upon opening for the first time, you will be required to give permission to open this application through the Windows Smart Screen. Simply allow trust the program to run.
+
+- **Mac OS**
+  - Download the `TamoStudy.MacOS.zip` file.
+  - Extract the contents of the zip file.
+  - Open the application, then given permissions by searching **Gatekeeper** in Settings. Trust the application, then re-open the application.
+
+- **Linux**
+  - There is no native Linux binary for TamoStudy. Instead, Linux users can utilize the `TamoStudy.JAR` file (which Windows & MacOS can both utilize as well if they choose to).
+  - Upon download, you will need to provide execute permissions to run the program.
+
+## 💡 **Original Concept Idea**
+
+I wanted a way to record the amount of time I spent focused every day. At the time, I was cleaning through my room and found my Tamagotchi that I used to play with when I was very young. I thought that implementing a Tamagotchi-like pet into a focus timer would be a good idea. The more I focus and get my work done, the more upgrades and new things I can do with the virtual pet (in my project, it's called a Tamo).
+
+Project plans to include a GUI in which a user can create a username and password along with give a name for their Tamo. The user can re-load this information so they can load where they left off in their studies. (Keeping the total amount of time they have focused, and their previous Tamo alive)
+
+The Focus GUI will have a set timer (minutes and seconds) the user can choose. When the user begins the Focus session, the timer will count down (this is the time where the user will work). After the timer is up, the session will be completed, and the Tamo will gain experience and happiness, and the user will gain money.
+
+## 🌟 **Contributors**
+
+Thank you for everyone that has created a pull request to support the development of TamoStudy!
+
+- [Shorent](http://github.com/Shorent) - Development (Web)
+- [Alyksett](http://github.com/Alyksett) - Development (Main)
+- [britthubs](http://github.com/britthubs) - Translation (Main)
+- [tokisuno](http://github.com/tokisuno) - Translation (Main)
+
+And everyone else that has contributed outside of GitHub pull requests!
+
+<hr>
+<p align="center">
+TamoStudy was created on January 30th, 2021 as a personal and free app! • Developed by <a href="https://github.com/narlock">narlock</a><br>
+<i>TamoStudy software applications reached over 1,000 total downloads on August 29th, 2022</i> <br>
+</p>

TamoStudy/.classpath

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
+		<attributes>
+			<attribute name="module" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="src" path="assets"/>
+	<classpathentry kind="lib" path="discord-rpc.jar"/>
+	<classpathentry kind="lib" path="json-simple-1.1.1.jar"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>

TamoStudy/.gitignore

@@ -0,0 +1,3 @@
+/bin/
+*.class
+bin/

TamoStudy/.project

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>TamoStudy</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+	<filteredResources>
+		<filter>
+			<id>1671906157267</id>
+			<name></name>
+			<type>30</type>
+			<matcher>
+				<id>org.eclipse.core.resources.regexFilterMatcher</id>
+				<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments>
+			</matcher>
+		</filter>
+	</filteredResources>
+</projectDescription>

TamoStudy/.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,14 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
+org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.debug.lineNumber=generate
+org.eclipse.jdt.core.compiler.debug.localVariable=generate
+org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning
+org.eclipse.jdt.core.compiler.release=disabled
+org.eclipse.jdt.core.compiler.source=1.8

TamoStudy/src/TamoStudy.java

@@ -0,0 +1,20 @@
+import gui.WelcomeGUI;
+import resources.Debug;
+
+/**
+ * Runner - TamoStudy
+ * 
+ * @author Anthony Narlock (narlock)
+ * 
+ * @brief The main class that instantiates
+ * the welcome GUI for TamoStudy
+ */
+
+public class TamoStudy {
+
+	public static void main(String[] args) {
+		Debug.info("TamoStudy.main", "TamoStudy program starting to run.");
+		new WelcomeGUI();
+	}
+
+}