Dynamica

An easy-to-use dynamic voice channel bot

Explore the docs »

Report Bug . Request Feature

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors

About The Project

A few years ago a discord bot that I was using was going to shut down as a result of some major changes to discord.py. As a result, I decided to create my own bot that closely mimicked the behavior for people who wanted to keep using it.

In order to make it easier to add new features the source for the bot remains open source and open to contributions.

Built With

This project was built with the help of several open source projects:

• Necord
• NestJS
• DiscordJS

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• NodeJS
• PNPM

Installation

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Install the dependancies:

   yarn install

3. Create a .env file

   DATABASE_URL="file:../config/db.sqlite"
   TOKEN="<DISCORD_BOT_TOKEN>"
   

Usage

In order to develop with the bot run:

pnpm dev

This will start the bot and reload it when you make any changes.

For command usage see the website linked above.

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.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

License

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

Authors

• Sebastian Pietschner - Software Engineering Student - Sebastian Pietschner - Primary Contributor