<p align="center">
<img src="https://raw.githubusercontent.com/DEViantUA/HSRCard/main/Documentation/Banner.png" alt="Banner"/>
</p>
# HSRCard
Add-on module for generating Honkai Star Rail character cards in EnkaNetwork style
* [EnkaNetwork](https://enka.network/)
* [MiHoMo](https://discord.gg/SXwqeEqeEY)
* [StarRailCard](https://github.com/DEViantUA/StarRailCard)
---
* Python 3.9
* Pillow 10.0.1
* cachetools 5.3.1
* honkairail 1.1.0
---
## Installation:
```
pip install hsrcard
```
## Launch:
```py
# Import necessary modules
from hsrcard import hsr
import asyncio
# Define the main function that fetches information about a player using a specified UID
async def main(uid):
async with hsr.HonkaiCard() as hmhm:
result = await hmhm.creat(uid)
print(result)
asyncio.run(main(700649319))
```
<details>
<summary>print(result)</summary>
* Output explanation:
* settings:
* uid=800293940 - UID (unique identifier) of the player is 800293940.
* lang='en' - the game language is set to English.
* hide=False - player profile information is not hidden.
* save=True - information saving setting is enabled.
* background=None - no background image.
---
* player:
* uid='700649319' - player's UID is 700649319.
* nickname='Korzzex' - player's nickname is "Korzzex".
* level=69 - player's level is 69.
* avatar - information about the player's avatar:
* id='201212' - avatar identifier.
* name='Jingliu' - avatar name is "Jingliu".
* icon - URL of the avatar image.
* signature="----".
* friend_count=39 - the player has 39 friends.
* world_level=6 - player's world level is 6.
---
* card (list of player's character cards):
* Card(id='1212', name='Jingliu', rarity=5, card=<PIL.Image.Image ...): Information about the "Jingliu" character card:
* id='1212' - card identifier.
* name='Jingliu' - character name.
* rarity=5 - card rarity is 5.
* card - card image.
* (similar entries for other character cards).
---
* name - list of character names separated by commas: "Jingliu, Silver Wolf, Seele, Luocha".
---
* id - list of character card identifiers separated by commas: "1212, 1006, 1102, 1203".
</details>
# Example
<details>
<summary>Example Splash Art</summary>
[![Adaptation][1]][1]
[1]: https://raw.githubusercontent.com/DEViantUA/HSRCard/main/Documentation/splash.png
</details>
<details>
<summary>Example User Art</summary>
[![Adaptation][2]][2]
[2]: https://raw.githubusercontent.com/DEViantUA/HSRCard/main/Documentation/adapt.png
</details>
## Languages Supported
| Languege | Code | Languege | Code | Languege | Code |
|-------------|---------|-------------|---------|-------------|---------|
| English | en | русский | ru | Chinese | chs |
| Tiếng Việt | vi | ไทย | th | Taiwan | cht |
| português | pt | 한국어 | kr | deutsch | de |
| 日本語 | jp | 中文 | zh | español | es |
| 中文 | zh | Indonesian | id | français | fr |
| Українська | ua | | | | |
# Thank the author for the code:
* **Patreon**: https://www.patreon.com/deviantapi
Raw data
{
"_id": null,
"home_page": "https://github.com/DEViantUA/StarRailCard",
"name": "hsrcard",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "honkai,cards,generation,honkaistarraill,raill,starraill,builds",
"author": "None",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/61/38/6edff448bd910a98193eb68b8fa64d85f5da5509d2e4014ba374688bcc50/hsrcard-1.0.3.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/DEViantUA/HSRCard/main/Documentation/Banner.png\" alt=\"Banner\"/>\n</p>\n\n# HSRCard\nAdd-on module for generating Honkai Star Rail character cards in EnkaNetwork style\n\n* [EnkaNetwork](https://enka.network/)\n* [MiHoMo](https://discord.gg/SXwqeEqeEY)\n* [StarRailCard](https://github.com/DEViantUA/StarRailCard)\n\n---\n* Python 3.9 \n* Pillow 10.0.1 \n* cachetools 5.3.1\n* honkairail 1.1.0\n---\n\n## Installation:\n```\npip install hsrcard\n```\n\n## Launch:\n```py\n# Import necessary modules\nfrom hsrcard import hsr\nimport asyncio\n\n# Define the main function that fetches information about a player using a specified UID\nasync def main(uid):\n async with hsr.HonkaiCard() as hmhm:\n result = await hmhm.creat(uid)\n print(result)\n\nasyncio.run(main(700649319))\n```\n\n<details>\n<summary>print(result)</summary>\n\n * Output explanation:\n * settings:\n * uid=800293940 - UID (unique identifier) of the player is 800293940.\n * lang='en' - the game language is set to English.\n * hide=False - player profile information is not hidden.\n * save=True - information saving setting is enabled.\n * background=None - no background image.\n ---\n * player:\n * uid='700649319' - player's UID is 700649319.\n * nickname='Korzzex' - player's nickname is \"Korzzex\".\n * level=69 - player's level is 69.\n * avatar - information about the player's avatar:\n * id='201212' - avatar identifier.\n * name='Jingliu' - avatar name is \"Jingliu\".\n * icon - URL of the avatar image.\n * signature=\"----\".\n * friend_count=39 - the player has 39 friends.\n * world_level=6 - player's world level is 6.\n ---\n * card (list of player's character cards):\n * Card(id='1212', name='Jingliu', rarity=5, card=<PIL.Image.Image ...): Information about the \"Jingliu\" character card:\n * id='1212' - card identifier.\n * name='Jingliu' - character name.\n * rarity=5 - card rarity is 5.\n * card - card image.\n * (similar entries for other character cards).\n ---\n * name - list of character names separated by commas: \"Jingliu, Silver Wolf, Seele, Luocha\".\n ---\n * id - list of character card identifiers separated by commas: \"1212, 1006, 1102, 1203\".\n</details>\n\n\n# Example\n<details>\n<summary>Example Splash Art</summary>\n \n[![Adaptation][1]][1]\n \n[1]: https://raw.githubusercontent.com/DEViantUA/HSRCard/main/Documentation/splash.png\n \n</details>\n\n<details>\n<summary>Example User Art</summary>\n \n[![Adaptation][2]][2]\n\n[2]: https://raw.githubusercontent.com/DEViantUA/HSRCard/main/Documentation/adapt.png\n\n</details>\n\n\n## Languages Supported\n| Languege | Code | Languege | Code | Languege | Code |\n|-------------|---------|-------------|---------|-------------|---------|\n| English | en | \u0440\u0443\u0441\u0441\u043a\u0438\u0439 | ru | Chinese | chs |\n| Ti\u1ebfng Vi\u1ec7t | vi | \u0e44\u0e17\u0e22 | th | Taiwan | cht |\n| portugu\u00eas | pt | \ud55c\uad6d\uc5b4 | kr | deutsch | de |\n| \u65e5\u672c\u8a9e | jp | \u4e2d\u6587 | zh | espa\u00f1ol | es |\n| \u4e2d\u6587 | zh | Indonesian | id | fran\u00e7ais | fr |\n| \u0423\u043a\u0440\u0430\u0457\u043d\u0441\u044c\u043a\u0430 | ua | | | | |\n\n\n# Thank the author for the code: \n* **Patreon**: https://www.patreon.com/deviantapi\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Module for generating Honkai Star Rail character cards",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/DEViantUA/StarRailCard",
"Repository": "https://github.com/DEViantUA/StarRailCard"
},
"split_keywords": [
"honkai",
"cards",
"generation",
"honkaistarraill",
"raill",
"starraill",
"builds"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8a4bf07d1cd5cbf56c76afa19da8772f7737f00ce252fc945677c6a7bd7bc60",
"md5": "eb38fbf36f0a887497f2417e2b8a60b9",
"sha256": "ce8fb9aba38b758358c848ec46510cb4e201e185acc18e7ec2482f01590043b0"
},
"downloads": -1,
"filename": "hsrcard-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb38fbf36f0a887497f2417e2b8a60b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 2581865,
"upload_time": "2023-11-04T14:42:03",
"upload_time_iso_8601": "2023-11-04T14:42:03.478029Z",
"url": "https://files.pythonhosted.org/packages/e8/a4/bf07d1cd5cbf56c76afa19da8772f7737f00ce252fc945677c6a7bd7bc60/hsrcard-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61386edff448bd910a98193eb68b8fa64d85f5da5509d2e4014ba374688bcc50",
"md5": "3fce5dea07ab85f3a171d44e56ade8a4",
"sha256": "7165274bedb1b97be01645c462e48bdb71fb4cc9ee31e07e7842c756b47abbd8"
},
"downloads": -1,
"filename": "hsrcard-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "3fce5dea07ab85f3a171d44e56ade8a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 2545612,
"upload_time": "2023-11-04T14:42:10",
"upload_time_iso_8601": "2023-11-04T14:42:10.095379Z",
"url": "https://files.pythonhosted.org/packages/61/38/6edff448bd910a98193eb68b8fa64d85f5da5509d2e4014ba374688bcc50/hsrcard-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-04 14:42:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DEViantUA",
"github_project": "StarRailCard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hsrcard"
}
JSON
