Skip to content

NPM package to automatically solve hints & check the rarity of pokemon, made for pokemon discord bots like Pokétwo

License

Notifications You must be signed in to change notification settings

kyan0045/pokehint

Repository files navigation

PokeHint

NPM package to automatically solve hints & check the rarity of pokemon, made for pokemon discord bots like Pokétwo

Installation

Use the package manager npm to install the module.

npm i pokehint

Usage

const { solveHint, checkRarity, getName, getImage } = require("pokehint");

// Solving hints
  var hint = "The pokémon is M_l__es.";
  console.log(solveHint(hint)); // Logs 'Moltres'.

  // Checking the rarity
  var pokemonName = "Moltres";
  console.log(checkRarity(pokemonName)); // Logs Moltres' rarity: 'Legendary'.

  // Converting a name to a different language
  console.log(
    await getName({
      name: "Moltres",
      language: "French",
      inputLanguage: "English",
    })
  ); // Logs the French name of Charmander: 'Sulfura'.

  // Getting the Pokétwo image sprite of a specified pokemon
  console.log(getImage("Moltres", false)); // Logs 'https://cdn.poketwo.net/images/164.png'.
  console.log(getImage("Moltres", true)); // Logs 'https://cdn.poketwo.net/shiny/164.png'.

Links

Contributing

Pull requests are always welcome, as long as you follow our contributing guidelines. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update the usage examples in this file as appropriate.

License

MIT