https://github.com/deivu/kongou
A bot that showcases how I implement Shoukaku and Indomitable in my bots
https://github.com/deivu/kongou
bot discord-bot discord-js discord-music-bot music-bot sharded
Last synced: about 1 month ago
JSON representation
A bot that showcases how I implement Shoukaku and Indomitable in my bots
- Host: GitHub
- URL: https://github.com/deivu/kongou
- Owner: Deivu
- License: mit
- Created: 2018-08-30T08:19:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T08:22:19.000Z (over 1 year ago)
- Last Synced: 2025-03-18T02:21:21.984Z (about 1 month ago)
- Topics: bot, discord-bot, discord-js, discord-music-bot, music-bot, sharded
- Language: TypeScript
- Homepage:
- Size: 262 KB
- Stars: 55
- Watchers: 2
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kongou
A Typescript Discord.JS bot template, using 2 of my public packages
> The ShipGirl Project. Kongou. `(c) Azur Lane for Kongou`
> A bot that showcases how I implement [Shoukaku](https://github.com/Deivu/Shoukaku) and [Indomitable](https://github.com/Deivu/Indomitable) in my bots
> This supports sharding and concurrency handling to showcase [Indomitable](https://github.com/Deivu/Indomitable)
### Before you start
> Kongou v4 is a rewritten project in TS
> Make sure you have Node >=18.0.0 installed on your system
> Your own instance of [Lavalink](https://github.com/lavalink-devs/Lavalink)
> Make sure to read the README.md in [Configuration Files](https://github.com/Deivu/Kongou/tree/master/ConfigurationTemplates)
### If you want to self-host this
> Clone, then Download this repo to a work directory of your choice.
> Fill in the [Configuration Files](https://github.com/Deivu/Kongou/tree/master/ConfigurationTemplates) then drag them beside the index.js in your working directory
> Do `npm i` in your working directory
> Do `npm run build` in your working directory
> Then do `npm start` (no log formatting) or `npm run dev` (with log formatting) to start the bot
### If you want to contribute
> Ensure you have knowledge on developing in Typescript
> Test your changes to ensure it adheres to the repository's coding standards by doing `npm run lint`
> Test the code locally by doing `npm run dev` before submitting a pull request
### Made with ❤️ by `@ichimakase`