<!--Software that automatically downloads cards from various idol or idol-adjacent gacha mobile games.-->
# Mikan
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)
Mikan automatically downloads cards from various idol or idol-adjacent gacha mobile games.
The following games are currently supported:
- Love Live! School Idol Festival (via [School Idol Tomodachi](https://schoolido.lu/))
- Love Live! School Idol Festival ALL STARS (via [Idol Story](https://idol.st/))
- Love Live! School Idol Festival 2 (via [Idol Story](https://idol.st/))
- BanG Dream! Girls Band Party! (via [Bandori Party](https://bandori.party/))
- Revue Starlight -Re LIVE- (via [Starlight Academy](https://starlight.academy/))
- IDOLM@STER Cinderella Girls Starlight Stage (via [Cinderella Producers](https://cinderella.pro/))
## Installation
To install Mikan, you need to install `pipx` ([see instructions](https://pypa.github.io/pipx/installation/)) 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](https://www.python.org/)>=3.10 and [Poetry](https://python-poetry.org/))
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:
```cfg
# 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
- [PyPI](https://pypi.org/project/mikan-card-downloader/)
- [GitHub](https://github.com/DemonicSavage/mikan)
Raw data
{
"_id": null,
"home_page": "https://www.demonicsavage.com/projects/mikan",
"name": "mikan-card-downloader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "sif,sifas,lovelive,mikan,downloader,bandori,bangdream,idolmaster,revuestarlight,imas",
"author": "DemonicSavage",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d6/5f/93036ba41cc1f14221276cf682a5ea2ad954e202dec479955e506d7e54e2/mikan_card_downloader-3.1.2.tar.gz",
"platform": null,
"description": "<!--Software that automatically downloads cards from various idol or idol-adjacent gacha mobile games.-->\n# Mikan\n\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n[](https://sonarcloud.io/summary/new_code?id=DemonicSavage_sifas_card_downloader)\n\nMikan automatically downloads cards from various idol or idol-adjacent gacha mobile games.\n\nThe following games are currently supported:\n\n- Love Live! School Idol Festival (via [School Idol Tomodachi](https://schoolido.lu/))\n- Love Live! School Idol Festival ALL STARS (via [Idol Story](https://idol.st/))\n- Love Live! School Idol Festival 2 (via [Idol Story](https://idol.st/))\n- BanG Dream! Girls Band Party! (via [Bandori Party](https://bandori.party/))\n- Revue Starlight -Re LIVE- (via [Starlight Academy](https://starlight.academy/))\n- IDOLM@STER Cinderella Girls Starlight Stage (via [Cinderella Producers](https://cinderella.pro/))\n\n## Installation\n\nTo install Mikan, you need to install `pipx` ([see instructions](https://pypa.github.io/pipx/installation/)) and then run `pipx install mikan-card-downloader`.\n\nTo update it, run `pipx upgrade mikan-card-downloader`.\n\nInstalling through `pip` is also possible, but not recommended, and since Python 3.11 requires the `--break-system-packages` flag.\n\n## Building by source\n\n(Note: this software requires [Python](https://www.python.org/)>=3.10 and [Poetry](https://python-poetry.org/))\n\n1. Clone this GitHub repository (`git clone https://github.com/DemonicSavage/mikan.git`)\n2. Go to the `mikan` directory (`cd mikan` on Unix).\n3. Run `poetry install` to grab the necessary dependencies.\n\n## Configuration\n\nThe configuration file currently has the following options:\n\n```cfg\n# Path for the downloaded cards\n[Paths]\ndata_dir = ~/Idol_Cards\n\n# Other options\n[Other]\n# Formerly needed for SIF2 support\ncookie = your_sessionid_cookie\n# Maximum concurrent connections, default is 10\nmax_connections = 10\n```\n\nYou can find this file in `$XDG_CONFIG_HOME/mikan` on Linux, `%APPDATA%\\Local\\mikan\\mikan` on Windows, or `/Library/Application Support/mikan` on macOS.\n\n## Usage\n\nThis 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.\n\nBy default, running `mikan` without any arguments will create metadata and then download SIF2 cards.\n\nArguments can be passed to `mikan` to download cards from other games. Run `mikan --help` to see what arguments are available.\n\n~~Note that for now, you need a `sessionid` cookie for an Idol Story account with beta-testing enabled for SIF2 support.~~\nThis is no longer the case.\n\nRunning it for the first time will prompt you for the directory cards and stills should be downloaded to.\n\n## License\n\nThis software is released under the GNU GPLv3 license, and its dependencies are released under their respective licenses.\n\n# Links\n\n- [PyPI](https://pypi.org/project/mikan-card-downloader/)\n- [GitHub](https://github.com/DemonicSavage/mikan)\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Downloads cards and stills from SIFAS and SIF.",
"version": "3.1.2",
"project_urls": {
"Homepage": "https://www.demonicsavage.com/projects/mikan",
"Repository": "https://github.com/demonicsavage/mikan"
},
"split_keywords": [
"sif",
"sifas",
"lovelive",
"mikan",
"downloader",
"bandori",
"bangdream",
"idolmaster",
"revuestarlight",
"imas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa2093c0182c44ed71314066d6387ad61387e5688c164f193453ee0f3bd530f7",
"md5": "0477a9583cd14ed2f1a55e17f03142d8",
"sha256": "d184d0e40cadcbd4da617f780780c339e5a5c9ca2f93c7e35c84b7bc3d1819b7"
},
"downloads": -1,
"filename": "mikan_card_downloader-3.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0477a9583cd14ed2f1a55e17f03142d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 30062,
"upload_time": "2024-02-18T17:54:57",
"upload_time_iso_8601": "2024-02-18T17:54:57.831369Z",
"url": "https://files.pythonhosted.org/packages/fa/20/93c0182c44ed71314066d6387ad61387e5688c164f193453ee0f3bd530f7/mikan_card_downloader-3.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d65f93036ba41cc1f14221276cf682a5ea2ad954e202dec479955e506d7e54e2",
"md5": "05e6dd980957e5483a6704263263520e",
"sha256": "821c60a860107253ffeefaf98bfdc3d964937d300a09bec7a0969a3a3c82099b"
},
"downloads": -1,
"filename": "mikan_card_downloader-3.1.2.tar.gz",
"has_sig": false,
"md5_digest": "05e6dd980957e5483a6704263263520e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 22090,
"upload_time": "2024-02-18T17:54:59",
"upload_time_iso_8601": "2024-02-18T17:54:59.663544Z",
"url": "https://files.pythonhosted.org/packages/d6/5f/93036ba41cc1f14221276cf682a5ea2ad954e202dec479955e506d7e54e2/mikan_card_downloader-3.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-18 17:54:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "demonicsavage",
"github_project": "mikan",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "mikan-card-downloader"
}
JSON
