Git Product home page Git Product logo

valorant-tools's Introduction

Various valorant related tools for overwolf apps.

Install with npm or yarn

npm install --save valorant-tools
yarn add valorant-tools

Functions:

Retrieve agents name for a language

import { getAgentName } from 'valorant-tools';
const myAgentEnglish = getAgentName('Deadeye_PC_C', 'en');
console.log(myAgentEnglish); //Chamber
import { getAgentImage } from 'valorant-tools';
const myAgentEnglish = getAgentImage('Deadeye_PC_C', 'en');
console.log(myAgentEnglish); //...png

Check if agent exists

import { isAgentExist } from 'valorant-tools';
const isAgentValid = isAgentExist('Deadeye_PC_C');
console.log(isAgentValid); //true
import { AGENTS } from 'valorant-tools';
console.log(AGENTS); //{ Clay_PC_C: { "en": "Rate", "img": "...png", ... }, ...}
import { getEveryAgent } from 'valorant-tools';
console.log(getEveryAgent('en')); //["Raze", "Viper", ...]
import { getEveryAgentWithDetails } from 'valorant-tools';
console.log(getEveryAgentWithDetails());
/*[
    {
        en: 'Yoru',
        img: '...png',
        icon: '...png',
        description: 'Japanese native Yoru...',
        role: 'Duelist',
        roleDescription: 'Duelists are...',
        abilities: [
            {
                key: 'C',
                label: 'FAKEOUT',
                img: '...png',
                description: 'EQUIP an echo t...',
            },
            ...
        ],
    },
    ...
]*/
import { getAgentDetailsByEnglishName } from 'valorant-tools';
console.log(getAgentDetailsByEnglishName('Yoru'));
/* 
{
    en: 'Yoru',
    img: '...png',
    icon: '...png',
    description: 'Japanese native Yoru...',
    role: 'Duelist',
    roleDescription: 'Duelists are...',
    abilities: [
        {
            key: 'C',
            label: 'FAKEOUT',
            img: '...png',
            description: 'EQUIP an echo t...',
        },
        ...
    ],
}
*/

Retrieve agents name for a language

import { getMapName } from 'valorant-tools';
const myMapEnglish = getMapName('Canyon', 'en');
console.log(myMapEnglish); //Fracture

Check if agent exists

import { isMapExist } from 'valorant-tools';
const isMapValid = isMapExist('Canyon');
console.log(isMapValid); //true
import { MAPS } from 'valorant-tools';
console.log(MAPS); //{ Triad: { "en": "Haven" }, ...}
import { getEveryMap } from 'valorant-tools';
console.log(getEveryMap('en')); //["Haven", "Bind", ...]

Supported languages

  • English

Contribution

Please feel free to contribute.

Contact

valorant-tools's People

Contributors

gabrielmicko avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.