Skip to content

Latest commit

 

History

History
205 lines (168 loc) · 4.7 KB

README.md

File metadata and controls

205 lines (168 loc) · 4.7 KB

R6-Info

This package allows you to access information about any R6 operator or map, and more. Currently updated to Y9S4.2 A discord bot that I have made with this package can be found here

Installation

Install R6-Info with npm

npm install @silver-3/r6-info

Usage/Examples of finding an operator

Layout of an operator

{
  name: 'Sledge',
  ability: {
    name: 'Breaching Hammer',
    description: 'Uses a Breaching Hammer to breach through destructible surfaces.'
  },
  icon: 'FILE_PATH_TO_IMAGE',
  specialties: [ 'Breach', 'Anti-Gadget' ],
  stats: { health: 2, speed: 2, difficulty: 1 },
  bio: {
    realname: 'Seamus Cowden',
    nickname: 'Sledge',
    org: 'SAS',
    squad: 'Redhammer',
    height: '1.92m',
    weight: '95kg',
    dateofbirth: 'April 2nd (Age 35)',
    placeofbirth: 'John O’Groats, Scotland'
  },
  guns: { primary: [ 'M590A1', 'L85A2' ], secondary: [ 'P226 MK 25' ] },
  gadgets: [ 'Frag grenade', 'Stun grenade', 'Impact emp grenade' ],
  season: 'Release'
}

Geting information about an operator

const R6Info = require('@silver-3/r6-info');
const operator = R6Info.getOperator("Striker"); // Operator name <Required>

console.log(operator.name);
console.log(operator.ability.name);
console.log(operator.guns.primary);
console.log(operator.season);
// Output
// Striker
// Gadget Kit
// [ 'M4', 'M249' ]
// Y9S2 - New Blood

Getting a random operator

const R6Info = require('@silver-3/r6-info');
const operator = R6Info.randomOperator("defense"); // Team <Required>

console.log(operator.name);
console.log(operator.bio.realname);
// Output
// Fenrir
// Emil Svensson

Getting all operators/attackers/defenders

const R6Info = require('@silver-3/r6-info');

console.log(R6Info.getAttackers()); // returns all attackers
console.log(R6Info.getDefenders()); // returns all defenders
console.log(R6Info.getAllOperators()); // returns all operators

// Output
// [
//     {operator one},
//     {operator two},
//     {operator three}
// ]

Usage/Examples of finding an map

Layout of an map

{
  name: 'Oregon',
  image: 'FILE_PATH_TO_IMAGE'
}

Geting an map

const R6Info = require('@silver-3/r6-info');
const map = R6Info.getMap("Oregon"); // Full map name <Required>

console.log(map.name);
console.log(map.image);
// Output
// Oregon
// FILE_PATH_TO_IMAGE

Getting a random map

const R6Info = require('@silver-3/r6-info');
const map = R6Info.randomMap("ranked"); // Type (ranked / nonranked) <Required>

console.log(map.name);
console.log(map.image);
// Output
// Kanal
// FILE_PATH_TO_IMAGE

Getting all maps

const R6Info = require('@silver-3/r6-info');

console.log(R6Info.getRankedMaps()); // returns all ranked maps
console.log(R6Info.getNonrankedMaps()); // returns all non ranked maps
console.log(R6Info.getAllMaps()); // returns all maps

// Output
// [
//     {map one},
//     {map two},
//     {map three}
// ]

Usage/Examples of finding an weapon

Layout of an weapon

{
        name: "M4",
        icon: 'FILE_PATH_TO_IMAGE',
        stats: {
            damage: 44,
            firerate: 750,
            ammo: 30,
            maxammo: 181,
            difficulty: 2
        },
        type: "Assault Rifle",
        scopes: ["Magnified A", "Magnified B", "Magnified C", "Red Dot A", "Red Dot B", "Red Dot C", "Holo A", "Holo B", "Holo C", "Holo D", "Reflex A", "Reflex B", "Reflex C", "Iron Sight"],
        operators: ["Striker", "Maverick"]
    },

Geting an weapon

const R6Info = require('@silver-3/r6-info');
const weapon = R6Info.getWeapon("mp5"); // exact name from r6 siege

console.log(weapon.name);
console.log(weapon.stats.damage);
console.log(weapon.stats.firerate);
console.log(weapon.operators);

Getting a random weapon

const R6Info = require('@silver-3/r6-info');
const weapon = R6Info.randomWeapon();

console.log(weapon.name);

Getting a random weapon loadout

const R6Info = require('@silver-3/r6-info');
const randomLoadout = R6Info.randomLoadout('r4-c');

console.log(randomLoadout);

// Output
// { scope: 'Holo C', barrel: 'Muzzle Brake', grip: 'Angled Grip' }

Getting all weapons

const R6Info = require('@silver-3/r6-info');

console.log(R6Info.getAllWeapons()); // returns all weapons

// Output
// [
//     {weapon one},
//     {weapon two},
//     {weapon three}
// ]

Support

Once again I have created a discord bot with this package that you can checkout here For any support, dm .silver_3 on discord and I will try to help you