Happi (Discord Bot)

A small discord bot project, I work on my free time. It's meant to be more of a general purpose bot for moderation, voice and more. This is just a small side project, so don't expect that much from it.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

A small discord bot project, I work on my free time. It's meant to be more of a general purpose bot for moderation, voice and more. This is just a small side project, so don't expect that much from it.

Getting Started

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

Prerequisites

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

You require the following packages.

• npm

  A node.js package manager that usually comes with node itself. As long as you install node you should be able to use the command line utility.

  You can install an alternative package manager something like yarn.

Please note you also have to provide the api keys and tokens that the wrappers require.

This file needs to be located in /src/app/config/api.json

{
  "discord": "your-discord-token",
  "hypixel": "your-hypixel-token",
}

To get these tokens (API keys), you will need to do the following.

• Discord

  

  After clicking the link, log in and create a new Discord application by clicking the New Application button as seen above. You can name it anything you desire (as long as it does not go against Discord Terms of Service and their API Terms of Service)

  

  You'll need to go to the bot tab in the sidebar as seen above. This will let you create a bot as seen below.

  

  You can create a bot and then copy the bot token and save it in the JSON format located above the tutorial. Please note you should not let anyone else see your token as this can let people access your bot's account.

• Hypixel

  To create a Hypixel API key. You will need a minecraft account. If you do not have one, you can (but should not if you are not planning to play Minecraft) with the price of $24.99 (subject to change).

  If you have a minecraft account then you can log into minecraft and join the server mc.hypixel.net.

  After that you should do /api and copy your API key over to the JSON format located above.

Installation

1. Clone the repo

   git clone https://github.com/RyanGamingXbox/happi-discord-bot.git

2. Install NPM packages

• With npm

  npm ci

• With yarn

  yarn install --production=true

  Please note, if you want to contribute, you will require the developer dependencies. You should remove the production flag from the above command.

Roadmap

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

Contributing

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

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

License

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

Contact

Your Name - @Ubuntuify - [email protected]

Project Link: https://github.com/RyanGamingXbox/happi-discord-bot

Acknowledgements

• othneildrew - for the README template.
• All the fantastic creators and contributors of the node dependencies.