mirror of https://github.com/kirameki-cafe/Yumi.git synced 2026-09-13 18:59:19 +00:00

T

dependabot[bot]andGitHub be59ac7452 Bump ts-custom-error from 3.3.0 to 3.3.1

Bumps [ts-custom-error](https://github.com/adriengibrat/ts-custom-error) from 3.3.0 to 3.3.1.
- [Release notes](https://github.com/adriengibrat/ts-custom-error/releases)
- [Changelog](https://github.com/adriengibrat/ts-custom-error/blob/main/CHANGELOG.md)
- [Commits](https://github.com/adriengibrat/ts-custom-error/compare/v3.3.0...v3.3.1)

---
updated-dependencies:
- dependency-name: ts-custom-error
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

2022-11-08 14:36:04 +00:00

.github

Update docker-image.yml

2022-10-30 22:40:22 +07:00

configs_example

Moved config example file location

2022-03-05 19:43:24 +07:00

locales

Don't encode the prefix in the message (#16 )

2022-10-30 23:58:58 +07:00

prisma

Added localization support

2022-06-06 20:11:54 +07:00

src

Fixed wrong logging level (#18 )

2022-10-31 23:17:08 +07:00

.dockerignore

Update .dockerignore

2022-05-01 17:55:52 +07:00

.env.example

Update .env.example

2022-08-25 18:19:20 +07:00

.gitignore

Update .gitignore

2022-03-06 21:47:14 +07:00

.prettierrc

Update .prettierrc

2022-06-06 20:42:56 +07:00

Dockerfile

Reverted to NodeJS 16

2022-07-15 16:01:06 +07:00

LICENSE

Create LICENSE

2022-03-06 16:59:17 +07:00

package.json

Bump ts-custom-error from 3.3.0 to 3.3.1

2022-11-08 14:36:04 +00:00

README.md

Updated reference to repo

2022-10-30 22:22:57 +07:00

tsconfig.json

Change output dir

2022-03-06 21:48:14 +07:00

yarn.lock

Bump ts-custom-error from 3.3.0 to 3.3.1

2022-11-08 14:36:04 +00:00

README.md

🍭 Yumi

Multipurpose Discord bot in development

✨ Features

Music player (YouTube/Spotify)
Membership screening (Member approval system)
Fetching player info from games from APIs
and more in development...

👜 Prerequisites

NodeJS
FFmpeg
Python2 (For building dependencies)
C++ compiler (For building dependencies)

🔧 Building for production

Clone this repository
Install dependencies with yarn for yarn, or npm install for npm
Run the script yarn build or npm run build

The output will be at /dist, use node index.js to start

🔧 Building for production (Docker)

Clone this repository
Run yarn docker-build for yarn, or npm run docker-build for npm to build the image

Image will be tagged as ghcr.io/kirameki-cafe/yumi:latest

🔧 Debugging for development

Clone this repository
Install dependencies with yarn for yarn, or npm install for npm
Run the script yarn development or npm run development

🌳 Environment Variables

Take a look inside .env.example for example

NODE_ENV Environment type, development or production
DATABASE_URL Connection URL to your database. More info
DISCORD_TOKEN Your discord bot token
DEVELOPER_IDS List of Discord Snowflake User ID that can access developer only modules, separated by ,
PRIVATE_BOT Should the bot invite be public? true or false
SUPPORT_URL (Optional) URL to your support server (If not set, support module will show not available message)
OSU_API_KEY osu! API v1 key
YOUTUBE_COOKIE_BASE64 YouTube cookies encoded in base64 How to get cookies? *
SPOTIFY_CLIENT_ID Spotify client ID
SPOTIFY_CLIENT_SECRET Spotify client secret
SPOTIFY_REFRESH_TOKEN Spotify refresh token **
SPOTIFY_CLIENT_MARKET Spotify 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>