Skip to content

SnekNOTSnake/my-personal-list

Repository files navigation

Markdownify
My Personal List

An app to organize and track your downloaded anime.

Vite Electron React.js TypeScript

UsageFeaturesInstallation and RunningBuilding

Explore

🎭 Who is this app for?

  • People who watch and hoards animations
  • People who want easy finding and organizing their downloaded animations
  • People who want to keep video's metadata (eg encoder, video/audio encoding, etc)
  • People who don't trust external databases
  • People who hate automatons but love tools

If you care about trends, automatons (eg automatically increase track count when you open an episode with VLC), online sharing (eg MAL, AniList, AniDB), in-app torrent, or other online stuffs, this app might not suite you. This is offline-friendly software.

🗡️ Features

Some screenshots are placed inside assets directory.

  • Filter by Tags, Fuzzy Search, or Metadata
  • Tracking
  • Stockpile Insight
  • Watch Scheduling
  • Batch Update
  • Multiple working directories

Roadmap:

  • Fetch animation metadata (eg tags and poster) from AniDB
  • Manga support
  • Series grouping

🚀️ Usage and Conventions

  1. Install the app
  2. Go to settings page
  3. Add folders containing your downloaded series as working directoreis
  4. Start Using The App!

Example Folder Structure

# ❌ BAD

Anime
├── Mushishi
│   ├── Season 1
│   │   ├── 01.mkv
│   │   └── 02.mkv
│   └── Season 2
│       ├── 01.mkv
│       └── 02.mkv
└── Sora no Woto
    ├── 01.mkv
    └── 02.mkv

# ✅ Good

Anime
├── Mushishi 1
│   ├── 01.mkv
│   └── 02.mkv
├── Mushishi 2
│   ├── 01.mkv
│   └── 02.mkv
└── Sora no Woto
    ├── 01.mkv
    └── 02.mkv

Migrating From v1 to v2

For example, your current working directory is E:/Anime.

Anime
├── anime
│   ├── Mushishi 1
│   │   ├── 01.mkv
│   │   └── 02.mkv
│   └── Mushishi 2
│       ├── 01.mkv
│       └── 02.mkv
├── attachments
└── schedule.json
  1. Open your previous working directory (E:/Anime) in your file explorer

  2. Move attachments and schedule.json to your user data directory

    • %APPDATA%/my-personal-list on Windows
    • ~/Library/Application/my-personal-list on MacOS
    • ~/.config/my-personal-list on Linux
  3. Move your series from E:/Anime/anime to E:/Anime.

  4. Open the app, go to the newly created Settings page

  5. Add E:/Anime as one of your new working directories

Conventions

  1. Irregular Series

    All of the series are default to be irregular series, meaning they will not be included in the statistics. Its purpose is to differentiate short anime (eg 3 mins/eps) with regular anime (eg 24 min/eps). To change this, edit the series' regular checkbox.

  2. Episodes Naming

    In order for the system to recognize an episode's number (For "current-episode" highlight), the filename should follow the convention: <number>.<title>.<extension> OR <number>.<extension>. Examples:

    • 01. Resounding Sound - The City at Dawn.mkv
    • 01.mkv
    • 01 - Resounding Sound - The City at Dawn.mkv
    • Ep 01.mkv

⛷️ Running for Development

Before installing this project, make sure you're using the newer version of Node. After that you can install it simply by executing yarn command.

yarn
yarn start

⛰️ Building and Packaging

When you execute below command electron-builder will create an executable package for your OS (I think). If that fails, try to play around with .electron-builder.config.js file and the electron-builder docs.

Building

yarn build

Packaging

Only available after you execute yarn build

# Windows
yarn package:win

# Mac
yarn package:mac

# Linux
yarn package:linux