> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/sammwyy/mikuMikuBeam/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to Miku Miku Beam

> A Miku-themed network stress testing tool with CLI and web interfaces

<Warning>
  This project is for educational purposes only and should not be used for malicious purposes.
</Warning>

## What is Miku Miku Beam?

Miku Miku Beam is a fun and visually appealing network stress testing tool with a Miku-themed frontend. It allows you to configure and run various attack methods while enjoying a vibrant interface and background music. The tool provides both a command-line interface for quick testing and a web-based interface for visual monitoring.

<CardGroup cols={2}>
  <Card title="CLI interface" icon="terminal">
    Run attacks from the command line with colored output and real-time statistics
  </Card>

  <Card title="Web interface" icon="browser">
    Monitor attacks visually with a Miku-themed UI and live stats visualization
  </Card>

  <Card title="Multi-threaded" icon="bolt">
    Process attacks using multiple goroutines for optimal performance and scalability
  </Card>

  <Card title="Real-time stats" icon="chart-line">
    Track packets per second, total packets sent, and success/failure rates live
  </Card>
</CardGroup>

## Key features

### Attack methods

Miku Miku Beam supports multiple attack types for comprehensive stress testing:

* **HTTP Flood** - Send random HTTP GET/POST requests with configurable payloads
* **HTTP Bypass** - Send HTTP requests that mimic real browser behavior (redirects, cookies, headers, resources)
* **HTTP Slowloris** - Send slow HTTP requests and keep connections open to exhaust server resources
* **TCP Flood** - Send raw TCP packets with random data
* **Minecraft Ping** - Send Minecraft server status/MOTD requests

### Infrastructure

<CardGroup cols={2}>
  <Card title="Docker ready" icon="docker">
    Built and run in Docker containers for easy deployment
  </Card>

  <Card title="Proxy support" icon="shield">
    Load and filter proxies with authentication support
  </Card>

  <Card title="Multi-client" icon="users">
    Multiple web clients can run attacks simultaneously with isolated instances
  </Card>

  <Card title="Configurable" icon="sliders">
    Easily set attack method, packet size, duration, delay, and thread count
  </Card>
</CardGroup>

## Project architecture

The project is organized into four main components:

### CLI (`cmd/mmb-cli/`)

Command-line interface for running attacks from terminal:

* Colored output with real-time statistics
* `--verbose` flag for detailed attack logs
* `--no-proxy` flag to run without proxies
* `--threads` flag to control concurrency

### Core (`internal/`)

The engine and attack implementations:

* **`engine/`** - Attack coordination and management
* **`attacks/`** - Individual attack method implementations
  * `http/` - HTTP-based attacks (flood, bypass, slowloris)
  * `tcp/` - TCP-based attacks (flood)
  * `game/` - Game-specific attacks (minecraft ping)
* **`config/`** - Configuration management
* **`proxy/`** - Proxy loading and filtering
* **`netutil/`** - Network utilities (HTTP/TCP clients with proxy support)

### Server (`cmd/mmb-server/`)

Web server with Socket.IO support:

* REST API endpoints (`/attacks`, `/configuration`)
* Real-time communication via Socket.IO
* Static file serving for web client
* Multi-client attack management

### Web client (`web-client/`)

React-based frontend:

* Modern UI with Miku theme
* Real-time attack visualization
* Socket.IO integration for live updates
* Configuration management interface

## Next steps

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/installation">
    Install prerequisites and set up Miku Miku Beam
  </Card>

  <Card title="Quick start" icon="rocket" href="/quickstart">
    Run your first attack in minutes
  </Card>
</CardGroup>