https://github.com/kyan0045/pokehint

NPM package to automatically solve hints & check the rarity of pokemon, made for pokemon discord bots like Pokétwo
https://github.com/kyan0045/pokehint

catchtwo pokehint poketwo poketwo-helper poketwo-hint poketwo-identifier poketwo-name

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/kyan0045/pokehint
• Owner: kyan0045
• License: mit
• Created: 2023-07-26T19:12:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T10:14:23.000Z (about 2 months ago)
• Last Synced: 2024-10-29T12:17:00.020Z (about 2 months ago)
• Topics: catchtwo, pokehint, poketwo, poketwo-helper, poketwo-hint, poketwo-identifier, poketwo-name
• Language: JavaScript
• Homepage:
• Size: 264 KB
• Stars: 10
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PokeHint

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

[![](https://img.shields.io/npm/v/pokehint.svg)](https://www.npmjs.com/package/pokehint)

## Installation

Use the package manager [npm](https://www.npmjs.com/package/pokehint) to install the module.

```bash

npm i pokehint

```

## Usage

```javascript

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

- [NPM](https://www.npmjs.com/package/pokehint)

- [Discord](https://discord.com/users/1101294362505269379)

## Contributing

Pull requests are always welcome, as long as you follow [our contributing guidelines](/CONTRIBUTING.md). 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](https://choosealicense.com/licenses/mit/)