{"id":23079045,"url":"https://github.com/infinia-yzl/starrail-infinity","last_synced_at":"2025-08-15T21:30:36.805Z","repository":{"id":193684787,"uuid":"689300624","full_name":"infinia-yzl/starrail-infinity","owner":"infinia-yzl","description":"A simple, fully-typed Honkai: Star Rail \"fetcher\" using Bun.","archived":true,"fork":false,"pushed_at":"2023-09-24T19:00:44.000Z","size":135,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-06T11:12:13.970Z","etag":null,"topics":["bun","honkai-api","honkai-star-rail","hsr","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infinia-yzl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-09T11:35:59.000Z","updated_at":"2024-07-21T04:24:37.000Z","dependencies_parsed_at":"2024-11-15T22:43:33.095Z","dependency_job_id":"be9ff920-84d7-4bac-8d2e-743472961428","html_url":"https://github.com/infinia-yzl/starrail-infinity","commit_stats":null,"previous_names":["infinia-yzl/psychic-eureka"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/infinia-yzl/starrail-infinity","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinia-yzl%2Fstarrail-infinity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinia-yzl%2Fstarrail-infinity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinia-yzl%2Fstarrail-infinity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinia-yzl%2Fstarrail-infinity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infinia-yzl","download_url":"https://codeload.github.com/infinia-yzl/starrail-infinity/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinia-yzl%2Fstarrail-infinity/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270631839,"owners_count":24619380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bun","honkai-api","honkai-star-rail","hsr","typescript"],"created_at":"2024-12-16T11:46:16.806Z","updated_at":"2025-08-15T21:30:36.496Z","avatar_url":"https://github.com/infinia-yzl.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌠 StarRail Infinity 🌠\n\n🌠 **StarRail Infinity** is a fan-made **API proxy** to **fetch** and interact with data from [Honkai: Star Rail](https://hsr.hoyoverse.com/). \n\nBuilt with a vision to improve and simplify data access, this project reflects my passion for the game and the broader community.\nIt is currently a work-in-progress with no hard timelines -- it's a passion project.\n\n```mermaid\nclassDiagram\n    class StarRailElysiaServer {\n        \u003c\u003cService\u003e\u003e\n    }\n\n    class StarRailService {\n        \u003c\u003cService\u003e\u003e\n    }\n\n    class StarRailApi {\n        \u003c\u003cAPI Interface\u003e\u003e\n    }\n\n    class HoyoApi {\n        \u003c\u003cExternal API\u003e\u003e\n    }\n\n    class User {\n        \u003c\u003cData Model\u003e\u003e\n    }\n\n    class Player {\n        \u003c\u003cData Model\u003e\u003e\n    }\n\n    class Character {\n        \u003c\u003cData Model\u003e\u003e\n    }\n\n    class Equipment {\n        \u003c\u003cData Model\u003e\u003e\n    }\n\n    StarRailElysiaServer --\u003e StarRailService : Uses\n    StarRailService --\u003e User : Manages\n    StarRailService --\u003e StarRailApi : Uses\n    User --\u003e Player : Contains\n    User --\u003e Character : Contains\n    Character --\u003e Equipment : Contains\n    StarRailApi --\u003e HoyoApi : Interacts with\n```\n\n## ✨ Features:\n\n### Current:\n- **Proxy Access**: Directly fetch publicly available game data.\n- **Basic Caching**: Minimize redundant API calls.\n- **Fully Typed**: Built with TypeScript, ensure type-safe interactions and predictable responses.\n- **Comprehensive Testing**: Utilises Bun's built-in testing functionality to ensure reliability.\n\n### Upcoming:\n1. **Indexing**: The plan isn't just to fetch, but to remember. I'm aiming to index player data for even swifter retrievals down the line.\n2. **Insights**: I'm excited about the potential to delve into the nuances of player data. Imagine drawing meaningful patterns, understanding trends, and even perhaps making game strategy suggestions. The data holds stories, and I intend to narrate them.\n\n## 💻 Getting Started:\n\nThis project is built with: \n- [Bun](https://bun.sh/) - Bun is a fast Javascript all-in-one toolkit. *It's similar to node.*\n- [Elysia](https://elysiajs.com/) - ElysiaJS is a fast, and friendly Bun web framework.\n\n**You'll need [Bun](https://bun.sh/) to be able to run `bun` commands. \nInstall [Bun](https://bun.sh/) with [these instructions](https://github.com/oven-sh/bun/#install) first!**\n\nAfter you have Bun installed:\n1. **Install Dependencies**:\n\n    ```bash\n    bun install\n    ```\n\n2. **Test**:\n\n   ```bash\n    bun test\n    ```\n\n3. **Run the Server**:\n\n    ```bash\n    bun start\n    ```\n   \n    or in `dev` mode\n    \n    ```bash\n    bun dev\n    ```\n\n4. **Documentation and Testing**:\n\n    - **Swagger OpenAPI Docs**: [http://localhost:3001/swagger](http://localhost:3001/swagger)\n    - **Fetch a User**: [http://localhost:3001/user/{uuid}](http://localhost:3001/user/{uuid}) (Replace `{uuid}` with the specific user's UUID)\n\n## 🤝 Contribution and Maintenance\n\nThis is a personal side-project, developed out of passion and interest; a labor of love for the community.\nContributions are warmly welcomed! If you'd like to contribute, feel free to fork the repository, make your changes, and submit a pull request. \nIf you have any ideas, suggestions, or issues, don't hesitate to open an issue to discuss it.\n\n## ⚠️ Disclaimer \u0026 License\n\n**`StarRail Infinity` is not affiliated, associated, authorized, endorsed by, or in any way officially connected with the official game or any of its subsidiaries or affiliates.** The official game website can be found at [https://hsr.hoyoverse.com/](https://hsr.hoyoverse.com/).\n\nThe software provided as part of `StarRail Infinity` is distributed under the terms of the MIT License. This means the software is provided \"as is\", without any warranties, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, and non-infringement. I, nor any contributors to this project, shall be held liable for any claim, damages, or other liability, whether in action of contract, tort, or otherwise, arising from, out of, or in connection with the software or its use or other dealings in the software.\n\n- **StarRail Infinity** does not claim any rights or ownership over the data fetched from [Honkai: Star Rail](https://hsr.hoyoverse.com/). All data remains the property of the official game and its developers.\n\n- Users of **StarRail Infinity** are expected to respect and adhere to the official [Honkai: Star Rail EULA](https://honkai-star-rail.com/terms-use-eula/). Any misuse of the data fetched through **StarRail Infinity** that violates the official game's EULA is strictly the responsibility of the user.\n\n- This project does not modify, reproduce, distribute, or use the fetched data for any commercial endeavors. It solely acts as a proxy to access publicly available information.\n\n- **StarRail Infinity** is not sponsored, endorsed, or in any way affiliated with the official game. Any representations or implications contrary to this fact are unintentional and will be corrected upon notice.\n\nFor the complete terms of the MIT License, please refer to the [LICENSE](/LICENSE) file in this repository.\n\n## 📞 Contact\n\nIf you have any concerns or feedback regarding this project, please feel free [open an issue](https://github.com/infinia-yzl/starrail-infinity/issues/new/choose), or get in touch:\n\n- **Email**: [dev@infinia.space](mailto:dev@infinia.space)\n- **Discord**: infinia\n\nPlease note that response times may vary, and replies are on a best-effort basis, as this is a personal side project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfinia-yzl%2Fstarrail-infinity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfinia-yzl%2Fstarrail-infinity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfinia-yzl%2Fstarrail-infinity/lists"}