StarPy

Introduction

✨ Welcome to StarPy, a library for fetching information about Brawlers and their rarities in the game Brawl Stars. This library provides simple methods to retrieve information about Brawlers and rarities based on a specific version.

Installation

You can install StarPy via npm using the following command:

npm install starpy

Usage

To start using StarPy in your project, import the necessary methods:

const starpy = require('starpy');

Get Brawler Information

To fetch information about a specific brawler, use the getBrawlerInfo(id, info) method. You need to provide the brawler ID and optionally an array of specific information you want to retrieve.

Example:

const brawlerInfo = starpy.getBrawlerInfo('brawler_id', ['name', 'type']);
console.log(brawlerInfo);

This will return an object containing the requested information about the specified brawler.

If you want to get all available information about a brawler, you can simply provide the brawler ID:

const brawlerInfo = starpy.getBrawlerInfo('brawler_id');
console.log(brawlerInfo);

Get Rarity Information

To fetch information about the rarity in a specific version, use the getRarityInfo(version, id, info) method. You need to provide the rarity version, the rarity ID, and optionally specific information you want to retrieve.

Example:

const rarityInfo = starpy.getRarityInfo('v1', 'rarity_id', 'name');
console.log(rarityInfo);

This will return the name of the rarity specified by 'rarity_id' in the 'v1' version.

If you want to get all available information about the rarity of a specific rarity ID in a specific version, you can omit the info parameter:

const rarityInfo = starpy.getRarityInfo('v2', 'rarity_id');
console.log(rarityInfo);

This will return an object containing all available information about the specified rarity ID in the 'v2' version.

License

This project is licensed under the MIT License.