/Kuwu

A discord bot for csictf 2020!

Primary LanguagePythonMIT LicenseMIT

csivit Issues


Logo

Kuwu

A friendly dicord bot used as a utility tool for CTFs

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Logo

Kuwu is a discord utility bot implemented to be used specifically with CTF(s). It can help you organize and manage the CTF with it's varied features such as monitoring the challenges as well as first blood updates. The bot also filters out flags from the csictf discord server. It was also used in one of the challenges where teams had to DM the bot for the flag.

Built With

Getting Started

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

Prerequisites

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

  • python

Installation

  1. Clone the repo
git clone https://github.com/csivitu/Kuwu.git
  1. Install python packages
pip install -r requirements.txt

Usage

The bot is made with the help of discord.py library which is a modern, easy to use, feature-rich, and async ready API wrapper for Discord. The bot uses web sockets to connect to the challenges to perform regular health checks. The health checks were conducted every 120 seconds. Here is an example:

Logo

The bot also gave first blood updates and for that, selenium python library was used as ctfd requires login to access the first blood data. Here is an example of first blood updates:

Logo

The bot checked all messages sent to the server for filtering flags.

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 'feat: Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

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