sayurasm / magi-system

MAGI System, NERV inspired utility Discord bot.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MAGI System 🧠 A utility Discord bot.

icon

βšͺ MAGI System is an Evangelion-inspired utility Discord bot.


πŸ”΄ I initially created this bot to study Discord automations by practical means. I am not a professional software engineer, product designer, programmers, et cetera. In this repository, you may find unconventional codewriting style, or a straight up mess of code/logic.

πŸ–€ I do, however, love the practice of design.

akagi

 

🧾 Table of Contents


 

πŸ”— Dependencies


MAGI System is written in JavaScript, built with discord.js.

Install dependencies of this bot with npm install after cloning it.

You will also need access to Discord Developer Portal, and make a New Application. Follow along the guide in discord.js Guide to get started.

 

πŸ’  Tokens


Most of the functions of MAGI System is dependant on other services such as the Discord bot application, and Alchemy for blockchain-related functions.

πŸ”‘ Obtain your Discord bot token once it's set up on Developer Portal.
πŸ”‘ Grab the Application ID of your Discord bot as well on Developer Portal.
πŸ”‘ Alchemy API key can be obtained with a free account on Alchemy.

 

πŸ’Ύ Create a .env file on the root directory of this app in your machine.

ALCHEMY_TOKEN = '<YOUR-KEY-GOES-HERE>'
DISCORD_TOKEN = '<YOUR-KEY-GOES-HERE>'
CLIENT_ID = '<YOUR-KEY-GOES-HERE>'

πŸ”» Be sure to never share or accidentally upload your personal tokens!

 

⏹ Bot Design


MAGI System is designed with modular functions in mind, following the discord.js Guide while applying necessary changes. In a nutshell, the bot consists of three main parts:

This is done to keep the development environment tidy, and ensure that future maintenance will be as easy as possible.

 

πŸ’¬ Commands


 

πŸ“° Contents


 

πŸ“’ Events


 

πŸ“‘ Deploy Commands


 

🦺 Maintenance


I maintain and upgrade this bot every once in a while. Publishing this repo is one way to ensure the relevance and quality-of-life to this bot.

Feel free to hit me up on Twitter @vngnc or github DM.

 

πŸŽ‡ Contribute


Feel free to submit a pull request, I will review every submitted PR.

 

enter

About

MAGI System, NERV inspired utility Discord bot.

License:MIT License


Languages

Language:JavaScript 100.0%