Skip to content

Latest commit

 

History

History
108 lines (83 loc) · 4.72 KB

README.md

File metadata and controls

108 lines (83 loc) · 4.72 KB
Raw

Version Forks Stargazers Issues MIT License Discord Support

Muzox Project

A Discord Music bot project broughtto you by Muzox's Studios

Tech Stacks Information

Client: Discord.js as Client library , Soukaku as Player library, Lavalink as Node server as player component

Language: Typescript

Quick View Table

  Quick View table
Version implementation Description
V3 Typescript Migration This version is a major change due to integration and migration to Typescript from javascript

🔧 Requirements

Before starting , you would require some of the following stuff

📚 Steps

  1. Clone the repo
git clone <repo url>
  1. Navigate to the folder
  2. Open cmd in the following folder created & run
npm install
  1. After the complete installation open the folder containing the repo in your code editor
  2. Edit the file .env.example to .env
  3. Fill in the details required
Token="xxxxxxxxxx" # paste your Discord bot token
PostgresqlDb="" # Postgresql database url
TopGGApiKey="" # Top.gg api key
status="online" # online,dnd,idle,offline
Dprefix=" " # Prefix for your discord bot
SearchEngine="ytsearch" # soundcloud : scsearch , ytMusic : ytmsearch , yt : ytsearch
BotUsername=" " # Discord bot username
BotIcon="null" # Do not replace [future use]
BotUserId=" " # Your Discord bot user id
GuildLogs=" " # Your Discord channel id where guild Joined / Left events would trigger
ShardLogs=" " # Paste your ChannelId where to send the Shard realted events
ShardAlerts=" " # Paste your ChannelId where to send Shard alert events
ReadyLogs=" " # Paste Your ChannelId where to send Bot Ready Events
OwnerIds="943530917748691005, 1014198346656792667" # Developers Ids for dev acess commands 
MaintenanceReason="Currently the bot seems to be facing the maintenance mode" # Maintenance mode reason [to notify users when cmd is triggered & maintenace : True]
Estimation="Estimated : 12.00 am" # Maintenance mode time / string estimations

LavalinkUrl="xxx:5432" # Lavalink url format : [host:port] : [xxxx:1234]
LavalinkAuth="youshallnotpass" # Lavalink password
LavalinkName="Main" # Lavalink name [any]

you can delete the lines containing not required You can disable the logging system for channels from the file Src/config.ts [Line: 42] you can activate or deactivate maintenace from the file Src/config.ts [Line: 48]

  1. generate the prisma Client
npx prisma generate
  1. Lastly you can run the bot from the following cmd line
npm run dev

useful files

  1. you can update the txt of every message from the file Src/Display/Messages/Messages.ts

  2. you can update few embeds from the files in the folder 📂 Src/Display/GlobalEmbeds

Support

For Support or requesting new features Join the Support Server