mirror of
https://github.com/kirameki-cafe/Yumi.git
synced 2026-09-13 10:49:20 +00:00
7f7f877930bac2955fee0647e7676bf911f54d68
🍭 Yumi
Multipurpose Discord Bot
👜 Prerequisites
🔧 Building for production
- Clone this repository
- Install dependencies with
yarnfor yarn, ornpm installfor npm - Run the script
yarn buildornpm run build
The output will be at /dist, use node index.js to start
🔧 Building for production (Docker)
- Clone this repository
- Run
yarn docker-buildfor yarn, ornpm run docker-buildfor npm to build the image
Image will be tagged as ghcr.io/yuzuzensai/yumi:latest
🔧 Debugging for development
- Clone this repository
- Install dependencies with
yarnfor yarn, ornpm installfor npm - Run the script
yarn developmentornpm run development
🌳 Environment Variables
Take a look inside .env.example for example
NODE_ENVEnvironment type,developmentorproductionDATABASE_URLConnection URL to your database. More infoDISCORD_TOKENYour discord bot tokenDEVELOPER_IDSList of Discord Snowflake User ID that can access developer only modules, separated by,PRIVATE_BOTShould the bot invite be public?trueorfalseSUPPORT_URL(Optional) URL to your support server (If not set, support module will show not available message)OSU_API_KEYosu! API v1 keyYOUTUBE_COOKIE_BASE64YouTube cookies encoded in base64 How to get cookies? *SPOTIFY_CLIENT_IDSpotify client IDSPOTIFY_CLIENT_SECRETSpotify client secretSPOTIFY_REFRESH_TOKENSpotify refresh token **SPOTIFY_CLIENT_MARKETSpotify market country code
* Encode the cookies from the request headers base64 and put it in here instead of creating new file with play.authorization(); code
** Get refresh token from https://accounts.spotify.com/en/authorize?client_id=<client id>&response_type=code&redirect_uri=<redirect uri>
Languages
TypeScript
99.5%
Dockerfile
0.5%