/ruger-bot

Discord bot for my server

Primary LanguagePythonMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Ruger Bot

A Discord bot for use in my personal server.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Built With

(back to top)

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 project has a few pre-requisites before you can get up and running. They are as follows:

  1. Docker
  2. Python 3.6+
  3. Make
  4. Discord API Token
  5. Spotify API Key

Installation

  1. Clone the repo
git clone https://github.com/ChrisKalahiki/ruger-bot.git
  1. Enter the cloned directory
cd ruger-bot
  1. Create a JSON file called config.json with the following contents:
{
    "spotify":{
        "clientID":"yourClientID",
        "clientSecret":"yourClientSecret",
        "redirectURI":"yourRedirectURI"
    },
    "discord":"yourDiscordToken",
    "guildID":"yourGuildID",
    "prefix":".",
    "owners": [
      "yourOwnerID"
    ]
}
  1. Create a new directory called logs and add a log file called discord.log inside of it.
  2. Build and run the Docker image.
make all

(back to top)

Usage

COMING SOON!!!

(back to top)

Roadmap

  • Role Management
  • Revamped Logging
  • Stardew Valley Integration
  • API Searching
    • MTG Card Searching (via Scryfall)
    • Pokemon Searching (via PokeAPI)
    • Anime Searching (via Jikan)
    • Manga Searching (via Jikan)
    • Yugioh Card Searching (via YugiohDB)

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

(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)

License

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

(back to top)

Contact

Chris Kalahiki - @ChrisKalahiki - chris.kalahiki@gmail.com

Project Link: https://github.com/ChrisKalahiki/ruger-bot

(back to top)

Acknowledgments

(back to top)