/miters

Yet another Discord general bot. But this one is open source! Mainly maintained by a group of Malaysian programmers, that's why its name is "Miters", which stands for "Malaysian IT -ers".

Primary LanguageTypeScript

Miters Discord Bot

An open-source Discord bot for doing everything. The name "Miters" stands for "Malaysian IT-ers".

Introduction

Miters is a powerful and versatile Discord bot developed in TypeScript using the discord.js library. It is designed to enhance your Discord server management experience with a wide range of features. This repository contains the source code for the Miters Discord bot, and it can be deployed on your server for personal use or community management.

Installation

To set up the Miters Discord bot on your server, follow these steps:

  1. Clone this repository to your local machine.
git clone git@github.com:yyueniao/miters.git
cd miters
  1. Install the required dependencies using npm.
npm install
  1. Create a .env file in the root directory of the project and provide your Discord bot token. You can get your token by creating a new bot application on the Discord Developer Portal.
cp .env.example .env

Usage

To start the Miters Discord bot, you can use the following script:

npm run live
# Ready! Logged in as {YOUR_BOT_TAG_ID}

This command will compile the TypeScript code using ts-node and run the bot in your server. Make sure the bot has been invited to your server before running the command.

Contributing

We welcome contributions to the Miters Discord bot project! Whether you're an experienced developer or just starting with open-source contributions, we encourage you to get involved. Here are some ways you can contribute:

  • Bug Reports: If you come across any issues or bugs, please report them on the issue tracker.

  • Feature Requests: Have a great idea for a new feature? Share it with us on the issue tracker.

  • Code Contributions: If you're comfortable with TypeScript and Discord.js, you can help us by fixing bugs or implementing new features. Fork the repository, make your changes, and submit a pull request:

  1. Fork the repository to your GitHub account.

  2. Create a new branch from the main branch for your changes.

  3. Make your modifications and improvements.

  4. Commit your changes and push them to your forked repository.

  5. Create a pull request to merge your changes into the main repository.

  • Documentation: You can improve the project's documentation, including this README, by submitting pull requests with your updates.

We value and appreciate all contributions, big or small!