Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/usbokirishima/ctfbot

Capture The Flag (CTF) assistant that can interact automatically with CTFd would be very helpful for automating tasks such as flag collection, challenge analysis, and score management.
https://github.com/usbokirishima/ctfbot

bot ctf discord discord-js hacking

Last synced: about 14 hours ago
JSON representation

Capture The Flag (CTF) assistant that can interact automatically with CTFd would be very helpful for automating tasks such as flag collection, challenge analysis, and score management.

Host: GitHub
URL: https://github.com/usbokirishima/ctfbot
Owner: UsboKirishima
License: apache-2.0
Created: 2025-01-01T14:40:37.000Z (19 days ago)
Default Branch: main
Last Pushed: 2025-01-03T21:37:07.000Z (17 days ago)
Last Synced: 2025-01-03T22:27:22.392Z (17 days ago)
Topics: bot, ctf, discord, discord-js, hacking
Language: TypeScript
Homepage:
Size: 27.3 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# CTFBot

**CTFBot** is a Capture The Flag (CTF) assistant designed to automate common CTF tasks such as flag collection, challenge analysis, and score management. It integrates seamlessly with CTFd and is easy to customize for your needs.

## 🚀 Features

- **CTF Event Management**: Create and manage CTF events.
- **Customizable Commands**: Add or modify commands easily.
- **Database Integration**: Quick and efficient data storage using SQLite.

## 📂 Project Structure

```python
├── commands # Command definitions
│ ├── ctf # Commands for CTF operations
│ │ └── NewCommand.ts
│ ├── general # General utility commands
│ │ └── PingCommand.ts
│ └── test # Test and debugging commands
│ └── EraseCommand.ts
├── config # Configuration files
│ └── index.ts
├── database # Database interactions
│ └── CTFDatabase.ts
├── handlers # Handlers for commands and events
├── listeners # Event listeners for bot interactions
├── structures # Core bot structures
├── typings # TypeScript type declarations
├── utils # Utility functions for the bot
└── index.ts # Bot entry point
```
## ⚙️ Configuration

1. Update the configuration in config/index.ts to match your setup.
2. Create an .env file based on the .env.example template:

```env
TOKEN=your_discord_bot_token
...
```

## 🛠️ Installation & Setup

1. Clone the repository

```bash
git clone https://github.com/UsboKirishima/CTFbot.git
```

2. Install dependencies

```bash
pnpm install
```

3. Run the bot

```bash
pnpm start
```

## 📄 License

#### This project is licensed under the [Apache License 2.0](/LICENSE).