Skip to content

Commit 16f1fd8

Browse files
committed
docs: update README with features, game platform support, and overview
1 parent e1cda37 commit 16f1fd8

1 file changed

Lines changed: 34 additions & 3 deletions

File tree

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,37 @@
11
# Tanji
2+
<p align="center">
3+
<img src="https://user-images.githubusercontent.com/24996684/35466253-f228fa38-02b6-11e8-8ec6-7d3f57caf2e2.png" alt="Tanji Logo" width="128"/>
4+
</p>
5+
26
[![Build](https://github.com/ArachisH/Tanji/actions/workflows/build.yaml/badge.svg?branch=develop)](https://github.com/ArachisH/Tanji/actions/workflows/build.yaml)
3-
![Downloads](https://img.shields.io/github/downloads/ArachisH/Tanji/total?label=Total%20Downloads)
4-
[![License](https://img.shields.io/github/license/ArachisH/Eavesdrop?label=License)](https://github.com/ArachisH/Tanji/blob/develop/LICENSE)
7+
![GitHub Tag](https://img.shields.io/github/v/tag/ArachisH/Tanji?label=Latest%20Version)
8+
![GitHub Total Downloads](https://img.shields.io/github/downloads/ArachisH/Tanji/total?label=Total%20Downloads)
9+
![GitHub License](https://img.shields.io/github/license/ArachisH/Tanji?label=License)
10+
11+
Tanji is a Habbo protocol analyzer that intercepts and decrypts the traffic between the Habbo client and its servers. It provides developers and enthusiasts with tooling to inspect, manipulate, and understand the game's network communication.
12+
13+
## Features
14+
- **Packet Logger** | Monitor incoming and outgoing packets in real time.
15+
- **Packet Injection** | Send custom packets to the client or server.
16+
- **Packet Filtering** | Block or suppress specific packets.
17+
- **Packet Replacing** | Modify packets on the fly before they reach their destination.
18+
- **Extension Support** | Build and load custom extensions to automate or extend functionality.
19+
- **Tunneling Support** | Forward game traffic through an external proxy for anonymity or region bypassing.
20+
- **Session Persistence** | Connect to a remotely hosted instance to resume an active intercepted session at any time, even after closing the application.
21+
22+
## Platform Support
23+
| Platform | Status |
24+
|------------|---------------|
25+
| Flash | Supported |
26+
| Unity | Planned |
27+
| Shockwave | Planned |
28+
29+
## Requirements
30+
- Windows (x64)
31+
- [.NET 10 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
32+
33+
## Getting Started
34+
Download the latest release from the [Releases](https://github.com/ArachisH/Tanji/releases) page, extract the archive, and run `Tanji.exe`. No installation or administrator rights required.
535

6-
Application built to analyze the encrypted traffic between the Habbo client, and the server. Offers a variety of built-in tools for injecting, replacing, and blocking packets.
36+
## License
37+
Distributed under the GNU GPLv3 License. See [`LICENSE`](LICENSE) for more information.

0 commit comments

Comments
 (0)