https://github.com/argentum11/discord-bot
A Discord bot written in Typescript
https://github.com/argentum11/discord-bot
discord-bot typescript
Last synced: 3 months ago
JSON representation
A Discord bot written in Typescript
- Host: GitHub
- URL: https://github.com/argentum11/discord-bot
- Owner: Argentum11
- Created: 2024-07-25T02:38:35.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-09-09T15:10:16.000Z (8 months ago)
- Last Synced: 2024-09-09T18:38:03.657Z (8 months ago)
- Topics: discord-bot, typescript
- Language: TypeScript
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Discord bot
A Discord bot written in Typescript
## How to use
### Prerequisites
- **Bot Token**
- A bot token is required for the bot to log in to Discord and interact with the Discord API. You can obtain this from the [Discord Developer Portal](https://discord.com/developers/applications).
### Run the Bot Application
1. **Install dependencies**
```bash
npm install
```
2. **Set Up Environment Variables**
Make a copy of the `.env.template` file and rename it to `.env`. Then, fill in the required tokens:
```bash
cp .env.template .env
```
Open the `.env` file and fill in your tokens and other necessary configurations.
3. **Launch the Bot**
```bash
npm start
```
## Fundamental Concepts
### Intents
Intents refer to a way of specifying which events your bot is interested in receiving from Discord
#### Types
- General Intents
- Available to all bots
- ```Guilds```
- Allows the bot to receive events related to guilds (servers).
- Privileged Intents
- require explicit approval from Discord
- ```GuildMembers```
- allows your bot to receive events related to server members, like joining or leaving.
- ```MessageContent```
- allows your bot to receive the full content of a message
### Partials
Partials in Discord.js represent pieces of data that may be incomplete or "partial" when received from Discord's API. They are used to handle situations where Discord doesn't send complete objects in certain events to save bandwidth and improve performance.
#### use case
- Receiving events for uncached messages (e.g., reactions on old messages)
- Handling DM (Direct Message) events
- Working with threads or thread members that aren't fully cached
- Dealing with guild members or users that aren't fully cached
## References
[Intent description](https://ithelp.ithome.com.tw/articles/10318888)