Skip to content
 
 

Repository files navigation


Ministral

A repository aiming to maintain the public SkinPeek instance, Ministral

Discord bot to view your VALORANT daily shop, set alerts for specific skins, and much more.

Features | Installation | Useful Info | Acknowledgements | Translations

Feel free to join the support server if you need any help!


bannerv2-2@0 5x bannerv2@0 5x
See some more screenshots alert
stats
reaverstats
balance

Features

  • 🔍 See your shop, bundles and night market easily without lauching the game
  • 🔔 Set skin alerts to be notified automatically when they are in your shop
  • 📬 Send your shop automatically every day in a text channel of your choice
  • 🔀 Account switcher to check the shop and set alerts for up to 10 different accounts
  • 📊 Automatically track which skins appear the most in your shop
  • 👀 Fetch and see the shop of your friends using the bot
  • ✔ Automatically imports new skins from the latest VALORANT updates
  • ⬛ Hide your VALORANT username from the message using /settings
  • 🌍 Skin names are automatically translated to any language that VALORANT supports
  • ✨ ...and so much more!
  • 🛠 For bot admins:
    • Really easy to set up
    • Optimised for performance and reliability
    • Highly configurable in config.json
    • Login queue and shop cache systems to prevent rate limiting
    • Fully supports sharding (required for 2500+ servers)

Installation

Tip

The easiest way to run the bot is using Docker Compose, as it automatically sets up all required dependencies (like Redis) for you. See the Docker deployment guide below. If you prefer a manual installation, follow the steps below.

  • Create a discord bot and add it to your server with the bot and applications.commands scope
  • Install Node.js v18.0 or newer
  • Install and run Redis (the bot requires a Redis server to run)
  • Clone/Download the repo, rename the config.json.example file to config.json and put your bot token into it.
  • Open a command prompt in the same folder and type npm i to install dependencies
  • Run SkinPeek.js using node SkinPeek.js in the command prompt
  • And that's it! Don't forget too give the bot a role that allows it to send messages and embed links.
  • Also note that you need to keep the window open for the bot to stay online. If you want it to run 24/7, consider using a VPS.

Useful Information

  • Can I get banned for using Ministral/SkinPeek? (spoiler: nope, it's safe to use!)

  • After installing, the bot should automatically deploy the slash commands globally. If they don't appear:

    • If you're getting DiscordAPIError: Missing Access, you probably forgot to add the applications.commands scope in step 1
    • Discord global commands can take up to 1h to update due to caching. If you don't want to wait, send @bot !deploy guild in a text channel the bot can see (@bot being you @mentionning your bot). This will deploy the commands immediately in that guild.
    • If you see every command twice, just send @bot !undeploy guild!
  • By default, the bot doesn't store your username/password, it only uses them to get the cookies that can be used to generate access tokens needed to get your shop.

    • Your cookies are only stored on your hard drive, and are only ever sent to official Riot servers.
    • You can log in using your cookies using /cookies to avoid sending your password, and you can delete your account from the bot anytime using /forget.
  • Once you're more or less familiar with how the bot works, you should read the Admin Guide for advanced usage and tips & tricks for hosting the bot.

  • If you're bored, check out this writeup on how Riot treats third-party projects like this one.

Docker

For users who want the easiest installation experience using Docker

Using Docker automatically spins up both the bot and its required Redis dependency, making it the easiest way to host the bot.

  • Create a discord bot and add it to your server with the bot and applications.commands scope
  • Download or clone the repository to get the docker-compose.yml and config.json.example files.
  • Rename config.json.example to config.json.
  • Put your bot token in config.json and make sure "redisHost": "redis" is set.
  • Use docker compose up -d to start the bot, docker compose logs -f to see the logs and docker compose down to stop it.

Acknowledgements

And of course, thank you Giorgio for creating & maintaining SkinPeek repo for over 4 years alongside everyone who contributed to the original repo!

Translations

If you are fluent in another language and would like help translate the bot, either to a new language or to improve an existing translation, please do!

  1. Look up the language code for your language here or here.
  2. Look in this repo's languages folder.
  3. If your language is already there, feel free to improve and modify it as much as you can!
  4. Otherwise if you're starting from scratch, copy the en-GB.json and rename it to your language code.

Once you're done translating, you can either fork the repo and open a GitHub pull request, or you can just send me the JSON on Discord mistralwz and I'll upload it for you (with credit, of course).

Thank you! ❤️

About

Awesome VALORANT Discord bot to see your daily shop, night market, battlepass progression, and much more. A mutilated version for Ministral's public SkinPeek instance.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages