Skip to content

fulcrum6378/fortuna

Repository files navigation

Fortuna

A free and open-source application based on the philosophy of Evaluative Hedonism.

This app simply lets you record a mean amount of pleasure and pain you feel everyday in a scale between -3 up to +3 for each day in your desired calendar system (Gregorian or etc).

Alternatively you can estimate the score of a whole month using the field right next to the year field at the top of the page. Then you can see how much pleasure and pain you've sensed overall in your life or in a particular month.

You can also use this app as a diary and record your daily life events and also set emojis for days and months. This app is also equipped with advanced searching and navigating tools so you'll know exactly when what happened.

screenshot-1 screenshot-2 screenshot-3

VITA Markup Language

Vita means life in Latin. Fortuna reads and writes its data in *.vita plain text file format. It defines data separated by months and every month is separated using a line break;
At the beginning of each month, there is a "@" symbol and then year and month number; for example: @2022.03
You can optionally enter a "~" symbol and define an estimated score for the whole month which will apply only on days with no specific score; for example @2022.03~3
After a line break, there come scores for each date. By default, first line indicates day 1 in that month and line 2 indicates day 2; for example: 0
Except if you want to skip some days and jump to another day, then you'll have to explicitly specify the number of that day; for example: 5:0
Note that entering each day is optional, and you can even define a month with no days.
After each day and even the month itself you can optionally enter two more values:

  1. An emoji for that day or month after a ";" symbol.
  2. Some descriptions for that day or month after ANOTHER ";" symbol.

Here is a complete example:

@2021.09~-0.5;⛓;Spent the whole month in the military...
8:-0.5;;The idea of a developing such an app came to my mind and I named it "Hedonometer" which I later called it "Fortuna".

@2022.03~0
24:1.5;🧠;Started Fortuna Android project at 10:32:21!
2
2
2
1.5
2
2.5
2;🧠;FORTUNA IS READY!!! (it used JSON to store its data)

@2022.08
3:1;;Invented VITA file format and then migrated Fortuna to it.

Structure of the Source Code

The app is divided into two modules:

  • core: abstract Fortuna capabilities for any Java-based platform
  • android: the Android application which uses the core module
  • web: the web version of Fortuna as a single-page application

Main classes

  • Vita.kt (core) : reads and writes Vita files and includes all the related utilities

  • Fortuna.kt : the Application subclass implementing FortunaContext

  • Main.kt : the main and only Activity instance in this app, implementing MainPage

  • Nyx.kt : a BroadcastReceiver that performs a few tasks at 12 AM; including:

    1. Updating any available views according to the new date
    2. Reminding the user to score their day if they haven't yet
    3. Backing up Vita locally and in the cloud

Subpackages

  • base (core) : base classes for any imaginable Fortuna app
  • sect : internal and external sections of this app
  • util : general-purpose utilities

Add your own calendar

If you don't wanna use the Gregorian calendar, you can use Fortuna in your regional calendar system. Fortuna requires a subclass of java.time.chrono.Chronology. In Fortuna, build flavours represent calendar systems, so all you need to do is to:

  1. Add a new build flavour for Gradle
  2. Create "android/src/res_CALENDAR" (e.g. res_indian) and inside it:
    • drawable/today_widget_preview.png : a preview for TodayWidget
    • values/strings.xml : month names as
  3. Attribute that build flavour to your Calendar class in Fortuna.kt.
android {
    //...
    productFlavors {
        //...
        create("indian") { applicationIdSuffix = ".indian" }
    }
    //...
    sourceSets.getByName("indian") {
        res.setSrcDirs(listOf("src/res", "src/res_indian"))
    }
    //...
}
override val chronology: Chronology = when (BuildConfig.FLAVOR) {
    //...
    "indian" -> IndianChronology.INSTANCE
    //...
}

res_indian/values/string.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string-array name="luna">
        <item>Chaitra</item>
        <item>Vaisakha</item>
        <item>Jyeshtha</item>
        <item>Ashadha</item>
        <item>Shravana</item>
        <item>Bhadra</item>
        <item>Ashvin</item>
        <item>Kartika</item>
        <item>Agrahayana</item>
        <item>Pausha</item>
        <item>Magha</item>
        <item>Phalguna</item>
    </string-array>
</resources>

Server

This Android app also can create an HTTP server and serve a single-page application using which you can interact directly with data stored in the Android Fortuna itself.

License

Fortuna - an application of Evaluative Hedonism
Written in 2022-2026 by Mahdi Parastesh <fulcrum1378@gmail.com>

To the extent possible under law, the author has dedicated all copyright and
related and neighboring rights to this software to the public domain worldwide.
This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software.
If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.

About

A free and open-source application based on the philosophy of Evaluative Hedonism. It lets you score your mood everyday in your desired calendar, you can also set specific emojis for days or months and write some notes as a diary.

Topics

Resources

License

Stars

Watchers

Forks

Contributors