Skip to content

Trucky/trucky-announcer-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Trucky Announcer Bot

A simple bot that automatically announces messages in an announcement channel and maintains a queue if rate limited after 10 messages in an hour.

Features

  • Automatic message announcements
  • Rate limiting with queue management
  • Easy configuration

Installation

  1. Clone the repository:
    git clone https://github.com/trucky/trucky-announcer-bot.git
  2. Navigate to the project directory:
    cd trucky-announcer-bot
  3. Install dependencies:
    npm install

Usage

  1. Start the bot:
    npm start
  2. The bot will automatically announce messages in the configured announcement channel.

Configuration

  • Create an .env file to set up your bot token and announcement channel ID.
  • Example .env:
    DISCORD_TOKEN=<your token>
    CHANNEL_ID=<announcement channel id>  
    

Docker

  1. Build and run the Docker Compose services:
    docker-compose up --build
  2. Build the Docker image:
    docker build -t trucky-announcer-bot .
  3. Run the Docker container:
    docker run --env-file .env trucky-announcer-bot

Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published