{"id":20163081,"url":"https://github.com/rocketleagueapi/items","last_synced_at":"2025-04-10T00:36:40.710Z","repository":{"id":41817564,"uuid":"430327128","full_name":"rocketleagueapi/items","owner":"rocketleagueapi","description":"A collection of JSON files including all items, paints, certifications, slots, special editions and series bundled into a tree-shakable, side-effect free, no dependencies package.","archived":false,"fork":false,"pushed_at":"2024-11-26T17:57:06.000Z","size":1227,"stargazers_count":14,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T02:22:17.005Z","etag":null,"topics":["certifications","items","json","maps","paints","playlists","products","rocket-league","special-editions"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@rocketleagueapi/items","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rocketleagueapi.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":"2021-11-21T09:49:09.000Z","updated_at":"2024-10-08T13:44:13.000Z","dependencies_parsed_at":"2024-06-21T20:24:56.183Z","dependency_job_id":"9017ac0b-1a6a-4861-a121-0f0deb63a8ec","html_url":"https://github.com/rocketleagueapi/items","commit_stats":{"total_commits":124,"total_committers":2,"mean_commits":62.0,"dds":0.008064516129032251,"last_synced_commit":"e0fc95aa9a74f6323bee6c7f2530c42788133627"},"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rocketleagueapi%2Fitems","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rocketleagueapi%2Fitems/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rocketleagueapi%2Fitems/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rocketleagueapi%2Fitems/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rocketleagueapi","download_url":"https://codeload.github.com/rocketleagueapi/items/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137998,"owners_count":21053774,"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","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":["certifications","items","json","maps","paints","playlists","products","rocket-league","special-editions"],"created_at":"2024-11-14T00:28:05.096Z","updated_at":"2025-04-10T00:36:40.677Z","avatar_url":"https://github.com/rocketleagueapi.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003eRocket League Items Data\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/rocketleagueapi/items/packages/1108141\" target=\"_blank\"\u003e\n  \u003cimg alt=\"GitHub tag (latest by date)\" src=\"https://img.shields.io/github/v/tag/rocketleagueapi/items?label=Version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/rocketleagueapi/items/blob/master/LICENSE\" target=\"_blank\"\u003e\n    \u003cimg alt=\"License: LGPL--3.0--or--later\" src=\"https://img.shields.io/github/license/rocketleagueapi/items?color=green\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\nA collection of JSON files including all items, paints, certifications, slots, special editions, maps, titles, qualities, series and playlists. \n\n### 🏠 [Homepage](https://github.com/rocketleagueapi/items)\n\n## Features\n - Tree-shakable\n - Side-effects free\n - No dependencies\n\nFor frontend applications, it is worth checking out [Bundle Phobia](https://bundlephobia.com/package/@rocketleagueapi/items) and viewing the `Export Analysis` to see the GZipped cost of importing parts of the module. \n\nFor example, `products` makes up the vast majority (~62kB) of the total package size (~72kB).  As such, importing all other parts would have a near-negligible effect on build sizes.\n\n## Install\n\nInstall this package using your package manager of choice.\n```sh\n npm i @rocketleagueapi/items\n```\nor\n```sh\n yarn add @rocketleagueapi/items\n```\n\n## Example Usage\n```js\nconst { products } = require('@rocketleagueapi/items');\n\n// Where 32 is the product ID\nconst alphaBoost = products[32];\nconsole.log(alphaBoost.paintable) // false\n```\n\n## Updating the Dump\nUsing [ItsBrank's CodeRed](https://coderedmodding.github.io/), we can dump the necessary information to update this module.  The information in this module is derived from the game and is extacted using CodeRed.  The commands needed to dump the `src/raw` JSON files can be found in `scripts/dump_databases.crsq`.\n\nRun these commands and copy the resultant output from your CodeRed Dump folder to `src/raw`.\nNote: You will need to convert the `ProductDump.json` encoding from ANSI to UTF8 before the next step.  I usually to do this using Notepad++.\n\nAfterwards, run the parse script:\n\n```sh\nnpm run parse\n```\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nCopyright © 2021 [Rocket League API](https://github.com/rocketleagueapi).\u003cbr /\u003e\nThis project is [LGPL--3.0--or--later](https://github.com/rocketleagueapi/items/blob/master/LICENSE) licensed.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketleagueapi%2Fitems","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frocketleagueapi%2Fitems","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketleagueapi%2Fitems/lists"}