https://github.com/badbadbadbadbad/tsundoku

Client-side program to track personal backlog of different types of media
https://github.com/badbadbadbadbad/tsundoku

java javafx sqlite3

Last synced: 3 days ago
JSON representation

Client-side program to track personal backlog of different types of media

• Host: GitHub
• URL: https://github.com/badbadbadbadbad/tsundoku
• Owner: badbadbadbadbad
• License: agpl-3.0
• Created: 2024-09-11T12:38:42.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-01-09T17:32:45.000Z (about 1 month ago)
• Last Synced: 2025-01-09T18:39:40.920Z (about 1 month ago)
• Topics: java, javafx, sqlite3
• Language: Java
• Homepage:
• Size: 40.4 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



# tsundoku

Track your backlog across different types of media.



   

   



## Features

* Data is stored in a local database - no need to make an account or rely on the uptime of some server

* Cuts down on displayed information to provide a cleaner user interface

* Choose between using the original or translated title for Japanese media

* A simplified favourite / like / dislike rating system because score-based rating is a waste of time

## Running

Download the correct version depending on your operating system and extract it. Then,

* Windows: Run `tsundoku.exe`.

* Linux: Execute `tsundoku` from Terminal.

## Uninstalling

Delete the folder you downloaded. To remove your config file and local database generated by tsundoku,

* Windows: Delete `\AppData\Local\tsundoku`.

* Linux: Delete `~/.local/share/tsundoku`.

## Building

**tsundoku** uses a default Java 21.0.4 JDK and is built with [JavaPackager](https://github.com/fvarrui/JavaPackager) and Maven. Note that tsundoku is packaged with Java and all dependencies included, and you will have to provide the proper JDKs to build it. In `pom.xml` in the project's root folder, you may adjust the JavaPackager configuration to adjust the JDK locations used.

Download the source code, extract it, and navigate to the project's root folder. Then,

* Windows: From cmd, run `mvn package -Djavafx.platform=win`.

* Linux: From Terminal, run `mvn package`.

The tsundoku-\-\ archives are the ones provided in the `releases` section of this repository.

## Acknowledgements

**tsundoku** serves as a combined front end for different APIs and data sources and could not work without them.

* Anime: [Jikan API](https://jikan.moe/), which gets the original data from [MyAnimeList](https://myanimelist.net/).