You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/welcome.md
+43-18Lines changed: 43 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,26 +3,51 @@ title: Welcome
3
3
sidebar_position: 1
4
4
---
5
5
6
-
# Welcome to BryanBot
7
-
BryanBot is open-source Discord bot that aims to provide fully modular and customizable experience for server owners and developers.<br />
8
-
Built with JavaScript and Discord.js library, BryanBot is designed to be easy to both use and develop for.
6
+
# 🚀 Welcome to BryanBot
9
7
10
-
## Features
11
-
The bot itself is built around **addons**, which are meant to add commands and other functionality to the bot. That's why the core does not come with a lot of commands by default. The bot is meant to be customized to your liking.
8
+
Welcome to **BryanBot**, an open-source **modular Discord bot** built for flexibility, customization, and performance. Whether you're managing a server, developing new features, or just looking for a powerful bot that fits your needs, BryanBot makes it easy to create a tailored Discord experience.
12
9
13
-
Default commands that come with BryanBot are `help`and `info`. They are used to provide information about the bot and its commands.
10
+
Built with **JavaScript (ESM)** and powered by **Discord.js**, BryanBot is designed to be **lightweight, scalable, and developer-friendly**. Unlike pre-configured bots that come with a set list of features, BryanBot is all about giving you control—customization is at the heart of its design.
14
11
15
-
The bot also comes with backup system that automatically backs up your configuration.
12
+
## 🎯 Why BryanBot?
13
+
-**Open-Source and Secure** - Built and maintained by the community, ensuring transparency and security.
14
+
-**No Hidden Code** - As an open-source project, all code is **publicly available**, preventing malicious modifications or security risks.
15
+
-**No Licensing Restrictions** - BryanBot gives you **full control without third-party limitations**, ensuring your bot remains truly yours.
16
+
-**Modular & Addon-Based** – Add only the features you need with **[customizable addons](/docs/development/introductions)**.
17
+
-**Optimized Performance** – Built for **speed and efficiency**, keeping your server running smoothly.
18
+
-**Developer-Friendly** – A structured API with **command, event, and config handlers** for easy development.
19
+
-**Minimal & Efficient** – No bloat, just the essentials. Expand the bot as needed.
20
+
-**Built-in Backup System** – Automatically saves your bot’s configuration to prevent data loss.
16
21
17
-
## Developer features
18
-
While not providing a lot of default functionality, BryanBot is built to be easily extended. That's why it comes with a lot of developer features, such as:
19
-
-**Command handler** - easily add new commands to the bot
20
-
-**Event handler** - handle Discord.js events with ease
21
-
-**Addon system** - extend the bot with addons and keep everything modular
22
-
-**Config system** - store and access configuration values and keep them organized
23
-
-**Database handler** - easily connect and store data in a database
24
-
-**Utility functions** - a lot of utility functions to make your life easier
25
-
And a lot more!
22
+
## 🛠️ Core Features
23
+
BryanBot is designed with **modularity in mind**, letting you enable or disable features as needed. The bot includes only **essential commands** out of the box, with the option to install additional addons.
26
24
27
-
## Getting started
28
-
Check out the [setup guide](/docs/setup/installation) to get started with BryanBot.
25
+
By default, BryanBot includes:
26
+
-**`help`** – Displays available commands and usage information.
27
+
-**`info`** – Provides details about the bot and its current version.
28
+
29
+
Need extra functionality? Whether it's **music playback**, **moderation tools**, or **reaction roles**, you can extend BryanBot with **community-made or custom addons**.
30
+
31
+
## 💻 Developer Tools
32
+
BryanBot provides a suite of powerful tools to help developers customize and extend the bot:
33
+
34
+
-**Command Handler** – A streamlined system for adding and managing commands.
35
+
-**Event Handler** – Easily listen for and respond to Discord events.
36
+
-**Addon System** – Build and install modular extensions to enhance the bot’s capabilities.
37
+
-**Config System** – Store and manage configuration values for easy customization.
38
+
-**Database Handler** – Seamless integration with databases for storing persistent data.
39
+
-**Utility Functions** – A set of helpful functions to make bot development more efficient.
40
+
41
+
## Are you a developer?
42
+
Just getting started with **BryanBot** and not sure where to go? Check out our **[development guide](/docs/development/introduction)** for learning how to develop addons using BryanBot.
43
+
There you will find a complete list of **utility functions**, how to use the **command and event handler** and finally how to create and format an addon to **bring your creations to life**!
44
+
45
+
## 🚀 Get Started Today!
46
+
Setting up BryanBot is simple and can be done in **under 10 minutes**! Follow our **[installation guide](/docs/setup/installation)** to get started. If you experience **any issues** during installation, please join our [discord](https://discord.gg/GvyuDDFeZU) to be assisted by a **dedicated support team**.
47
+
48
+
Want to contribute? Join our community and help improve BryanBot by submitting addons, bug fixes, and new features.
0 commit comments