sodium

KO | EN

gitlite — search

#hacktoberfest #llm #go #golang #android #machine-learning #rust #deep-learning #linux #java #nodejs #awesome #kubernetes #vue

(★ 15)

Multipurpose discord bot with application commands and a user-friendly interface

sodium Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a href="https://skyelements.vercel.app/sodium">
		<img src=".github/images/sodium.png" height="128">
		<h1 align="center">Sodium</h1>
		Multipurpose discord bot with application commands and a user-friendly interface
	</a>

<a href="https://skyelements.vercel.app/commands">Preview</a> ·
	<a href="https://github.com/yewshanooi/sodium/releases">Releases</a>

## Features
- **AI Chatbot** *(powered by Google Gemini)*
- **Moderation Logs & Leaderboard** *(stored using MongoDB Atlas)*
- **Music Streaming** *(powered by Lavalink)*
- **Text Summarizer** *(powered by Hugging Face Transformers)*
- **Third Party API** commands *(such as Giphy, Wikipedia, and more!)*
- **Watch Together** *(with YouTube activity)*

## Commands
<table>
	<tr>
		<td>Fun</td>
		<td>Moderation</td>
		<td>Music</td>
		<td>Utility</td>
	</tr>
	<tr>
		<td>8ball, achievement, beep, coinflip, color, compliment, diceroll, fact [cat | dog | general | useless], fortnite, giphy, grandarchive, hypixel, leagueoflegends, lyrics, meme, minecraft, mtg, nasa, neko, pokemon, rps, spotify, urban, word, wynncraft, youtube</td>
		<td>ban, channel [delete | lock | rename | unlock], deafen, kick, logs [add | remove | reset | view], purge, role [add | remove], setnick, slowmode, timeout, unban, undeafen, untimeout, warn</td>
		<td>autoplay, filter, loop, nowplaying, pause, play, queue, resume, seek, shuffle, skip, stop, volume</td>
		<td>afk, botpresence, botsetnick, calculator, crypto, dictionary, gemini, github, guildrename, help, info [channel | client | guild | role | user], invite, leaderboard [add | remove | reset | view], leave, message, mongodb [initialize | delete], news, npm, ping, qrcode, say, summarize, thread, weather, wikipedia</td>
	</tr>
</table>

## Dependencies
###### Node.js
Node.js version **≥22.0.0** is required

###### npm Packages
<table>
	<tr>
		<td><a href="https://www.npmjs.com/package/@dotenvx/dotenvx">@dotenvx/dotenvx@1.52.0</a></td>
		<td><a href="https://www.npmjs.com/package/@google/genai">@google/genai@1.38.0</a></td>
	</tr>
	<tr>
		<td><a href="https://www.npmjs.com/package/@huggingface/transformers">@huggingface/transformers@3.8.1</a></td>
		<td><a href="https://www.npmjs.com/package/chalk">chalk@4.1.2</a></td>
	</tr>
	<tr>
		<td><a href="https://www.npmjs.com/package/discord.js">discord.js@14.25.1</a></td>
		<td><a href="https://www.npmjs.com/package/mathjs">mathjs@15.1.0</a></td>
	</tr>
	<tr>
		<td><a href="https://www.npmjs.com/package/mongodb">mongodb@7.0.0</a></td>
		<td><a href="https://www.npmjs.com/package/mongoose">mongoose@9.1.5</a></td>
	</td>
	<tr>
		<td><a href="https://www.npmjs.com/package/moonlink.js">moonlink.js@5.0.0</a></td>
		<td><a href="https://www.npmjs.com/package/node-fetch">node-fetch@2.7.0</a></td>
	</td>
	<tr>
		<td><a href="https://www.npmjs.com/package/uuid">uuid@11.1.0</a></td>
		<td></td>
	</td>
</table>

## Guides
###### Configuration Files
1. **Clone** this repository to your local drive
```sh
git clone https://github.com/yewshanooi/sodium.git
cd sodium
```
2. Install the required **npm packages**
```
npm install
```
3. Install the **nodemon** npm package globally or skip if you already have nodemon installed
```
npm install -g nodemon
```
4. Create a new file named **config.json** and fill it with your own information 
> [!WARNING]
> The embedColor field is required
```
{
 "embedColor": ""
}
```
5. Create a new file named **.env** and fill it with your own variables 
> [!WARNING]
> The TOKEN, MONGODB_TOKEN, CLIENT_ID, and GUILD_ID fields are required, while the rest are optional. With missing fields, certain features might not work as intended
```
TOKEN=
MONGODB_TOKEN=
LAVALINK_HOST=
LAVALINK_PORT=
LAVALINK_PASSWORD=
CLIENT_ID=
GUILD_ID=
CHANNEL_ID=
FORTNITE_API_KEY=
GENIUS_API_KEY=
GIPHY_API_KEY=
GOOGLE_API_KEY=
HYPIXEL_API_KEY=
NASA_API_KEY=
NEWS_API_KEY=
OPENWEATHERMAP_API_KEY=
RIOTGAMES_API_KEY=
```
6. Run the **commands.js** file to deploy or delete application commands for a single guild by default
```
node commands.js deploy -or- node commands.js delete
```
7. Run the **index.js** file to start the bot 
> [!TIP]
> Don't forget to deploy commands before starting the bot, otherwise commands won't appear as they are not updated
```
npm start -or- npm run dev
```

###### Music Streaming
1. Visit [lavalink-devs/Lavalink](https://github.com/lavalink-devs/Lavalink/releases), download the latest **Lavalink.jar** and place it in the music folder

2. Set up the host, port, and password in the **.env** file, then run the **Lavalink.jar** file to start the music manager
```
npm run lavalink
```

###### Machine Learning
1. View this [guide](https://github.com/yewshanooi/huggingface-guide) to install the summarization model
> [!TIP]
> For best results, we suggest using the facebook/bart-large-cnn model. The model size is approximately 6.65GB in half precision (FP16) format

###### Bot & Application
1. Visit [Discord Developer Portal](https://discord.com/developers/applications) to create a new application

2. In Installation tab, enable `Guild Install` option under Authorization Methods

3. In Bot tab, enable `Presence Intent` and `Server Members Intent` options under Privileged Gateway Intents

4. Paste this OAuth2 URL template in your browser's address bar and replace `{CLIENT_ID}` with your **Client ID** to invite the bot to your guild
```url
https://discord.com/oauth2/authorize?client_id={CLIENT_ID}&permissions=1497295481975&integration_type=0&scope=bot+applications.commands
```

###### OAuth2 URL Scopes & Bot Permissions

	<img src=".github/images/oauth2.png" width="750"/>

## License
This project is licensed under the **MIT License**
```
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR 
THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

sodium

sodium Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

sodium

sodium Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README