Hue v4.0

Warning This project is still in development so not everything may be working currently or just doesn't exist yet. (and also is gonna be remade later on into typescript lol)

Hue v4 is a continuation of my Hue Project, expanding it to more services such as Minecraft, Steam, And Roblox.
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
3. Contributing
4. License
5. Contact

About The Project

Hue v4.0 is a discord bot which allows servers which need to verify the users who are joining their servers with their relevant account.

Currently the bot is planned to support Minecraft, Roblox, and Steam on release with some additional verification methods planned in the future.

How does it work? For the Discord bot side we're using the Discord.js v13 library. I am not planning to upgrade to v14 as its really bad. For the Minecraft verification I will be using a custom made plugin and minecraft server which have not been finished yet. For Steam I will probably use the Login With Steam API thingy. And lastely for roblox I will be doing description verification.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/ItzRock/Hue-v4.0.git

2. Install NPM packages

   npm install

3. Clone and fill out the configuration.toml file. (refer to the configuration template.toml for the most up to date template)

   [Client]
   TOKEN = "SuperSecretToken"
   BOT_ADMINISTRATION = [ 
   "@[USER_ID]",
   ]
   
   [Channels]
   LOGS = "Channel ID"
   
   [Database]
   URL = "DatabaseURL"
   USERNAME = "DatabaseUsername"
   PASSWORD = "DatabasePassword"
   

(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 Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

If you have found a bug or would like a feature the best way to get in contact is using the Issues or Pull requests tabs on the repo.
For any other questions or concerns unrealated to Hue, via one of the following methods

1. Twitter: @ItzRock_
2. Email: anthonystainton+contact@gmail.com
3. Discord: Anthоny#0001

(back to top)