Skip to content

Latest commit

 

History

History
113 lines (86 loc) · 4.97 KB

README.md

File metadata and controls

113 lines (86 loc) · 4.97 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Discord Racing Bot: Earn, Race, Win...
Join the Demo Discord Channel · Report Bug · Request Feature

About The Project

A Racing themed Discord Bot written in Java using MongoDB and JDA wrapper. Earn Credits, buy car components, build your custom race car and race against other members! Challenge other members for an impromtu drag race, register for the hourly tournaments with randomly generated racetracks, or test your car against the best of the best with adaily Grand Prix tournament with premium prizes.

(back to top)

Built With

(back to top)

Getting Started

Follow these directions to import the project into Eclipse so that it can be edited and built.

Prerequisites

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

  • Eclipse
  • JDK 13
  • MongoDB, Self-hosted or Atlas connection string
  • Discord Bot registered with proper permissions and it's associated bot token.

Installation

  1. Install Open JDK 13, MongoDB (if self-hosted), Eclipse
  2. Make sure that Eclipse is assigned the correct Java version in it's .ini file located within Eclipse installation directory.
  3. Clone the repo 
    git clone https://github.com/CCSU-DesignPatterns-F21/final-project-f21-group3.git
  4. Open Eclipse, Import Existing Gradle project, browse and navigate to the directory with cloned repo, hit Next.
  5. Select Override workspace settings and add new JVM Arguments with the value: 
    -Djdk.tls.client.protocols=TLSv1.2
  6. Project should now be imported properly.
  7. In project explorer navigate to src/main/resouces (or create it) and create a file config.properties.
  8. Within config.properties add the following lines (these contain important credentials, make sure you don't share them with anyone) 
    discordChannelToken=<Your Discord Bot token>
mongoDBUsername=<Your MongoDB Connection Password>
mongoDBPass=<Your MongoDB connection username>
mongoDBDatabase=RacingBot
  9. Adjust the connection string in DBHandler.java to match your connection string.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)