crrystalz / Emerald

🟒 The all in one bot made for programmers and their teams. GitHub integration, custom code commenting with line by line specification.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

🟒 Emerald [WIP]

Emerald is an all in one bot made for programmers and their teams. GitHub integration, custom code commenting with line by line specifications.

  • Wrote in discord.js v13, and supports slash commands

Using Emerald

Emerald can be invited to any Discord server with this link

A full list of Emerald's commands can be viewed by running /help

Locally running a copy of Emerald

As Emerald is currently hosted on my own computer, the bot is often down. However, it's easy to get a copy of Emerald up and running on your own computer. Please refrain from calling the bot your own work, and any modifications you wish to make to the bot please add as a pull request rather than modifying the bot in your own server, and you will be duly credited for your contribution(s).

Node Installation

Windows and macOS

Install the LTS Node.js installer for your operating system here

Arch

pacman -S nodejs npm

Fedora

dnf module install nodejs:<stream> where <stream> corresponds to the major version of Node.js

To view a list of available streams:

dnf module list nodejs

Debian and Ubuntu based

Node.js binary distributions are available from NodeSource.

Gentoo

emerge nodejs

Cloning the repository

Follow the steps provided here

Creating an application/bot in the Discord Developer Portal

Navigate to the Discord Developer Portal and sign in with your Discord account. Next, press create application and type in a name, preferrably name it Emerald-{insert your server's name} and set a profile picture for the bot (the one used in the official bot can be found here). Now that your Discord application is all setup, create a bot by navigating to the bot menu on the left hand side. Click on "Add bot" and confirm. Then copy the token to your clipboard, this will be used later.

Inviting the bot to your server

Click on the OAuth2 button in the menu on the left, and activate the "bot" and "applications.command" scopes. Then in Bot Permissions, give your bot Administration access, and the link generated will invite the bot to your server when activated.

Activating the bot

In order to activate the bot, create a file in the root folder of the cloned repository called .env. In this file type DISCORD_TOKEN = {insert_token_here}. Paste in the token from your clipboard that you copied earlier, note that there shouldn't be any curly braces. Finally. in command prompt, navigate to the root directory of the bot and type node ., this should start the bot.

If you're are having trouble locally hosting the bot, DM me on Discord at @crrystalz

Please report any issues with using the bot here. If you have any feature requests, send them to me on Discord at @crrystalz

About

🟒 The all in one bot made for programmers and their teams. GitHub integration, custom code commenting with line by line specification.


Languages

Language:JavaScript 93.4%Language:Python 6.6%