Slate

A Discord.js Bot Startup Codebase

The best way to start your new Discord.js bot.

Table of Contents

• Key Features
• Getting Started
  • Installation Guide
    • Linux
    • Windows 10

Key Features

• Easily configurable
  • Easily change your prefix, bot owners, or developer guild
  • Select which Discord intents your bot should start with
  • Select which Discord events should load
  • Blacklist users and servers
    • Choose to ignore or leave blacklisted servers
  • Choose which commands should be loaded
  • Determine active logging levels
  • Easily Customizable bot presence
• Comprehensive Logging and Debugging
• Support for all Discord.js Events
• Flexible commands
  • Supports slash and prefix commands
  • choose if commands are usable in DMs
  • optional NSFW properties
  • Custom aliases
  • Customizable cooldowns
    • Per user
    • Per server
    • Global

Commands

• Owner
  
  • BotClear - Mass deletes bot commands used in the current channel.
    
  • CommandToggle - Toggles the given command.
    
  • Deploy - Deploys global and guild slash commands.
    
  • Eval - Evaluates given code.
    
  • EventToggle - Toggles the given Discord.js event.
    
  • Fail - Tests a given error.
    
  • Logs - Retrieves the latest bot logs.
    
  • LogTest - Tests each logger level.
    
  • LogToggle - Toggles logging for the specified level.
    
  • Raw - Relays the raw data of the replied message.
    
  • Reload - Reloads a either a given command or all commands.
    
  • Shutdown - Shuts the bot down gracefully.
    
  • Test - Test slash command with subcommands and options.
    
  • Prefix - Change the bot's prefix as needed.
    
• Miscellaneous
  
  • Ping - Shows the bot uptime as well as the bots connection to Discord.
    
• Info
  
  • About - Shows information about the bot.
    
• Utility
  • Temperature - Convert the provided temperature.
    
  • Avatar - Fetch the provided user's avatar.
    
  • Banner - Fetch the provided user's banner.
    
  • Enlarge - Enlarge the provided emoji.<
    
  • Math - Solve the provided math equation.
    
• Fun
  • CoinFlip - Flip a Coin!
    
  • Number - Generate a random number within a given range.

Getting Started

Installation Guide

Slate can be installed by using the following instructions.

Linux Command Line Installation

1. Update package lists:

• Debian/Ubuntu: sudo apt update && sudo apt upgrade
• Fedora/CentOS: sudo dnf upgrade
• Arch Linux: sudo pacman -Syu
• openSUSE: sudo zypper dup

2. Installing prerequisites:

• Debian/Ubuntu: sudo apt install git nodejs npm
• Fedora/CentOS: sudo dnf install git nodejs
• Arch Linux: sudo pacman -S git nodejs npm
• openSUSE: sudo zypper install git nodejs npm

3. Clone the GitHub repository

git clone https://github.com/isahooman/Slate.git .
cd Slate

4. Configuring Slate

Next you'll need to setup config.json5 as well as the optional extra config files.

sudo nano ./config/config.json5

You can follow the configuration example here if needed.

5. You're now ready to run slate

npm run start

Windows 10 GUI + Command Line

1. Install node from the one of the following methods

• Node v20.11.0 Direct Install Link
• Node Website

winget install OpenJS.NodeJS

2. Download the zip file of the Slate Repository

# Get the zip file of Slate
curl -uri "https://github.com/isahooman/Slate/archive/main.zip" -Method "GET" -Outfile "Slate.zip"

3. Extract the zip file to a file location of your choice

# Unzips the zip file to your directory
tar -xvf Slate.zip

4. Configuring Slate

Next you'll need to configure your bot in config.json5 as well as the optional extra config files.

# Opens the config file within the notepad text editor
notepad ./config/config.json5

You can follow the configuration example here if needed.

5. You're now ready to run your bot!

# Installs the npm prerequisites and starts the bot
npm run start

Darwin/Mac 10 GUI + Command Line

1. Install node from the one of the following links

• Node v20.11.0 Direct Install Link
• Node Website

brew install node

2. Download the zip file of the Slate Repository

# Get the zip file of Slate
curl -L -O https://github.com/isahooman/Slate/archive/main.zip

3. Extract the zip file to a file location of your choice

# Unzips the zip file to your directory
tar -xvf Slate-main.zip

4. Configuring Slate

Next you'll need to configure your bot in config.json5 as well as the optional extra config files.

# Opens the config file within the notepad text editor
nano ./config/config.json5

You can follow the configuration example here if needed.

5. You're now ready to run your bot using the start.sh file!

# Installs the npm prerequisites
npm start

Contributing

Contributions are always welcome! Please read our contribution guidelines before contributing.

Credits

• Electron
• NodeJS