Skip to content
This repository has been archived by the owner on Feb 5, 2024. It is now read-only.

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.

License

narlock/TamoStudy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Instagram YouTube TamoStudy logo

TamoStudy

Latest Release Latest Commit Discord

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. As of February 2024, this application will be marked in a completed state. I currently have no plans to continue development of this application.

🚀 Features

👋 Welcome Screen

An improved program launcher. Allows the user to select either local study and the soon-to-be-developed online study.

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. Global settings and profile information is stored onto the users drive under Documents/TamoStudy in the respective dailyfocus, globalSettings, monthfocus and profiles files. For the Stream version of TamoStudy, settings are stored in Documents/TamoStudyStream with a settings file. JSON loading is done using the JSON-simple library.

👥 Local Profile Loader

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 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.

  • Custom Interval Countdown: Customize the number of minutes and the number of a seconds in a single focus session.

  • 5-Interval Countdown: Easily choose a focus time from a selection of factors of 5 minutes.

  • 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.

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!

  • 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.

📈 Statistics

  • View your statistics while using TamoStudy!

  • 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!

  • 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!

  • 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.

🤖 Discord Rich Presence

This implementation utilizes the DiscordRPC JAR. Discord Rich Presence is only supported on Windows devices. 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:

  • 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.

🛜 Downloading TamoStudy

To download TamoStudy, read through the download page here 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!

And everyone else that has contributed outside of GitHub pull requests!


TamoStudy was created on January 30th, 2021 as a personal and free app! • Developed by narlock
TamoStudy software applications reached over 1,000 total downloads on August 29th, 2022

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Languages