Skip to main content

Mikan

Quality Gate Status Coverage Bugs Vulnerabilities Duplicated Lines (%) Reliability Rating Technical Debt Lines of Code Code Smells Maintainability Rating Security Rating

Mikan automatically downloads cards from various idol or idol-adjacent gacha mobile games.

The following games are currently supported:

Installation

To install Mikan, you need to install pipx (see instructions) and then run pipx install mikan-card-downloader.

To update it, run pipx upgrade mikan-card-downloader.

Installing through pip is also possible, but not recommended, and since Python 3.11 requires the --break-system-packages flag.

Building by source

(Note: this software requires Python>=3.10 and Poetry)

  1. Clone this GitHub repository (git clone https://github.com/DemonicSavage/mikan.git)
  2. Go to the mikan directory (cd mikan on Unix).
  3. Run poetry install to grab the necessary dependencies.

Configuration

The configuration file currently has the following options:

# Path for the downloaded cards
[Paths]
data_dir = ~/Idol_Cards

# Other options
[Other]
# Formerly needed for SIF2 support
cookie = your_sessionid_cookie
# Maximum concurrent connections, default is 10
max_connections = 10

You can find this file in $XDG_CONFIG_HOME/mikan on Linux, %APPDATA%\Local\mikan\mikan on Windows, or /Library/Application Support/mikan on macOS.

Usage

This is a command line script. It first creates (or updates) a metadata file about the available cards (items.json), and then downloads the image files themselves.

By default, running mikan without any arguments will create metadata and then download SIF2 cards.

Arguments can be passed to mikan to download cards from other games. Run mikan --help to see what arguments are available.

Note that for now, you need a sessionid cookie for an Idol Story account with beta-testing enabled for SIF2 support. This is no longer the case.

Running it for the first time will prompt you for the directory cards and stills should be downloaded to.

License

This software is released under the GNU GPLv3 license, and its dependencies are released under their respective licenses.

Links

Metadata

Release files for mikan-card-downloader 3.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mikan-card-downloader 3.3.1
File Size Uploaded
mikan_card_downloader-3.3.1.tar.gz 21.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mikan-card-downloader 3.3.1
File Interpreter ABI Platform
mikan_card_downloader-3.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 52.8 kB

Release files / mikan_card_downloader-3.3.1.tar.gz

Download URL mikan_card_downloader-3.3.1.tar.gz
Size 21.8 kB
Tags Source
SHA-256 checksum
How to use checksums
479fb17a4a37ebef1f7b25b28ac817459fc23220e263864f5af1a6bd953ed94f
BLAKE2b-256 checksum
How to use checksums
62bee22af2f068e47a4021d693ca18931cd2e78d892c473dc90697ade7959891
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.14.4 Linux/6.18.26-1-cachyos-lts

Release files / mikan_card_downloader-3.3.1-py3-none-any.whl

Download URL mikan_card_downloader-3.3.1-py3-none-any.whl
Size 31.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3e459147538158da359185133d06af2cd63baa27c040eb66102ce9afb30285a2
BLAKE2b-256 checksum
How to use checksums
06e8d63552edbe989b721c29ade657ffdbc7cc971dc9d5a07e1360d6ca1fd9a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.14.4 Linux/6.18.26-1-cachyos-lts

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page