discord-event-bot

Setup your own event planner.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

I alway wondered if there is an open source alternative to various event planning bots for discord. I couldn't find anything so I went on and created my own.

Built With

• Discord.NET
• Humanizer
• ICal.NET
• Quartz.NET
• .NET
• EF Core

Getting Started

You need to create a new discord application an get a bot Token. Follow this tutorial to get a bot token. https://docs.stillu.cc/guides/getting_started/first-bot.html

Installation

Option 1: Use docker-compose

The bot comes as a docker image. You can use the following samples to get it up and running in a matter of minutes. You can find sample docker-compose configurations below. Please note that you can either replace ${DiscordEventBotToken} with your actual token or create an environment variable called DiscordEventBotToken.

docker-compose.yml (Linux containers)

version: '3.4'

services:
  discordeventbot.service:
    image: kreisverkehr/discord-event-bot:latest
    environment:
        - DiscordEventBotToken=${DiscordEventBotToken}
        - DiscordEventBotDataStore=/mnt/datastore
    restart: always
    volumes:
        - datastore:/mnt/datastore
volumes:
  datastore:

docker-compose.yml (Windows containers)

version: '3.4'

services:
  discordeventbot.service:
    image: kreisverkehr/discord-event-bot:latest
    environment:
        - DiscordEventBotToken=${DiscordEventBotToken}
        - DiscordEventBotDataStore=C:\volume
    restart: always
    volumes:
        - datastore:C:/volume
volumes:
  datastore:

Option 2: Manual install

Download and extract the appropriate zip folder for your environment and extract it. Run the excecutable. You will be asked a few questions and your bot is running.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Head over to Github and follow the steps. (https://github.com/Kreisverkehr/discord-event-bot)

1. Create an issue which describes the feature you are planning to implement
2. Fork the Project
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/Kreisverkehr/discord-event-bot Author: Kreisverkehr#5046