FadBot

A Multipurpose Open-Source Bot in TypeScript

About The Project

FadBot is a multipurpose and open-source discord bot currently being developed using typescript. Currently, there's only one dev working on it, but I will try my best to frequently add more features.

Here are some things that you can expect from the bot:

None of the main features of the bot will be put behind a paywall.
Might have some fun minigames that you could play with your friends!
Will implement some new features of the Discord API such as Context and Dropdown Menus, Buttons, Ephemeral Messages (and hopefully slash commands and threads).

Built With

discord.js
typescript (using ts-node)
FadBotClient (FadBot's Custom Client)
dbCache (FadBot's Custom dbCache Maps)
FBEmbed (FadBot's Custom MessageEmbed)
FBLogger (FadBot's Logging Util)

Devs

Fad The Chad

Contributors

tonyG
Xapu/Ram

Version

Current Version: v1.11.0

See CHANGELOG.md for all changes

Trello

If you want to see some ideas/features that the bot could get, check out our Trello Page!

Get Started

Requirements

Node v16.6+ is required. You can install it at their official site.
typescript and ts-node is required. You can install it by doing
```
npm i -g typescript ts-node
```

Installation

Clone this repo
Install the NPM Packages
```
npm install
```
Make a config.json file in the root of the directory and add:
```
{
  "token": "Your Token Here",
  "prefix": "Your Prefix Here",
  "devs": ["devId1", "devId2"],
  "clientId": "Your Client ID Here",
  "guildId": "Your Guild ID Here",
  "mongoURI": "Your Mongodb Uri String Here"
}
```
- token is the Bot's Token. You can receive it from Discord's Developer Portal.
- prefix is the bot's prefix.
- devs stores the ID of discord users that can run secret dev commands. You can add as many devs as you want, but It's recommended to keep it small.
- clientId is your Client's ID. You can receive it from Discord's Developer Portal. [For Slash Cmds]
- guildId is your Testing Guild/Server's ID. [For Slash Cmds]
- mongoURI is the connection srv/local string of your mongoDB DB.
Run the test script in the scripts folder to check if everything is good to go.
And finally, run the bot!
```
ts-node .
```
Or
```
npm start
```

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Pull Requests

Fork the Project.
Create your Feature Branch (git checkout -b feature/AmazingFeature).
Commit your Changes (git commit -m 'Add some AmazingFeature').
Push to the Branch (git push origin feature/AmazingFeature).
Open a pull request. We will review the changes (and hopefully merge it!).

Check out CONTRIBUTING.md before doing the above!

Issues

Have a feature idea? Want to report a bug? Simply create an issue, and we will try to see what we can do! Make sure to check both of our Issue Templates before you send one!

Code Of Conduct

We expect you to be respectful with each other and create a happy environment! See CODE_OF_CONDUCT.md for more details!

License

Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.

Disclaimer

You are very free to implement some of FadBot features for your code. But it would really be nice if you give credit. Would mean a lot to me

Contact

Our Support Discord Server: https://discord.gg/3tEGymY5pE

FadTheChad/FadBot