Discord Steam Verification

🚧 This bot has power to kick or ban your users if they can't verify themselves. Please use it on your own risk and make sure to run some tests before using it on your server!

Please make sure to read all of the README.md (this) file before starting to use the bot.

Verify your Discord server members and check if they have specified app on their Steam library! Give them roles on successfull verification and punish them if they don't have it in their library!

⏬ Skip right to:

• ❓ How does it work?
• 🛠 Requirements
• 📩 Installation
• 📄 Todo
• 🐛 Bugs
• 🙏 Thanks

🔥 Features

• Steam authentication; users will be asked to login to their Steam account to check their library.
• Everything is customizable!
  • Fully customizable strings; access to string files easily and translate the entire bot, API and website to your language!
  • Multiple roles that will be given to user on successfull login!
  • Custom punishments for users who doesn't have the specified app in their Steam library! You can choose between two options, kick or ban the user if they are trying to access your server without having the required app/game!
• Backups! Automatic or not! Set it as you wish and leave the rest to the bot. Bot will read your settings and it'll back up the queue and Steam ID array so you won't lose your stuff when you restart your bot! Keep in mind you'll have to use the import command to import the backup file after every first start to load your backup.
• Able to store Steam IDs in an array so it won't let users use the same Steam account for different Discord accounts.
• API and website ready for production! Specially designed API, multiple endpoints, Steam authentication and simple website UI.
• Huge list of commands! You get bypass, emit, isverified, list, verify and unverify commands built-in as well as usual commands such as eval and help!
  • bypass: Manually skip the verification process for someone!
  • disable: Disable the bot, this will stop verification process' on new member join and clear the verification queue.
  • emit or verifyself: This will start the verification for the message author, don't forget if a user has all of the success roles, they won't be able to use this command unless you remove their roles or use the unverify command.
  • enable: Enables the bot and starts verification process for every new user.
  • eval: Evaluates a JavaScript code. Only those with higher possible permission (Administrator) is able to use this command.
  • export: Manually exports/backs-up the data on memory to a local file so you can import it later.
  • help: List of commands and their explanations, more explenation if a command name included after the command.
  • import: Imports the data in the backup file to memory, so you can have your items back!
  • isverified: Check if a user has all the success roles that is specified in your config.
  • list: Lists all users waiting in the queue for verification.
  • unverify: Removes all the success roles from user.
  • verify: Removes all the success roles and starts the verification process for specified user.

❓ How does it work

There's an API and bot, always in communicate with each other, they keep the data in a main class and reads data from there so everything is synced between bot and API.

When a user joins to your server, bot will check if they somehow got the sucess roles. If they have it, bot won't do anything. But if they don't have the specified roles, it'll start the verification process and send the user a message including your API's URL.

The user will be asked to login to their Steam account and then they'll see this page:

The time they click "Yes", they'll send a POST request to another route and it'll send a request to Steam's API to get user's games list, and it'll try to find the specified application ID in user's library.

If API finds the application in their library, it'll fire a successfull verification event so bot will get the signal and continue the progress. If user doesn't have the game, same way API will fire a failure event and bot will check your penalty settings. It'll kick the user if it's set to kick and it'll ban the user if it's set to ban. Don't worry, you can choose not to do anything or bypass the user with bypass command.

When user that is in the verification queue leaves the server, they'll be removed from the queue automatically. Bot will notify you when user's DMs are disabled so you will know which users didn't get the message.

If API can't reach the data, it'll show an error box to the user with the message you specified to tell them that they got some issues with their profile (it's mostly caused when profile is set to private). YES user needs to have a public Steam profile so bot API can check the user's library.

That's all, but please do not forget this is not the "best version" of what you want. You may be looking for a better product but you're very welcome to contribute! I'll be looking forward to your pull request and bug reports! Please feel free to get in contact with me from my website and check out m other projects too!

⚠ Caution! This project has no database so all of you could easily setup and start using the project, you can edit your clone to have a database or wait for me to create another branch with a version that includes database connection. Your verification queue will be lost unless you back it up with command or auto-backup feature when you restart the bot or something happens. And your settings won't be available until you restart the bot! So make sure to set your config and everything, test it on a private server and then start using it on your main server! If you are looking for a way to prevent scam accounts and verify all new members, you may take a look at this bot.

🛠 Requirements

This bot requires Node.JS, TypeScript, Yarn, a Discord Bot Application, Steam API Key and a Node.JS hosting service (required so you can run API and the bot somewhere) to work. Please make sure you have them all installed globally.

📩 Installation

Make sure you have all the required programs and modules installed before this step!

• Clone this repository: git clone https://github.com/eggsydev/discord-steam-verification
• Install modules with yarn
  • cd to your clone folder.
  • Type yarn in your terminal.
• Edit the config.ts file in src/ directory as you wish.
• Copy the content of .env.example, fill the fields and rename it to .env (all fields are explained in comments, make sure to put the right app ID).
• Start the bot in development or production mode.
  • For development, type this in your terminal: yarn dev
  • For production, follow these steps:
    • Compile the code with: yarn compile (compile with yarn compile-linux instead if you're on Linux/macOS)
    • Start the compiled code: yarn start

You will now have your very own discord-steam-verification bot and API running! Invite your bot to your server and it'll start verifying new users!

📄 TODO (maybe list)

• A version/branch that uses a database to store data instead of memory or a local file.
• A version/branch that uses Discord authentication as well as Steam authentication so users will have no chance to fake the system.

🐛 Bugs

Please report!

🙏 Thanks

The bot is written in Eris, and like every other part, it is developped in TypeScript using the cool features of ts-devscript and many other creators of the modules used in this project!