Skip to content
TypicalBot is a multi-threaded and high-performance Discord bot.
Branch: master
Clone or download

README.md

TypicalBot

Discord Travis Codecov Codacy Apache 2.0 License CLA Crowdin

TypicalBot is open-source discord bot written in Java, using the JDA library.

Join TypicalBot Lounge

Table of Contents

Getting Started

This section provides a quick-start guide.

Prerequisites

  • Java: Java 8 is required.
  • MongoDB: MongoDB is required to store Guild settings.
  • Lavalink Server: Lavalink is required to stream videos.

Installation

  1. Make sure all prerequisites are installed.
  2. Fork the TypicalBot repository: https://github.com/typicalbot/typicalbot/fork
  3. Clone your forked repository, ie. git clone http://github.com/<YOUR-USERNAME>/typicalbot.git
  4. Run gradlew clean build.
  5. Locate the typicalbot-<VERSION>.jar in the /build/libs directory and move it. Do not use the one with nodeps.
  6. Open command prompt and run java -jar Lavalink.jar.
  7. Open a second command prompt and run java -jar typicalbot.jar and proceed through the setup.
  8. You're done!

Project Roadmap

Our project roadmap can be found here.

Maintainers

License

TypicalBot is an open-sourced software licensed under the Apache 2.0 license.

Like many other open source projects, we require that contributors provide us with a Contributor License Agreement (CLA). By submitting code to the TypicalBot project, you are granting us the right to use your code under the terms of the CLA.

Our version of the CLA was adapted from the Microsoft Contributor License Agreement, which they generously made available to the public domain under Creative Commons CC0 1.0 Universal.

For any inquiries, please email support@typicalbot.com


Thanks to Crowdin, JetBrains and YourKit for sponsoring our project with Open Source licenses.

  • Crowdin is a localization management platform that helps companies to translate their software.
  • JetBrains is a cutting-edge software vendor specializing in the creation of intelligent development tools, including IntelliJ IDEA – the leading Java IDE, and the Kotlin programming language.
  • YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

Crowdin JetBrains YourKit

You can’t perform that action at this time.