https://github.com/patryk-ku/discord-bot
Simple self-hosted multipurpose Discord bot designed for use in small/private discord servers.
https://github.com/patryk-ku/discord-bot
discord discord-bot discordjs lastfm nodejs yt-dlp
Last synced: 3 months ago
JSON representation
Simple self-hosted multipurpose Discord bot designed for use in small/private discord servers.
- Host: GitHub
- URL: https://github.com/patryk-ku/discord-bot
- Owner: patryk-ku
- License: mit
- Created: 2023-11-19T21:13:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-30T18:32:23.000Z (4 months ago)
- Last Synced: 2025-01-30T19:35:25.898Z (4 months ago)
- Topics: discord, discord-bot, discordjs, lastfm, nodejs, yt-dlp
- Language: JavaScript
- Homepage:
- Size: 311 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# discord-bot
Simple self-hosted multipurpose Discord bot designed for use in small/private discord servers. This bot is also 100% compatible with Termux because I host it myself on an old android phone.
## Commands
### Google Gemini AI
This bot has optional AI chat functionality using Google Gemini. To chat with the bot, simply @mention it in a text channel that the bot has access to. If you have configured everything correctly the bot should reply to the message after a short while. Chat history is saved up to 40 (one user question + bot reply, so a total of 80 messages). Chat history is shared between the whole server and all users. The bot is configured by default to recognise users by their nickname (Discord Display Name).
You can also attach images to messages (up to 2.75 MB in .png, .jpg, .webp, .heic, .heif formats). Messages with images are saved in the chat history, but the request itself cannot access it because it uses a different model which is not suitable for chatting. The picture itself is not saved either, the bot only has access to the user's question and its own answer to the question with the picture.
The behaviour of the bot can be changed by editing the default prompts in the .env file. See the comments in this file for more information.
> [!TIP]
> In order for the bot to be able to read users messages on the server, you need to enable **MESSAGE CONTENT INTENT** in the bot settings on the Discord Developer Portal.
At this moment, access to the Gemini API is free up to 15 queries per minute and 1500 requests per day but this may change at any time.
> [!IMPORTANT]
> The Google Gemini API is not available for free in Europe at the moment. But you can bypass this by using a VPN or Proxy. You can make the bot use the proxy only for Gemini API commands by setting the `PROXY_URL` variable in the `.env` file.
| command | description |
| ----------- | ----------- |
| `/gemini` | A simple query to the AI assistant (without chat history and any aditional prompt settings). It also supports image input. |
| `/chatbot reset` | Reset chatbot history to start new clean chat. |
| `/tldr` | Summarizes recent messages on this channel using AI. |
### Last.fm
| command | description |
| ----------- | ----------- |
| `/lastfm nickname set` | Set or update your lastfm nickname. |
| `/lastfm nickname remove` | Delete your lastfm nickname from bot database. |
| `/lastfm nickname lock` | Prevent the server admins from changing your nickname. |
| `/np` | Replies with your now playing song. |
| `/playing` | Replies with every server user now playing song (max 25 users). |
| `/lastfm recent` | Replies with user recently scrobbled songs. |
| `/yt` | Replies with first video from youtube search of user now playing song. |
| `/lastfm collage` | Replies with user top albums collage. |
| `/lastfm top artists` | Replies with user top artists chart. |
| `/lastfm top albums` | Replies with user top albums chart. |
| `/lastfm top tracks` | Replies with user top tracks chart. |
| `/lastfm profile` | Replies with user last.fm profile summary. |
| `/lastfm server artist` | Replies with artist playcount for each member of the server (max 25 users, do not use this command on large servers). |
### Listenbrainz
| command | description |
| ----------- | ----------- |
| `/listenbrainz nickname set` | Set or update your listenbrainz nickname. |
| `/listenbrainz nickname remove` | Delete your listenbrainz nickname from bot database. |
| `/listenbrainz np` | Replies with your now playing song. |
| `/listenbrainz cover` | Replies with high-res cover art of user now playing song (from listenbrainz). |
### League of Legends
> [!WARNING]
> These commands are experimental and may not work properly.
| command | description |
| ----------- | ----------- |
| `/lol nickname set` | Set or update your League of Legends nickname. |
| `/lol nickname remove` | Delete your League of Legends nickname from bot database. |
| `/lol np` | Replies with user current game info (if playing). |
| `/lol playing` | Replies with entire server current game info. |
| `/lol recent` | Replies with user last games info. |
### Utility
| command | description |
| ----------- | ----------- |
| `/embed` | Embeds video from given url (insta/reddit/twitter etc). |
| `/avatar` | Embeds avatar image of given user. |
### Voice
> [!WARNING]
> These commands are experimental and may not work properly.
| command | description |
| ----------- | ----------- |
| `/join` | Request bot to join a voice channel. |
| `/play` | Request bot to play music from a given link in a voice channel. |
| `/leave` | Request bot to leave a voice channel. |
### Administrator commands
They require administrator privileges on the server
| command | description |
| ----------- | ----------- |
| `/admin lastfm set` | Set or update last.fm nickname of given user. |
| `/admin lastfm remove` | Delete lastfm nickname of given user from bot database. |
| `/admin lastfm users` | List all last.fm users from this server. |
### Configuration commands
These commands can only be used by the owner of an instance of this bot
| command | description |
| ----------- | ----------- |
| `/config status` | Set bot status. |
| `/config activity` | Set bot activity. |
| `/config restart` | Restart bot (use only when hosting a bot with any process manager for node.js, default for this bot is [pm2](https://pm2.keymetrics.io/)). |
### Debug commands
| command | description |
| ----------- | ----------- |
| `/debug termux` | Debug info about the Termux instance (if in use). |
| `/debug voice` | Debug info about the voice internals. |
| `/debug settings` | Debug info about bot enabled APIs and settings. |
## Requirements
- Node.js v18 or higher
- yt-dlp (for `/embed` command)
- MP4Box (for `/embed` command, optional in some cases)
- Any modern Linux instalation (for now this bot is linux only, may change later)
## Installation and setup
1. Go to [Discord Developer Portal](https://discord.com/developers) and create new application with bot. Get here `APPLICATION ID` and `BOT TOKEN` and copy them to `.env.example` file.
2. Discord bot permissions:
Privileged Gateway Intents:
- SERVER MEMBERS INTENT
- MESSAGE CONTENT INTENT (needed only for AI chatbot)
OAuth2 invite URL permissions:
- Scopes:
- Bot
- applications.commands
- Bot permissions:
- Read Messages/View Channels
- Send Messages
- Embed Links
- Attach Files
- Mention Everyone
- Use Slash Commands
- Connect
- Speak
- Use Voice Activity
3. For last.fm features you need to obtain their API key [here](https://www.last.fm/api/account/create). For Listenbrainz features you need your profile token from [here](https://listenbrainz.org/profile/).
4. Clone repository and rename `.env.example` to `.env`
```sh
mv .env.example .env
```
Now insert all API keys and tokens into `.env` file. Some are optional, check comments inside file for more info. There are also a couple of options for configuring the bot. Check the comments in the file for more information.
5. Run
```sh
npm install --omit=dev
```
6. If you want the bot commands to work on only one server:
- Uncomment `DISCORD_GUILD_ID` in `.env` and insert your server id here
and run
```sh
npm run deploy-commands
```
If you want the bot commands to work on multiple servers:
run
```sh
npm run deploy-global-commands
```
7. Finally to start the bot
```sh
npm run start
```
If you did everything correctly, you should see in the terminal:
```
Ready! Logged in as your-bot-name#and-id
Connection to database has been established successfully.
```
To restart bot use:
```sh
npm run restart
```
To stop bot:
```sh
npm run stop
```
Other useful commands:
- `npm run reload`
- `npm run monit`
- `npm run logs`
- `npm run dev`
## Made with
- [Node.js](https://nodejs.org/)
- [Discord.js](https://discord.js.org/)
- [Sequelize](https://sequelize.org/)
- [SQLite](https://www.sqlite.org/)