UTSUKUSHI BOT (Discord-Bot)

Discord Bot for my private Discord Server & friends server.

Dependency

• @Discordjs/voice : 0.16.0 # Manage Voice Channel Connection and Audio Player
• @distube/ytdl-core : 4.11.8 # Youtube Downloader
• Axios : 0.27.2 # Http Requests
• Discord.js : 14.9.0 # Discord API
• Dotenv : 16.0.1 # Manage Environments Variables
• Staticmaps : 1.10.0 # Get Static Map Images
• Ytsr : 3.8.0 # Youtube Search Service

Installation

1. Clone projet : git clone https://github.com/DRACOX2500/Discord-Bot.git

2. Install / Update packages manager

   • Install NodeJS latest LTS version (current : 18.15.0)
   • Install / Update NPM : npm i -g npm@<latest-version> (current 9.6.4)
   • Only Linux : apt install libtool

3. Install dependencies

   • Execute following command : npm i
   • Install TypeScript & TypeScriptPath (Global) : npm i -g typescript tspath
   • If an Opus error is returned, try to remone project directory and reclone project

4. Environment Variables

   • Copy or Rename .env.example into .env
   • Complete the .env file with your values

5. Start Utsukushi Project

   • Build : npm run build
   • Start : npm start
   • Build + Start : npm restart

Interaction

Slash Commands

Status :

• ✅ stable
• 🧪 experimental
• ❌ deprecated
• 💀 deleted

Name	Description	Permission	DM	status
/big-burger	Return a random burger picture	No	✅	💀
/bot activity	Set Utsukushi activity, Select activity type : Play, Listen, Stream, Competing, Watch And Enter an activity message	No	✅	✅
/bot status	Set Utsukushi status : Online, Idle, Do not Disturb, Invisible	No	✅	✅
/cache	Manage your cache in Utsukushi Database : - Delete: delete all your data in Utsukushi database - Show: Utsukushi sends you your data in DM	No	✅	✅
/fuel	(Only for france - Governmental API) Search fuel data (Address, Services, Updated Date, Fuel Cost, City, Department, Region) map include !	No	✅	✅
/git	Return Utsukushi Bot Github Repo	No	✅	✅
/guild	Return Guild information (Created At, Joined At, Member Count, Booster Count, Locale, Emojis, Stickers, Roles, Banned Users)	No	❌	✅
/guild-share-emoji	Authorize the guild to share emojis with Utsukushi and other guild	ManageGuild	❌	✅
/locale	Change the local language of your guild	ManageGuild	❌	✅
/notify on	Choose a channel to notify when someone connects to a voice channel	ManageGuild	❌	✅
/notify off	Disable notify system	ManageGuild	❌	✅
/ping	🤖 All bots started like this (Historic Command)	No	✅	✅
/play	Play a music in voice channel, By default, plays the last music played (You can manage music with embed & buttons). Search the music by keywords or YouTube URL, The keywords will be saved in the database and can be used later. WARNING : UNSTABLE VERSION	No	❌	🧪
/play-together	Start a Discord Activity in voice Channel	No	❌	💀
/soundeffect play	Play sound effect in voice channel	No	❌	✅
/soundeffect add	Add sound effect in Utsukushi Database (30sec max only)	No	❌	✅
/speak-as-bot	Send a message as bot (attachment available)	No	✅	✅

More slash command details available in Commands.md

Context Menus

What is a context menu ?

"Context Menus are application commands which appear when right-clicking or tapping a user or a message, in the Apps submenu."

source: discordjs.guide

Status :

• ✅ stable
• 🧪 experimental
• ❌ deprecated
• 💀 deleted

Name	Description	Permission	DM	status
Delete Up To This	Select a message, right click and select this options to delete all messages until selected message (selected message include)	ManageMessages	✅	✅
React As Bot	Use the Utsukushi Emoji database to react to a message.	No	✅	✅
Reply As Bot	Reply to a message as Utsukushi Bot	No	✅	🧪

CI

Continious Integration with SonarCloud !