README.md

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 and Indomitable in my bots

This supports sharding and concurrency handling to showcase 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

Make sure to read the README.md in Configuration Files

If you want to self-host this

Clone, then Download this repo to a work directory of your choice.

Fill in the Configuration Files 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