Skip to content
Marco Cusano edited this page Nov 4, 2018 · 3 revisions

OVERHACK DISCORD BOT WIKI

Welcome to the official GitHub repository for the Overhack Discord Bot. Overhack Project is a free competitive platform, with a dedicated Anti-Cheat, for the first time as a server-side application. If you want to know more about Overhack Project please click here.

Developed by Marco Cusano v1.0
https://www.overhack.one

Requirements

Configurations

To start using Overhack Discord Bot you must configure the settings file inside the "Settings folder":

admins.json

You can use this file to add your BOT Administrators, allowing them to use the !overhack admin commands.

[
	"197337539105914890",
	"YOUR_DISCORD_PROFILE_ID",
	"ANOTHER_DISCORD_PROFILE_ID"
]

As JSON required, please don't forget to DON'T use the "comma" at the end of your last Discord Profile ID.

channels.json

{
	
	"admin" : "YOUR_SERVER_ADMIN_TEXTCHANNEL_ID",
	"beta" : "YOUR_SERVER_BETA_TEXTCHANNEL_ID",
	"bot" : "YOUR_SERVER_BOT_TEXTCHANNEL_ID",
	"media" : "YOUR_SERVER_MEDIA_TEXTCHANNEL_ID",
	"news" : "YOUR_SERVER_NEWS_TEXTCHANNEL_ID",
	"premium" : "YOUR_SERVER_PREMIUM_TEXTCHANNEL_ID",
	"public" : "YOUR_SERVER_PUBLIC_TEXTCHANNEL_ID",
	"support" : "YOUR_SERVER_SUPPORT_TEXTCHANNEL_ID",
	"welcome" : "YOUR_SERVER_WELCOME_TEXTCHANNEL_ID"
	
}

As JSON required, please don't forget to DON'T use the "comma" at the end of your last Discord Text Channel ID.

  • If you don't have a specified reserved #text_channel on your Discord Server just leave the "param" blank.
  • Don't forget to give the right permissions (read/write) on your Text Channels, to be sure that the bot will be able to write only in your desidered Text Channels.

REQUIRED TEXT CHANNELS

Text Channel Description Required
admin Used by the Official Overhack Discord Server.
beta Used by the Official Overhack Discord Server.
bot Used by the Official Overhack Discord Server.
media Used by the Official Overhack Discord Server.
news Will be used when an Overhack News will be pushed. By pushing a news, the bot will automatically save the last pushed news into a local "database" (better say file).
premium Needed a reserved permission. The bot will automatically check the Overhack Premium Users giving them the specified reserved Overhack Premium permission. Please read the section Permissions to know more.
public Used by the Official Overhack Discord Server.
support Used by the Official Overhack Discord Server.
welcome Used by the Official Overhack Discord Server.

Actually there aren't other features using the specified #text-channels. Please be patient, as soon as possible new features will be added, using the support, welcome and media text channels.

config.json

{
	"loop" : {
		"refresh" : 60000,
		"refresh_premium" : 3600000
	},
	"paths" : {
		"database" : "./database/",
		"logs" : "./logs/",
		"settings" : "./settings/"
	},
	"server" : "YOUR_SERVER_ID",
	"token" : "YOUR_BOT_LOGIN_TOKEN"
}
Parameter Description
loop.refresh How often the bot will have to check for a news / new Anti-Cheat Client version (in ms).
loop.refresh_premium How often the bot will have to check for a new Overhack Premium user (in ms).
server Your server ID (The bot was developed to work on a single Discord Server)
token Your BOT Api Login Token (The bot was developed to work on a single Discord Server)

Please don't edit the paths parameters, used from the BOT. That parameters are used to check, create and update files needed from the bot, then edit only if you know what are you doing with the code.

permissions.json

{
	"admin" : "YOUR_ADMIN_POWER_ID",
	"bot" : "YOUR_BOT_POWER_ID",
	"heads" : "YOUR_STAFFHEAD_POWER_ID",
	"staff" : "YOUR_STAFF_POWER_ID",
	"helper" : "YOUR_MINORSTAFF_POWER_ID",
	"vip" : "YOUR_VIP_POWER_ID",
	"premium" : "YOUR_OVERHACKPREMIUM_POWER_ID",
	"donator" : "YOUR_OVERHACKDONATOR_POWER_ID",
	"streamer" : "YOUR_STREAMER_POWER_ID"
}

As specified in the "channels.json" section, here are permissions file needed to check and set an User automatically to a role. Actually only the premium role is required to work properly due to the checkPremium internal BOT function. If you don't have the reserved permission role as specified in the permissions.json file just leave blank the value of that param.


REQUIRED PERMISSIONS

Role permission Description Required
admin Used by the Official Overhack Discord Server.
bot Used by the Official Overhack Discord Server.
heads Used by the Official Overhack Discord Server.
staff Used by the Official Overhack Discord Server.
helper Used by the Official Overhack Discord Server.
vip Used by the Official Overhack Discord Server.
premium Set a premium role ID in the permissions.json file. It's needed to allow the BOT to set automatically an user as an Overhack Premium.
donator Used by the Official Overhack Discord Server.
streamer Used by the Official Overhack Discord Server.

Commands

Following the complete list of all available commands:

Public

Command Description Parameters
!overhack help Get the full list of available commands
!overhack download Get the download link of the Overhack Anti-Cheat Client for Windows
!overhack group or !overhack team Get the Group/Team informations <id> (Int)
!overhack news Get the latest pushed Overhack News
!overhack player or !overhack user Get the Player informations <id> (Int)
!overhack session or !overhack anticheat Get a Player Anti-Cheat Session informations <id> (Int)

Admins

Command Description Parameters
!overhack admin shutdown Turn off the bot (It can be result in just a crash)
!overhack roles Get the full list of permissions/roles informations (containing the permissions ID needed from the permissions.json section)

FAQ

How to get Server, Players and Channels ID?

You must activate the Development Mode in your Discord Settings > Appearance > Advanced

How to get Permissions ID?

  1. Make sure you are able to use !overhack admin commands through the admins.json configuration file.
  2. Make sure you have configured properly the server param in your config.json file, as target to check all of your server permissions.
  3. Type !overhack admin permissions or !overhack admin roles via PM to your Overhack Discord BOT to generate a log file that you can check in /your_bot_path/permission_dateandtime.txt as example.