Skip to content

A solution designed for storing, tagging, and searching anime images, animations and videos. It automatically fetches and updates tags from booru sites, allows users to work with stored media locally.

Notifications You must be signed in to change notification settings

ImoutoChan/ImoutoRebirth

Repository files navigation

EN | RU

Important

I recently open-sourced the program that I wrote myself and used for many years. Installation instructions are checked on a clean Windows 10 and should be ok, but if you have any problems feel free to create a discussion or an issue. I'm also planning to upload a video with a demo of the installation process in near future, it should help a little.

Content

What is ImoutoRebirth

ImoutoRebirth is a solution for organizing media files with a focus on anime images. It is inspired and deeply integrated with sites such as danbooru.donmai.us, yande.re, gelbooru.com, rule34.xxx.

I started writing it for myself many years ago because I am an avid image saver. Over time, different functions came together into a comprehensive solution, and I decided to publish it.

ImoutoRebirth will be most useful for those who love saving images (a lot of images) and then want to be able to sort through and find the ones they need, which is usually extremely challenging without tags.

Key features:

  • Collections of files (images, videos, GIFs)
  • Supported formats include
    • jpg, jpeg, png, bmp, tiff, apng, gif, webp, jfif
    • mp4, mov, webm, wmv, mov, m2ts, mpg, mpeg, mkv, f4v, flv, avi, m4v, swf
    • zip as pixiv ugoira
  • Background search and updating of tags for your images and metadata based on file hash from danbooru, sankaku, yande.re, gelbooru, rule34
  • Local search for saved files and their tags
  • Bulk tagging of files
  • Display of notes from boorus on local images
  • Automatic download of favorites from boorus to your collection
  • Highlighting of saved images in the browser

What does ImoutoRebirth look like

There are two Windows desktop applications available for you.

Imouto Navigator

For viewing and managing collections, and tagging. It's essentially an explorer.

Imouto Navigator

ImoutoRebirth Viewer

For viewing individual images. Its use is not mandatory, you can use your favorite image viewer, but Imouto Viewer allows you to read Notes from booru (usually these are translations of text in images), view and add your own tags.

Imouto Navigator

Installation

Video guide with installation and initial configuration: https://youtu.be/rEg0WMQgmoE

[NEW] Video guide with first launch, collection configuration, demo some features, Imouto Extensions demo: https://youtu.be/7Gnbc3296GU

The main idea of the app is that you have different collections with media that store your images/videos. After installation, you have to set up this collection in ImoutoNavigator app. Each collection has source folders and (optionally) a destination folder. The app monitors each source folder, takes files from there, processes them, and moves them to the destination folder. After that files are observable in ImoutoNavigator app. Installation itself looks like this:

  1. Download ImoutoRebirth.exe to any folder from latest release
  2. Run it (this is a self-extracting 7z archive), it will unpack the application into the version folder, copy the path to this folder
  3. Edit configuration.json, filling it with your data, I recommend filling in at least Danbooru and Yandere login info. But in the worst case you can leave everything at defaults.
  4. Run Powershell as an administrator
  5. Execute these commands:
Set-ExecutionPolicy Bypass -Scope Process -Force;
cd <path to the latest folder>

This one will install postgres, .net runtime (can take some time, especially for Postgres)

./install-dependencies.ps1

This one will install or update the application itself

./install-update.ps1
  1. Optionally, you can install the Chrome extension, which will highlight saved images and their relatives. Link to the extension

Configuration

configuration.json

Template and default values

{
  "DanbooruLogin": "",
  "DanbooruApiKey": "",
  "SankakuLogin": "",
  "SankakuPassword": "",
  "YandereLogin": "",
  "YandereApiKey": "",
  "RoomPort": "11301",
  "LilinPort": "11302",
  "KekkaiPort": "11303",
  "HarpySavePath": "",
  "HarpyFavoritesSaveJobRepeatEveryMinutes": "1",
  "KekkaiAuthToken": "",
  "LilinConnectionString": "Server=localhost;Port=5432;Database=LilinProd;User Id=postgres;Password=postgres;",
  "MeidoConnectionString": "Server=localhost;Port=5432;Database=MeidoProd;User Id=postgres;Password=postgres;",
  "RoomConnectionString": "Server=localhost;Port=5432;Database=RoomProd;User Id=postgres;Password=postgres;",
  "MassTransitConnectionString": "Server=localhost;Port=5432;Database=masstransit;User Id=postgres;Password=postgres;",
  "MeidoMetadataActualizerRepeatEveryMinutes": "5",
  "MeidoFaultToleranceRepeatEveryMinutes": "10080",
  "MeidoFaultToleranceIsEnabled": "true",
  "RoomImoutoPicsUploadUrl": "",
  "InstallLocation": "C:\\Program Files\\Imouto",
  "OpenSearchUri": "http://localhost:9200/"
}
Parameter Required Comment
DanbooruLogin Optional but recommended, only if you want ImoutoRebirth to search tags for your files in danbooru
DanbooruApiKey Optional but recommended, you can find it at the end of your danbooru profile page, API Key row
SankakuLogin Optional, your sankaku login
SankakuPassword Optional, your sankaku password
YandereLogin Optional but recommended, only if you want ImoutoRebirth to search tags for your files in yandere
YandereApiKey Optional but recommended, you can find it in Profile / Settings
RoomPort * Room service will be exposed through this port
LilinPort * Lilin service will be exposed through this port
KekkaiPort * Kekkai service will be exposed through this port
HarpySavePath Optional, Service will automatically save your likes from configured boorus to this path. If you point it to your collection from Room, you will get liked images from booru automatically
HarpyFavoritesSaveJobRepeatEveryMinutes * Interval in minutes, in which the service will check for new liked images
KekkaiAuthToken * Place here random string (you can generate new guid or something)
LilinConnectionString * Connection string for Lilin service to the postgres database
MeidoConnectionString * Connection string for Meido service to the postgres database
RoomConnectionString * Connection string for Room service to the postgres database
MassTransitConnectionString * Connection string for MassTransit SQL transport (replacement for rabbit mq)
MeidoMetadataActualizerRepeatEveryMinutes * Meido service will request actualization from Danbooru and Yandere in specified interval
MeidoFaultToleranceRepeatEveryMinutes * Meido service will request tags for failed files in specified interval
MeidoFaultToleranceIsEnabled * Meido service will repeat tag request for failed file
RoomImoutoPicsUploadUrl Optional, callback that will be called for every saved file
InstallLocation * Installation location for ImoutoRebirth
OpenSearchUri Optional, logging to open search

ImoutoRebirth Architecture

Beyond the two applications mentioned earlier, ImoutoRebirth internally consists of a bunch of services, each with its own function. These will be installed automatically, and no particular knowledge about them is required. However, for the inquisitive, this section describes the inner workings and purposes of different services, as well as their dependencies. If you follow the installation instructions above, these services will be automatically installed as Windows Services. Also, for the system to operate, Postgres will be needed. You can install it independently or use the scripts provided with each release.

You can overview the basic architecture and the interaction of services in greater detail in this diagram, open it with diagrams.net or draw.io.

ImoutoRebirth.Room

This service is responsible for interacting with the file system. It is the one that stores your collections, moves files, checks for duplicates, calculates and compares md5 hashes. Configuring collections from Imouto Navigator calls methods specifically in it.

ImoutoRebirth.Arachne

This service handles interactions with the outside world and collects tags and metadata. Receiving tasks asynchronously (for instance, when you save a new file), it accesses the known sites and downloads tags, notes, and metadata from them. It also manages tag updates, tracking changes that the sites typically publish as a feed. Ideally, you should always have up-to-date tags locally, just like on the websites.

ImoutoRebirth.Lilin

This service is responsible for storing and searching tags. The results of Arachne's work and the tags you add yourself are stored here.

ImoutoRebirth.Meido

This coordinating service monitors the processes occurring in the system and assigns tasks to Arachne for searching or updating tags.

ImoutoRebirth.Harpy

This mini-service downloads favs from your site accounts and stores them in the specified folder.

ImoutoRebirth.Kekkai

This API gateway proxies requests to internal services and allows you to check whether specific images are stored in the system. For example, Imouto Extensions uses it.

ImoutoRebirth.Tori

This service won't run or be installed in your system, as it's an updater service for the new version.

Imouto.Viewer

The app that you can use to browse images individually, supports local tags, notes, slideshow, fixed zoom, and more.

Imouto.Extensions

The chrome extension, that will highlight saved images and their relatives.

About

A solution designed for storing, tagging, and searching anime images, animations and videos. It automatically fetches and updates tags from booru sites, allows users to work with stored media locally.

Topics

Resources

Stars

Watchers

Forks