https://github.com/oery/kyoko

A Minecraft network debugger built on top of Kagami
https://github.com/oery/kyoko

debugger rust tauri

Last synced: 3 months ago
JSON representation

A Minecraft network debugger built on top of Kagami

• Host: GitHub
• URL: https://github.com/oery/kyoko
• Owner: Oery
• Created: 2024-10-05T20:21:23.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-11-25T11:16:44.000Z (6 months ago)
• Last Synced: 2025-03-19T06:04:08.578Z (3 months ago)
• Topics: debugger, rust, tauri
• Language: TypeScript
• Homepage:
• Size: 445 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kyoko

> [!CAUTION]

> Kyoko is currently in development and is not yet ready for use. I still need to implement JSON serializing to Kagami for Kyoko to be able to read packets.

**Kyoko** is a powerful GUI-based application designed to debug Minecraft packets. Built with modern tools and efficiency in mind, Kyoko offers a seamless experience for inspecting, filtering, and visualizing Minecraft network packets. Whether you're a Minecraft mod developer, a network engineer, or just a curious enthusiast, Kyoko simplifies the complex task of analyzing Minecraft's network traffic.

> [!WARNING]

> Kyoko was made for the 1.8.9 version of Minecraft because its primary use is to debug plugins made with [Kagami](https://github.com/Oery/Kagami) which itself is made for 1.8.9 as most closed source clients are made for that version.

---

## Features

- **Proxy-Based Debugging**  

  Launch a lightweight proxy that Minecraft can connect to, enabling you to capture and analyze network traffic in real-time.

- **Packet Inspection**  

  View a detailed list of incoming and outgoing packets, complete with content visualization.

- **Filtering**  

  Apply filters to narrow down the packets of interest, making it easier to focus on specific traffic.

- **Rust-Powered Performance**  

  Built entirely in Rust, leveraging the safety, speed, and concurrency features of the language:

  - The GUI is powered by [Tauri](https://tauri.app/), ensuring a lightweight, cross-platform desktop experience.

  - The packet proxy is built using [Kagami](https://github.com/Oery/Kagami), a Rust crate specifically designed for Minecraft packet handling.

- **Cross-Platform Compatibility**  

  Works on Windows, macOS, and Linux.

---

## Usage

1. **Start the Proxy**  

   Launch Kyoko and start the proxy server from the application interface. You’ll see the connection details (IP and port) to use.

2. **Connect Minecraft**  

   Open Minecraft and connect to the proxy using the provided IP and port.

3. **Inspect Packets**  

   Once connected, Kyoko will display a real-time list of incoming and outgoing packets. Use the filtering options to refine the displayed packets.

4. **Visualize Packet Content**  

   Click on a packet to view its detailed content and structure.