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.
Discord: https://discord.gg/WQspAHcJHB
Subreddit: r/GimaiSeikatsu
Fandom: Gimai Seikatsu Fandom
Language: Typescript
Library: Discord.js V14
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. ✌
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/sakiThen 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:seedYou 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 deployOr set the .env files DEPLOY variable to TRUE
Now run the bot.
$ npm run startFor any queries or problems, feel free to open an issue. I'll be happy to help.
Saki © Yakiyo. Authored and maintained by Yakiyo & Look.
Released under MIT License.