Giter VIP home page Giter VIP logo

gf-music's Introduction

Contributors Forks Stargazers Issues MIT License Node Version


Logo

GF Music [Discord Bot]

A bot made with perfection in mind, with a unique dashboard and slashCommands
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project









(back to top)

Built With

(back to top)

Getting Started

All you need to do is fill in the required params in the config.js file.

everything you need to change is in the config.js file.

Just make sure you have node version higher than 16.9.0

Prerequisites

  • npm
    npm install

Installation

  1. Clone the repo

    git clone https://github.com/CASPERg267/GF-Music.git
  2. Get your bot ( token - client ID - client Secret ) from Discord developer portal Remember to not share your token or client secret with anyone

  1. for logging feature to your server, create text channel with the name logs go channel settings then integrations to create a new webhook you get a link with last 2 part (/webhookId/WebhookToken)

  2. provide a clientId and client Secret for spotify songs from here, its optional, if you don't provide it, bot will scrape songs from spotify but it will be slower and won't fetch all spotify playlist songs (plays first 100 song)

  3. in order to use bot's dashboard you should get a licence through Assistants Center

Remix on Glitch       Deploy       Run on Repl.it

Note: If you are hosting your bot in heroku, Please consider upgrading your dyno for running dashboard & bot simultaneously because in free dyno it'll run out of memory(as there are two workers). If you want to run only the bot, turn off the web dyno.

(back to top)

Roadmap

  • Adding emojis file to add it in bot responses
  • Most played songs stats
  • Translating the bot to mulitple languages
  • Adding a saved playlists feature

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.txt for more information.

(back to top)

Contact

@CasperAg267

Support Server

(back to top)

Acknowledgments

(back to top)

gf-music's People

Contributors

casperg267 avatar

Stargazers

81CuongVn avatar

Watchers

81CuongVn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.