cardboardbox/README.md
2019-12-23 14:07:43 -05:00

3.6 KiB

Cardboard Box

Information

Cardboard Box is a Discord bot for my Discord server powered by Discord.js. It comes packaged with many utilities and fun stuff, and even some special moderation functions.

This bot is not suitable for usage outside of my Discord server! This repository is primarily for issue tracking and global management between my own devices. If you really, really want to run it yourself, read the sections below.

Adding the bot to your guild

Don't want to run the bot yourself? Simply use this link to invite it to your own guild. If you prefer to run it under your own bot name, read the section below.

Running it yourself

If you're really wanting to use this bot yourself, let's go over what you need and how to install it.

Requirements

Installation

  1. Head on over to your terminal (preferrably Command Prompt) and clone the repository.
    • If you want to clone to a specific folder, you have two options:
      • cd into your desired folder. For example, if you wanted to clone the repository into Documents, open the terminal normally and run cd C:/Users/<user>/Documents.
      • Open the terminal in a specific folder by doing Shift-Rightclick => Open <Powershell/command terminal> here.
    • After doing either of those steps, clone the repository by running git clone https://github.com/rhearmas/cardboardbot.git through your terminal.
  2. When git has finished, cd into the newly-created folder for the repository.
  3. Run npm install. This installs all the prerequisites for the bot through Node package manager, which is bundled with node.
    • If you get any errors about python or msibuild.exe or binding, read the requirements section again and make sure you've installed everything.
  4. Run node setup.js to get a configuration file added.

Running the bot

Open your terminal and run node index.js inside the folder. Don't forget to cd into it if the folder isn't in places like your Desktop.

Getting it to your server

Generate an OAuth link for your bot. Use this delicious link to get your link. It even has a calculator for permissions!

Credits

Join me

If you need a fun server to join, regardless of whether or not you're new to Discord, join now! If you've never used Discord before, don't fret! It only takes a few minutes to sign up and get started.

https://discord.gg/4zJ8xqV