JackBot

Steps to run this project:

1. Create a .env file on the project's root and add the following template:

# Your Bot Token Goes Here
TOKEN = "MyBotToken"

# The Id of the Bot's Owner (Currently Unused)
OWNER_ID = "YourUserIdHere"

# ; separated User Ids you want to DM Warns and Errors to
DM_LOGGING = "ID1;ID2"

# Your Tenor API Key Here
# Only required to enable GIF search functions, remove the field to disable them
TENOR_API_KEY = "MyTenorAPIKey"

# Twitch API ID and Secret Here
# Only required to enable Twitch Streams Notifications
TWITCH_CLIENT_ID = "MyTwitchClientId"
TWITCH_CLIENT_SECRET = "MyTwitchClientSecret"

# Generic Settings
# Whether or not to delete User Data when a User leaves a Guild
# Put it on false if you want persistent settings for Users even if they leave an re-join the Guild
DELETE_USERS_ON_LEAVE = true

# Sticky Messages Settings
# How much time has to pass before re-sending the sticky message.
STICKY_MESSAGE_COOLDOWN = 2.5e3

# Private Channels Settings
# The interval for checking inactive Private Text/Voice Channels
CHANNEL_SWEEP_INTERVAL = 900e3
# The time that a text channel should be inactive for to sweep it
CHANNEL_MAX_INACTIVITY = 1700e3
# The time that needs to elapse for a channel to be considered not new
CHANNEL_JUST_CREATED_THRESHOLD = 120e3

# Client Settings
# The Update Interval used by the Client to check Voice Channel State when playing Audio
#  This must be less than the Number specified in CLIENT_PLAYER_IDLE_TIME
CLIENT_PLAYER_UPDATE_INTERVAL = 10e3
# The Time to wait to Destroy the Voice Connection after it Starts Idling
CLIENT_PLAYER_IDLE_TIME = 60e3

# The Save Interval between Log Saves
LOGGER_SAVE_INTERVAL = 3600e3

# The Default Locale for the Bot ( This field is not required )
DEFAULT_LOCALE = "en-us"

# Rich Presence Settings
# RP Update Interval in Milliseconds
RP_UPDATE_INTERVAL = 3600e3

# Notifications Settings
# Notifications' Update Interval in Milliseconds,
#  a number too low may result in temp bans from some APIs
NOTIFICATIONS_UPDATE_INTERVAL = 1800e3

# Database Settings
DB_MODE = "sqlite"

# SQLite Settings for "sqlite" mode
SQLITE_STORAGE = "./data/database.sqlite"

# MariaDB Settings for "mariadb" mode
MARIADB_HOST = "192.168.1.100"
MARIADB_PORT = 3306
MARIADB_DATABASE = "JackBot"
MARIADB_USERNAME = "jack"
MARIADB_PASSWORD = "jack-is-cool"

2. Run npm i to install all dependencies
3. Run npm run start to run the project

NOTE: This Project uses Node v16.13.0

Contributing

This project uses EditorConfig, so if you're using VSCode you should download the EditorConfig extension specified in the Official Site: https://editorconfig.org

It also uses ESLint, extensions can be found at the following link: https://eslint.org/docs/user-guide/integrations
The ESLint module is a dev dependency of this project.