https://github.com/rocketleagueapi/items
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.
https://github.com/rocketleagueapi/items
certifications items json maps paints playlists products rocket-league special-editions
Last synced: about 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/rocketleagueapi/items
- Owner: rocketleagueapi
- License: lgpl-3.0
- Created: 2021-11-21T09:49:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-26T17:57:06.000Z (6 months ago)
- Last Synced: 2025-03-24T02:22:17.005Z (2 months ago)
- Topics: certifications, items, json, maps, paints, playlists, products, rocket-league, special-editions
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@rocketleagueapi/items
- Size: 1.17 MB
- Stars: 14
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Rocket League Items Data
A collection of JSON files including all items, paints, certifications, slots, special editions, maps, titles, qualities, series and playlists.
### 🏠 [Homepage](https://github.com/rocketleagueapi/items)
## Features
- Tree-shakable
- Side-effects free
- No dependencies
For 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.
For 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.
## Install
Install this package using your package manager of choice.
```sh
npm i @rocketleagueapi/items
```
or
```sh
yarn add @rocketleagueapi/items
```
## Example Usage
```js
const { products } = require('@rocketleagueapi/items');
// Where 32 is the product ID
const alphaBoost = products[32];
console.log(alphaBoost.paintable) // false
```
## Updating the Dump
Using [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`.
Run these commands and copy the resultant output from your CodeRed Dump folder to `src/raw`.
Note: You will need to convert the `ProductDump.json` encoding from ANSI to UTF8 before the next step. I usually to do this using Notepad++.
Afterwards, run the parse script:
```sh
npm run parse
```
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2021 [Rocket League API](https://github.com/rocketleagueapi).
This project is [LGPL--3.0--or--later](https://github.com/rocketleagueapi/items/blob/master/LICENSE) licensed.