\n\n## About\n\nA Node.js Enka.Network/MiHoMo API wrapper for Honkai: Star Rail.\n\n### Features\n- User Data and Character Stats by UID with Enka.Network API (or with MiHoMo API).\n- All Characters and All Light Cones Data.\n- Cache Updater for the new update of Honkai: Star Rail. (Update characters and light cones immediately.)\n\n\n## Installation\n\n**Node.js 16 or newer is required.**\n\nInstall starrail.js including Star Rail cache data.\n```sh-session\nnpm install starrail.js@latest\n```\n\n Install using ghproxy.com\n \n npm install starrail.js@latest --sr-ghproxy=true\n\n \n\nIf you have already moved the cache to another folder, you can also install without downloading the cache.\n```sh-session\nnpm install starrail.js@latest --sr-nocache=true\n```\n\n## About Star Rail Cache Data\nStar Rail cache data is from [Dimbreath/StarRailData](https://github.com/Dimbreath/StarRailData)\n\nThis data contains data of characters, light cones, materials, and more structure information of Star Rail.\n\nYou can change your cache directory.\n```js\nconst { StarRail } = require(\"starrail.js\");\n\n// Change the directory to store cache data.\n// Default directory is node_modules/starrail.js/cache.\nconst client = new StarRail();\nclient.cachedAssetsManager.cacheDirectoryPath = \"./cache\";\nclient.cachedAssetsManager.cacheDirectorySetup();\n\n// OR\n\nconst client = new StarRail({ cacheDirectory: \"./cache\" });\nclient.cachedAssetsManager.cacheDirectorySetup();\n\n```\n\n### Updating\n\nYou can update your Star Rail cache data.\n```js\nconst { StarRail } = require(\"starrail.js\");\nconst client = new StarRail({ showFetchCacheLog: true }); // showFetchCacheLog is true by default\n\nclient.cachedAssetsManager.fetchAllContents(); // returns promise\n```\n\n\nAlso, you can activate auto cache updater.\n\nWhen using the auto-cache updater, we recommend moving the cache directory directly under your project folder.\n\n```js\nconst { StarRail } = require(\"starrail.js\");\nconst client = new StarRail();\n\nclient.cachedAssetsManager.activateAutoCacheUpdater({\n instant: true, // Run the first update check immediately\n timeout: 60 * 60 * 1000, // 1 hour interval\n onUpdateStart: async () => {\n console.log(\"Updating Star Rail Data...\");\n },\n onUpdateEnd: async () => {\n client.cachedAssetsManager.refreshAllData(); // Refresh memory\n console.log(\"Updating Completed!\");\n }\n});\n\n// // deactivate\n// client.cachedAssetsManager.deactivateAutoCacheUpdater();\n```\n\n# How to use\n\n## Fetching Player Data\n[StarRail#fetchUser](https://starrail.vercel.app/api/class/StarRail#fetchUser)\n```js\nconst { StarRail } = require(\"starrail.js\");\nconst client = new StarRail();\n\nclient.fetchUser(800069903).then(user => {\n console.log(user);\n});\n```\n\n## Star Rail Character List\n[StarRail#getAllCharacters](https://starrail.vercel.app/api/class/StarRail#getAllCharacters)\n```js\nconst { StarRail } = require(\"starrail.js\");\nconst client = new StarRail();\n\nconst characters = client.getAllCharacters();\n// print character names in language \"en\"\nconsole.log(characters.map(c => c.name.get(\"en\")));\n```\n\n## Star Rail Light Cone List\n[StarRail#getAllLightCones](https://starrail.vercel.app/api/class/StarRail#getAllLightCones)\n```js\nconst { StarRail } = require(\"starrail.js\");\nconst client = new StarRail();\n\nconst lightCones = client.getAllLightCones();\n// print light cone names in language \"jp\"\nconsole.log(lightCones.map(w => w.name.get(\"jp\")));\n```\n\nMore examples are available in [example](https://github.com/yuko1101/starrail.js/tree/main/example) folder.\n\nFor more information, please check [Documentation](https://starrail.vercel.app/api/class/StarRail).\n\nYou can see the changelog [here](https://github.com/yuko1101/starrail.js/blob/main/CHANGELOG.md).\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/npm/v/starrail.js.svg?maxAge=3600\")
\n\t\t![\"npm](\"https://img.shields.io/npm/dt/starrail.js.svg?maxAge=3600\")
\n\t\t![](\"https://github.com/yuko1101/starrail.js/actions/workflows/codeql.yml/badge.svg\"/){kind=icon}
\n \t![](\"https://img.shields.io/badge/License-MIT-yellow.svg\"/){kind=icon}
\n\t