Hackster ·

Welcome to the Hackster project! Its goal is to enhance the user experience for HTB's community members, and therefore it is always going to be a work in progress. We've been inspired by the fantastic work of other projects, particularly Noahbot, and we're excited to contribute our own ideas and features to the broader community.

Features
Getting Started
Contributing
License
Code of Conduct & Security
Special Thanks
Questions & Support
Contributors

Features

Message moderation: filter, delete, or flag inappropriate content.
User management: warn, mute, kick, or ban users based on customizable rules.
CTF Events management: create and manage channels, roles, and permissions for CTF Events.
And much more!

Getting Started

To set up and deploy the Discord bot, follow these steps:

The first step will be to clone the repo
```
git clone https://github.com/hackthebox/hackster.git
```
The requirements are:
- Python
- Poetry
Install the dependencies
```
poetry install
```
add the following environment variables.

| Variable | Description | Default | |----------------|----------------------------|------------| | BOT_NAME | The name of the bot | "Hackster" | | BOT_TOKEN | The token of the bot | *Required | | CHANNEL_DEVLOG | The devlog channel id | 0 | | DEBUG | Toggles debug mode | False | | DEV_GUILD_IDS | The dev servers of the bot | [] | | GUILD_IDS | The servers of the bot | *Required |
Now you are done! You can run the project using
```
poetry run task start
```
or test the project using
```
poetry run task test
```

Contributing

We invite and encourage everyone to contribute to this open-source project! To ensure a smooth and efficient collaboration process, please review our CONTRIBUTING guidelines before submitting any issues or pull requests. This will help maintain a high-quality codebase and a welcoming environment for all contributors.

License

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

Code of Conduct & Security

Please familiarize yourself with our Code of Conduct to ensure a welcoming and respectful environment for all project participants. Additionally, review our Security Policy to understand how to responsibly disclose security vulnerabilities in the project.

Special Thanks

In developing our Discord bot, we have drawn inspiration from Noahbot, an outstanding open-source project that has already demonstrated great success and versatility. We would like to extend our gratitude and acknowledgement to the creators and contributors of Noahbot, whose hard work and dedication have laid the groundwork for our project.

Questions & Support

If you have any questions or need support, feel free to open an issue on the GitHub repository, and we'll be happy to help you out.

Contributors

Check CONTRIBUTORS to see all project contributors.

Hackster

Install / Use

README