https://github.com/badbadbadbadbad/tsundoku
Client-side program to track personal backlog of different types of media
https://github.com/badbadbadbadbad/tsundoku
apis java javafx sqlite
Last synced: 2 months 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 (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-09T16:46:39.000Z (11 months ago)
- Last Synced: 2025-08-09T18:28:58.944Z (11 months ago)
- Topics: apis, java, javafx, sqlite
- Language: Java
- Homepage:
- Size: 40.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
tsundoku
積読 (tsundoku) — Building up a backlog of books without reading them.
Track your backlog across different types of media, independent of the uptime of servers and websites hosted elsewhere.
## Features
* No forums or similar social features to clutter up pages
* All data in your backlog is stored in a local database, hence always available
* Choose between using the original or translated title for Japanese media
* Rate media as **heart**, **liked**, or **disliked** as score-based rating is a waste of time
## Running
Download the latest (or otherwise desired) version from the [Releases](https://github.com/badbadbadbadbad/tsundoku/releases) section and extract it, then:
* Windows: Run `tsundoku.exe`
* Linux: Execute `tsundoku` from Terminal
## Using
The **Browse** views represent your interaction point with the original data sources, split by media type, letting you check out popular or recent releases as well as search for specific media. Anything you can find here, you may add to your personal log - simply click on the item of your choice, change the personal status dropdown to your desired value, and save the changes.
Each media type uses a different API to acquire data, with all of them (besides anime) requiring API credentials to access. In order to use a service, you will have to generate your own (free) API credentials for it, then enter that data in the Settings view. Be aware that any credentials you enter will be saved in a configuration file on your device, specifically so you are not bound by the uptime of some authentication service.
The **Log** views represent all the media you have consumed or sitting in your backlog, split by media type, letting you track your progress and manage your personal library. Any item that is in your personal log is permanently saved in your local database (unless removed later), meaning that you may interact with your backlog, even if the corresponding media type API or your own internet connection are unavailable. Items are first sorted by personal status, then by personal rating, then alphanumerically.
Upcoming media may have some of their data fields (e.g. release date) unprovided, yet be available to add to your log, which causes incomplete data in your personal database. To remedy this issue, tsundoku will periodically poll the original data sources for updates on any media in your backlog. Hence, it is recommended to leave tsundoku open in the background every so often, giving the program a chance to keep all of your data up to date.
All items in the Browse and Log views change their border colour based on the following colour key:
| Colour | Meaning |
|:------:|---------|
| Gold | Heart rating |
| Green | Liked rating |
| Red | Disliked rating |
| Cyan | Unrated (Browse views) |
| Grey | Unrated (Log views)
Not in backlog (Browse views) |
## Uninstalling
Simply delete the folder you downloaded. To remove the configuration file and local database generated by tsundoku:
* Windows: Delete `\AppData\Local\tsundoku`
* Linux: Delete `~/.local/share/tsundoku`
## Building
tsundoku is built using Maven and JavaPackager. Build scripts for both Windows and Linux are provided to remove the hassle of configuring JavaPackager for your environment.
* Windows: Run `powershell -ExecutionPolicy Bypass -File build-windows.ps1`
* Linux: Run `chmod +x build-linux.sh` to make the script executable, then `./build-linux.sh`
The tsundoku-\-\ archives in the `releases` section of this repository are built the same way.
## Credits
tsundoku serves as a combined front end for data sources and could not work without them.
* Anime: [Jikan API](https://jikan.moe/), which gets the original data from [MyAnimeList](https://myanimelist.net/).