Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
<h1 align="center">Discord Bot Client</h1>

**Discord Bot Client** allows you to use your bot, just like any other user account, except Friends and Groups. 

## Overview

- [How to install it](#installation)
  - [Using prebuilt binaries](#using-prebuilt-binaries)
  - [Building from source](#building-from-source)
- [Login](#login)
- [Features](#features)
- [Discord Version](#version)
- [Troubleshooting](#troubleshooting)
- [FAQ](#faq)
- [Similar projects](#similar-projects)
- [Credits](#credits)

**WARNING: Third party clients are discouraged and against the Discord TOS.**

Discord Bot Client is a custom [Discord](https://discord.com/app) client that aims to
support bot accounts and be aimed at power-users.


The application only uses the official Discord API and doesn't send data to
third parties. However, this application is not an official product by
Discord Inc.

![Demo Screenshot](https://cdn.discordapp.com/attachments/820557032016969751/1128535575281029150/image.png)

---

## Installation

### Using prebuilt binaries

If you don't want to build the application yourself or use some kind of
package management system, you can get the latest binaries for the three
major systems in the release overview:

https://github.com/aiko-chan-ai/DiscordBotClient/releases/latest

### Building from source

In order to execute the following commands, you need to install **NodeJS v16 or**
higher. You can find nodejs packages at https://nodejs.org/en.
On top of that, you need to have **git** installed. It can be fund at
https://git-scm.com/downloads.

**UPDATES HAVE TO BE INSTALLED MANUALLY**

Open a command line and execute the following commands:

```shell
git clone https://github.com/aiko-chan-ai/DiscordBotClient.git
cd DiscordBotClient
npm install
npm run build
```

This will create an executable called `DiscordBotClient` or `DiscordBotClient.exe` in the `dist` folder depending on whether you are using Windows or not.

---

### Login

Logging in works via the UI on first startup of the application.

![screenshot](https://cdn.discordapp.com/attachments/820557032016969751/1128537663864045608/image.png)

> **Note**
> Enable `MessageContent` intent, other intents are optional

![image](https://cdn.discordapp.com/attachments/820557032016969751/1128538612175220906/image.png)

---

## Features

- **View Guilds** *(Lazy load them)*
- **Manage Guilds** (Name, Image, Audit log, Emoji, Webhooks, Invites, Bans, Widget, Moderation, Roles)
- **Manage Channels** (Add, Delete, Name, Permissions, Invites, Webhooks, Slowmode, NSFW, Topic, Forums, Threads)
- **Messages** (Send, View History, Embeds, View Reactions, Add/Remove Reactions, Delete, Edit, Pin)
- **Create a Guild** (if the bot has fewer than 10 Servers)
- **Voice Support** (Text-in-Voice and watch the user using the camera)
- **Use Emojis from other servers** (Nitro)
- **GIF Search**
- **Send Files**
- **DM's** (DM's will show up, after a user dms the bot)

---

## Version

| Discord Build | Hash | Vencord | Discord Bot Client | Status |
| --- | --- | --- | --- | --- |
| Stable 161052 | c7e0778 | - | v1 | Deprecated |
| Stable 185832 | 29333f6 | v1.1.4 | v2.1 | Deprecated |
| Stable 204762 | 78f82ba | v1.2.8 | v2.2+ | Latest |

---

## Troubleshooting

If you happen to encounter a crash or a bug, please submit a bug report via
the projects GitHub issue tracker.

# FAQ

In order to find answers to common questions, check out the FAQ in the [wiki](aiko-chan-ai/DiscordBotClient#8):

## Similar projects

Here is a list of similar projects:

- [Discord Bot Client](https://github.com/SamuelScheit/discord-bot-client)
- [BotClient](https://github.com/DarkGuy10/BotClient)
- [ChrisEric1.GitHub.io](https://github.com/ChrisEric1/ChrisEric1.GitHub.io)
- [LiveBot](https://github.com/SebOuellette/LiveBot)
- [BetterDiscordPanel](https://github.com/SanjaySunil/BetterDiscordPanel)

Hit me up if you have a similar project, and I'll gladly add it to the list.

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=aiko-chan-ai/DiscordBotClient&type=Date)](https://star-history.com/#aiko-chan-ai/DiscordBotClient&Date)

---

## How to update to the latest Discord version ?

- Step 1: Patch index.html (Get it from discord.com/channels/@me)

- Step 2: Patch script.js (search for keyword `_doIdentify` in the code)

- Step 3: Change like me (see location in template file, search by keyword `// Patch #{number}`)

## Credits

Big thanks to [ChrisEric](https://github.com/DrxcoTheBulider) for helping me create a local proxy server! (code)

This project was mainly inspired by [SamuelScheit](https://github.com/SamuelScheit)
[Discord Bot Client](https://github.com/DrxcoTheBulider), which he sadly didn't
develop any further.
  • Loading branch information
DrxcoTheBulider authored Nov 4, 2023
0 parents commit 725d976
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- 👋 Hi, I’m @DrxcoTheBulider
- 👀 I’m interested in ...
- 🌱 I’m currently learning ...
- 💞️ I’m looking to collaborate on ...
- 📫 How to reach me ...

<!---
DrxcoTheBulider/DrxcoTheBulider is a ✨ special ✨ repository because its `README.md` (this file) appears on your GitHub profile.
You can click the Preview link to take a look at your changes.
--->

0 comments on commit 725d976

Please sign in to comment.