Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.6 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.6 KB
Raw

NekoChan

A small local Discord bot for weeb who loves anime images, purely written in TypeScript using the Eris Discord library.

  • This Discord bot is still Work In Progress.

Developing

  • Node v16+ is required to run

Clone this repository and edit the configuration file located in the config folder. Please read the README for more info.

Discord Bot

The bot folder is where the bot will run. Please read below instructions how to run the bot.

# Build the framework
npm run ci:framework
npm run build:framework

# Run the bot
npm run ci:bot
npm run start:bot

# Run the bot (Hot Reload)
npm dev:bot

Once you run these commands in order and successfully, a log should appears indicating that the bot has connected to Discord.

Framework

NekoChan is powered entirely by its custom built-in NekoChan-Framework. Please be careful when editing its source code as you might accidentally overwrite something.

# ESLint
npm run lint:framework
npm run lint:framework:fix # Automatically fix ESLint problems

# Build the framework
npm run build:framework

Third-Party Resources

These are the resources used in NekoChan.