Skip to content

Gorfig automatically populates the codebase for your discord bot with vital guild-specific information.

License

Notifications You must be signed in to change notification settings

aaryamvn/gorfig

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gorfig (Not Ready For Usage)

Making a discord bot for a specific server? Gorfig automatically populates the codebase for your bot with vital guild-specific information and it's types.

Supports

  • Channel Information
  • Role Information
  • Emoji Information
  • Sticker Information
  • Webhook Information

Use Case

When you're building a tool or a bot for a specific discord server, it's likely you'll need to work with common data or "information" for features like roles, channels, and more. This data is usually extracted manually and put into a certain file of your codebase.

For example, if you needed the IDs and Names of every single role in your guild, manually obtaining it can become time-consuming.

How To Use Gorfig

Add Gorfig Bot to your Discord Server

First, you need to add the Gorfig Discord Bot to the guild you want to obtain information for.

Initialize Gorfig in your Codebase

> cd my_bot_codebase
> npm install gorfig
> gorfig init

Populate your Codebase with Guild Information

> gorfig populate

Contributing

This project is lead by @aaryamvn (Aaryaman Maheshwari).

If you are interested in contributing to this project, make a pull request into the dev branch. Please ping aaryaman#0001 in the Gorfig Discord Server prior to making any form of contribution.

About

Gorfig automatically populates the codebase for your discord bot with vital guild-specific information.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages