Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/darkguy10/botclient

A discord botclient built with Electron, React and discord.js.
https://github.com/darkguy10/botclient

bot botclient discord discord-api discord-bot-client discord-js electron

Last synced: 5 days ago
JSON representation

A discord botclient built with Electron, React and discord.js.

Awesome Lists containing this project

README

        


Logo


BOTCLIENT


Features
·
Downloads
·
Building from Source
·
Setting Up
·
FAQs



Stargazers


Releases


Downloads


Discord

 


BotClient is an open-source client for logging in as a discord bot. It's built using Electron, giving it complete cross-platform support! In addition, it uses the powerful electron-updater module to provide auto-updates on all supported binaries. The project aims to be extremely expandable, so that new features and future updates can be easily added.

 

![Demo](assets/window.png)

 

### ✨ Features

- UI and workflow modelled after the original Discord client
- Neatly built using React as frontend and powered by discord.js at core
- Persistent token storage
- Support for all major desktop platforms
- Installable binaries with auto updates

 

### 📦 Downloads



Platform


Binary Type


Download Link




Windows


NSIS installer



BotClient-win-x64.exe




Linux
.AppImage

BotClient-linux-x86_64.AppImage



Mac
.dmg

BotClient-mac-x64.dmg



All binaries support auto-updates.

Release notes for the latest release can be found [here](https://github.com/darkguy10/BotClient/releases/latest/).

 

### 🔧 Building from Source

The client can also be built from source for individual platforms.

#### Prerequisites

- [Git CLI](https://git-scm.com/downloads)
- [NodeJS](https://nodejs.org/en/download/)
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install)

#### Building

1. Clone the repository and cd into it.

```
git clone https://github.com/DarkGuy10/BotClient.git
cd BotClient
```

2. Install required dependencies.

```
yarn install
```

3. Run the build script.

```
yarn build
```

The compiled app is in the `dist/` folder.

 

### 🚀 Setting Up

#### Prerequisites

Your bot must have all three [Privileged Gateway Intents](https://discordjs.guide/popular-topics/intents.html#privileged-intents) enabled.

#### Logging in

Once you have downloaded and installed the client, simply run it from the start menu or any app launcher.

You should be prompted by a login screen, enter your bot's token and hit enter.

That's literally all there is to it! ✨

If you have any problems or questions about the client, feel free to join our [support server](https://discord.com/invite/aZSrxwNUFD) on Discord.

 

### 📚 FAQs

- Q: I'm getting `[DISALLOWED_INTENTS]` error, how do I fix this?

- A: Your bot must have all three [Privileged Gateway Intents](https://discordjs.guide/popular-topics/intents.html#privileged-intents) enabled.

- Q: The client is stuck on loading screen, how do I fix this?

- A: This happens because of mis-configured appdata. Clear the client appdata by deleting your `%userprofile%\AppData\Roaming\BotClient` folder if you're on windows,`~/.config/BotClient` folder for linux or `~/Library/Application Support/BotClient` for mac.

- Q: Is there a website version of this client?

- A: Nope, and there won't be one in the future, reasons being it's too much work and simply not worth it.

- Q: What about Android or iOS?
- A: No support for mobile devices, and will never be added either.

 

### 📜 License

BotClient is released under the MIT license, which grants the following permissions:

- Commercial use
- Distribution
- Modification
- Private use

For more convoluted language, see the [LICENSE](https://github.com/darkguy10/BotClient/blob/main/LICENSE).

 

### 💝 Contributors

GitHub contributors (via allcontributors.org)

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



DarkGuy10

💻 📖 📆

Duckulus

📖

jerbear4328

💻

pxter

🐛

SkyLayzer

🎨

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!