Skip to content

Latest commit

 

History

History
108 lines (89 loc) · 4.81 KB

README.md

File metadata and controls

108 lines (89 loc) · 4.81 KB

Steam Ban Checker for Discord

forthebadge forthebadge

As requested by many people, the Steam Ban Checker is now also available with Discord integration.

Requirements

In order to use this script, you need the following dependencies and tokens:

Dependencies

  • Linux: fontconfig or libfontconfig, depending on the distribution
    • If you don't get any screenshots, try apt install phantomjs instead

Installation

  • Make sure you have the latest version of Node.js installed.
  • Download this repository as ZIP and unpack it wherever you like.
  • Go into the configs folder and rename config.json.example to config.json
  • Edit config.json and fill in your Steam API Key, Discord Bot Token and Discord Channel ID
  • Type npm install into your console of choice to install all necessary Node.js dependencies
  • Type npm start or node server.js to start the script.
    • To find out how to run the script permanently on a server you should check out forever.

Make sure you have everything set up properly and your config is valid without missing information!

Updating

In most cases, files only need to be overwritten, renamed or moved, but this project has no guaranteed backward compatibility and if the file structure changes during an update, a local installation must be manually adjusted. The only files that will remain compatible at all times are database files if not otherwise stated.

Configuration

{
	"General": {
		"checkInterval": 10 // Check-Interval in Minutes
	},
	"Steam": {
		"apiKey": "STEAM API KEY"
	},
	"Discord": {
		"botToken": "DISCORD BOT TOKEN",
		"botChannelInput": "DISCORD CHANNEL ID",
		"botChannelOutput": "",
		"botCommandPrefix": "!",
		"allowBotCommands": false,
		"accessRole": ""
	},
	"Screenshot": {
		"saveScreenshot": true, // Take & Save Screenshots of Banned Profiles
		"sendScreenshot": true // Embed Screenshots in Discord Messages
	}
}
  • botChannelInput can be an array of multiple channels.
  • botChannelOutput is optional. If empty, messages will be sent to the Input Channel.
  • accessRole is optional. If empty, everybody is allowed to use commands.

Usage

Adding Profiles

  • Use /add <steamID64|profileURL> to add profiles to the list.
    • Examples:
      • /add 12345678912345678
      • /add http://steamcommunity.com/profiles/12345678912345678
      • /add https://steamcommunity.com/id/customURL

To get the steamID64 or URL of a profile you can use websites like STEAMID I/O.

View Statistics

Type /stats to view global and personal statistics.

Additional Information

Retrieve your Discord Channel ID

In order to retrieve a unique Discord Channel ID, do as follows:

  • Open your Discord Settings and click on the Appearance tab.
  • In this tab, enable Developer Mode.
  • Go into your Discord Server and right-click the channel to copy its id.
    • The context menu item will not be visible if Developer Mode is disabled.

Contributing

There are currently no contributing guidelines, but I am open to any kind of improvements.
In order to contribute to the project, please follow the GitHub Standard Fork & Pull Request Workflow

  • Fork this repository on GitHub.
  • Clone the project to your own machine.
  • Commit changes to your own branch.
  • Push your work to your own fork.
  • Submit a Pull Request so I can review your changes

Used Node.js Modules

Donating

If you find this script useful, you can support me by donating items via steam.
Steam Trade Link

License

MIT