rhearmas/cardboardbox
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

GitBook: [master] 3 pages modified

Browse source
This commit is contained in:
carol 2020-03-19 15:40:49 +00:00 committed by gitbook-bot
parent 70d642b7fd
commit 202aacc4b0
No known key found for this signature in database
GPG key ID: 07D2180C7B12D0FF
3 changed files with 60 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.md
View file

@ -1,57 +1,27 @@
<h1 align="center">Cardboard Box</h1>
---
description: Official documentation of the Cardboard Box
---
# Welcome
## Information
**Cardboard Box** is a [Discord](https://discordapp.com) bot for my [**Discord server**](https://discord.gg/4zJ8xqV) powered by [Discord.js](https://discord.js.org). 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.
**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
### Adding the bot to your guild
Don't want to run the bot yourself? Simply use [this link](https://discordapp.com/oauth2/authorize/?permissions=8&scope=bot&client_id=618576806177538079) to invite it to your own guild. If you prefer to run it under your own bot name, read the section below.
Don't want to run the bot yourself? Simply use [this link](https://discordapp.com/oauth2/authorize/?permissions=8&scope=bot&client_id=618576806177538079) to invite it to your own guild.
<h1 align="center">Running it yourself</h1>
## Credits
If you're really wanting to use this bot yourself, let's go over what you need and how to install it.
* [SharpBot, a selfbot for Discord](https://github.com/RayzrDev/SharpBot) was actually my source for most of these cool commands! Huge kudos to [RayzrDev](https://github.com/RayzrDev) for making a cool selfbot.
* This was initially an edit to [GuideBot, the boilerplate example bot in Discord.js](https://github.com/AnIdiotsGuide/guidebot). It has some minor edits to the base code, but most of the basic stuff came from this very example bot.
## Requirements
- `git` command line. Install by clicking your operating system's name in this list:
- [Windows](https://git-scm.com/download/win)
- [Linux](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Macintosh](https://git-scm.com/download/mac)
- `node` version [8.0.0 or higher](https://nodejs.org).
- Your **Discord bot token.** Read the first section of [this page](https://anidiots.guide/getting-started/the-long-version.html) on how to snag it.
- `Python`. Install it from [here](https://www.python.org/downloads).
## 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](https://finitereality.github.io/permissions-calculator/?v=0) to get your link. It even has a calculator for permissions!
<h1 align="center">Credits</h1>
- [SharpBot, a selfbot for Discord](https://github.com/RayzrDev/SharpBot) was actually my source for most of these cool commands! Huge kudos to [RayzrDev](https://github.com/RayzrDev) for making a cool selfbot.
- This was initially an edit to [GuideBot, the boilerplate example bot in Discord.js](https://github.com/AnIdiotsGuide/guidebot). It has some minor edits to the base code, but most of the basic stuff came from this very example bot.
<h1 align="center">Join me</h1>
## 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
## [https://discord.gg/4zJ8xqV](https://discord.gg/4zJ8xqV)

8
SUMMARY.md Normal file
View file

@ -0,0 +1,8 @@
# Table of contents
* [Welcome](README.md)
## Bot Usage
* [Host the bot yourself](bot-usage/host-the-bot-yourself.md)

38
bot-usage/host-the-bot-yourself.md Normal file
View file

@ -0,0 +1,38 @@
---
description: Make the Box your own copy!
---
# Host the bot yourself
If you're really wanting to use this bot yourself, let's go over what you need and how to install it.
### Requirements
* `git` command line. Install by clicking your operating system's name in this list:
* [Windows](https://git-scm.com/download/win)
* [Linux](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Macintosh](https://git-scm.com/download/mac)
* `node` version [8.0.0 or higher](https://nodejs.org).
* Your **Discord bot token.** Read the first section of [this page](https://anidiots.guide/getting-started/the-long-version.html) on how to snag it.
* `Python`. Install it from [here](https://www.python.org/downloads).
### 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 =&gt; Open &lt;Powershell/command terminal&gt; 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](https://finitereality.github.io/permissions-calculator/?v=0) to get your link. It even has a calculator for permissions!