Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eggsy/discord-steam-verification

🧬 Check if a user owns the specific item(s) in their Steam library and give them roles! Discord bot and API.
https://github.com/eggsy/discord-steam-verification

discord-bot eris express steam typescript verification

Last synced: about 2 months ago
JSON representation

🧬 Check if a user owns the specific item(s) in their Steam library and give them roles! Discord bot and API.

Awesome Lists containing this project

README 

        


  DSV logo

  
Discord Steam Verification



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!



> 🚧 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.



### 🔥 Features



- [x] Steam authentication; users will be asked to login to their Steam account to check their library.

- [x] [`NEW`](/#) Multiple Steam APP verification: You can check for more than one app in user's library!

- [x] 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!

- [x] 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_.

- [x] Able to store Steam IDs in an array so it won't let users use the same Steam account for different Discord accounts.

- [x] API and website ready for production! Specially designed API, multiple endpoints, Steam authentication and simple website UI.



### ❓ How does it work



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.



image



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



verification_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(s) in user's library.



If API finds the application(s) 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 item(s), 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](https://eggsy.xyz) 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](https://altdentifier.com/).



### 🛠 Requirements



This bot requires [Node.js](https://nodejs.org/en/download/), [TypeScript](https://www.npmjs.com/package/typescript), [pnpm](https://pnpm.io/installation), a [Discord Bot Application](https://discord.com/developers/applications/), [Steam API Key](https://steamcommunity.com/dev/registerkey) and a Node.js hosting service (e.g. Hop.io, Railway, Fly.io) to install.



💡 Make sure to enable "Message Content Intent" & "Server Members Indent" in your bot's application page in Discord Developer Portal.



image



### 📩 Installation



- Clone this repository: `git clone https://github.com/eggsydev/discord-steam-verification`

- Install modules with `pnpm`

  - `cd` to your clone folder.

  - Type `pnpm i` in your terminal.

- Edit the `config.example.ts` file in `src/` directory as you wish. Rename the file to `config.ts` after you're finished.

- 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(s)).

- Start the bot in **development** or **production** mode.

  - For development, type this in your terminal: `pnpm dev`

  - For production, follow these steps:

    - Compile the code with: `pnpm build`

    - Start the compiled code: `pnpm 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!



### 🐛 Bugs



Please create an [issue](/issues)!



### 💖 Sponsors