Skip to main content

Downloads cards and stills from SIFAS and SIF.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mikan_card_downloader-3.3.1.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mikan_card_downloader-3.3.1-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file mikan_card_downloader-3.3.1.tar.gz.

File metadata

  • Download URL: mikan_card_downloader-3.3.1.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.14.4 Linux/6.18.26-1-cachyos-lts

File hashes

Hashes for mikan_card_downloader-3.3.1.tar.gz
Algorithm Hash digest
SHA256 479fb17a4a37ebef1f7b25b28ac817459fc23220e263864f5af1a6bd953ed94f
MD5 a7f5677af3f0be4eacd1e13dc0486fc2
BLAKE2b-256 62bee22af2f068e47a4021d693ca18931cd2e78d892c473dc90697ade7959891

See more details on using hashes here.

File details

Details for the file mikan_card_downloader-3.3.1-py3-none-any.whl.

File metadata

  • Download URL: mikan_card_downloader-3.3.1-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.14.4 Linux/6.18.26-1-cachyos-lts

File hashes

Hashes for mikan_card_downloader-3.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3e459147538158da359185133d06af2cd63baa27c040eb66102ce9afb30285a2
MD5 f9a41ec0724ebbc98b747ac9fa70e966
BLAKE2b-256 06e8d63552edbe989b721c29ade657ffdbc7cc971dc9d5a07e1360d6ca1fd9a2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page