yakiyo / saki Goto Github PK

View Code? Open in Web Editor NEW

5.0 3.0 2.0 10.5 MB

Saki bot for Gimai Seikatsu discord server

Home Page: https://discord.gg/WQspAHcJHB

License: MIT License

TypeScript 99.79% Shell 0.21%

anime discord discord-bot discord-js

saki's Introduction

Saki

Open on gitpod https://gitpod.io/from-referrer/

This repository contains the source code for the custom bot for the Gimai Seikatsu Discord Server. This is a Typescript port of the original bots written in Java by Look.

The bot is fully based on slash commands. For a complete list of commands, use /help command.

The bot isn't available publicly to other servers. You can see the hosted one in the Gimai Seikatsu Discord server or self host it.

Links

Discord: https://discord.gg/WQspAHcJHB
Subreddit: r/GimaiSeikatsu
Fandom: Gimai Seikatsu Fandom

Bot Information

Language: Typescript
Library: Discord.js V14

Contribution

For new feature requests, you can make an issue and i'll see what can be done.

Fork it
Create new branch git checkout -b my-new-feature
Commit changes git commit -m "Add cool feature"
Push changes to it git push <remote> <branch>
Create a pull request

Any and all contributions are welcome. Please make sure you're code passes the CI. ✌

Self-Hosting

It is pretty easy to self host the bot. It should take around 5-10 minutes to do it if you know what you're doing.

Requirements:

Nodejs version 16.9.0 or higher
A Discord Bot application
A mongodb instance with replica set. The free tier on Mongodb Atlas will work fine.
A Twitter bearer token
A Youtube api-key

First clone the repostiory with git.

$ git clone https://github.com/Yakiyo/saki

Then create a file named .env and populate it like the following

DISCORD_TOKEN=<Bot token goes here>
DATABASE_URL=<Mongodb URI>
DEPLOY=<Set this to TRUE for registering slash commands on startup>
NODE_ENV=<production|dev>
YOUTUBE_API_KEY=<Youtube api key>
YOUTUBE_COOKIE=<Youtube cookie keys>

If you are deploying in production, do set the NODE_ENV to production. On dev it logs errors to console and other helpful stuff which are usually not needed in production. Once you are done with the env file, install packages and seed the database. Seeding is required as some of the code expect the bare minimum data to be there in the database.

$ npm install
# then seed it
$ npm run prs:seed

You can modify the basic data to be seeded by editing the seed script. Finally edit the config file with your configuration. If you havent already, deploy the bot's slash commands for them to show up in your server.

$ npm run deploy

Or set the .env files DEPLOY variable to TRUE

Now run the bot.

$ npm run start

For any queries or problems, feel free to open an issue. I'll be happy to help.

Author

Saki © Yakiyo. Authored and maintained by Yakiyo & Look.

Released under MIT License.

saki's People

Contributors

Stargazers

Watchers

Forkers

muril-o

saki's Issues

Better logging

Better error handling, log errors to a error.log file so they remain saved and can be viewed later on.
Replace error logging accross code to use the log function

say new line

Replace \n in input of slash command 'say' with new line character

Music

Create music related commands

center av & close modmail threads properly

Minor fixes

Handle music stop command when there is no current queue
music isn't playing when its running in the vps
message update should only run when diff in content, nothing else
avatar update not showing in prod

twitter system not working

SyntaxError: Unexpected token < in JSON at position 0
    at JSON.parse (<anonymous>)
    at parseJSONFromBytes (C:\Users\dell\desktop\\node_modules\undici\lib\fe
tch\body.js:582:15)
    at successSteps (C:\Users\dell\desktop\\node_modules\undici\lib\fetch\bo
dy.js:522:23)
    at fullyReadBody (C:\Users\dell\desktop\\node_modules\undici\lib\fetch\u
til.js:863:5)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async specConsumeBody (C:\Users\dell\desktop\\node_modules\undici\lib
\fetch\body.js:537:3)
    at async Timeout.run [as _onTimeout] (C:\Users\dell\desktop\\dist\jobs\t
witter.js:12:

always gives me this error.. a little help?

spankies

Allow all mods to spank each other regardless of wether it works or not.

command perms

Disabled dms for commands, and maybe more robust command permissions

Modmail

Bi-directional modmail maybe?

welcome embed error

Raw query failed. Code: unknown. Message: Command failed (AtlasError): empty database name not allowed at c011d66f42ef93c352bdc551ec4a2f33/atlasproxy/session_proxy.go:704 at c011d66f42ef93c352bdc551ec4a2f33/atlasproxy/session_proxy.go:1763 at c011d66f42ef93c352bdc551ec4a2f33/atlasproxy/session_proxy.go:1181 at mongodb/[email protected]/proxy_session.go:371 at mongodb/[email protected]/proxy_session.go:131 at mongodb/[email protected]/session.go:177 at mongodb/[email protected]/server.go:280 at src/runtime/asm_arm64.s:1172)
at Pn.handleRequestError (C:\Users\dell\Desktop\saki\node_modules@prisma\client\runtime\library.js:171:6929)
at Pn.handleAndLogRequestError (C:\Users\dell\Desktop\saki\node_modules@prisma\client\runtime\library.js:171:6358)
at Pn.request (C:\Users\dell\Desktop\saki\node_modules@prisma\client\runtime\library.js:171:6237) {
code: 'P2010',
clientVersion: '4.14.0',
meta: {
code: 'unknown',
message: 'Command failed (AtlasError): empty database name not allowed\n' +
'\tat c011d66f42ef93c352bdc551ec4a2f33/atlasproxy/session_proxy.go:704\n' +
'\tat c011d66f42ef93c352bdc551ec4a2f33/atlasproxy/session_proxy.go:1763\n' +
'\tat c011d66f42ef93c352bdc551ec4a2f33/atlasproxy/session_proxy.go:1181\n' +
'\tat mongodb/[email protected]/proxy_session.go:371\n' +
'\tat mongodb/[email protected]/proxy_session.go:131\n' +
'\tat mongodb/[email protected]/session.go:177\n' +
'\tat mongodb/[email protected]/server.go:280\n' +
'\tat src/runtime/asm_arm64.s:1172)'
}
}

reaction role

Group of commands for adding, removing, editing reaction roles

use client emojis instead of guild emojis

reaction role add should be usable even with emojis from other guilds where the bot is present.
Possible solution:
Using <Client>.emojis.cache but it seems to return undefined when using with id.
Might need to cache all emojis or something.