|
| 1 | +# **𝗧 𝗥 𝗔 𝗡 𝗦 𝗖 𝗥 𝗜 𝗣 𝗧** |
| 2 | + |
| 3 | +<p align="left"><a href="https://github.com/sponsors/LuigiColantuono"><img src="https://img.shields.io/github/sponsors/LuigiColantuono?style=social"></a> <a href="https://paypal.me/l0g4n7"><img src="https://img.shields.io/badge/💖-Support-ff69b4"></a> <img src="https://img.shields.io/npm/v/@ovencord/transcript"> <img src="https://img.shields.io/npm/dm/@ovencord/transcript?label=downloads"> <img src="https://img.shields.io/npm/l/@ovencord/transcript"> <img src="https://img.shields.io/github/repo-size/ovencord/transcript"> <a href="https://github.com/ovencord/transcript"><img src="https://img.shields.io/badge/Bun-Networking-black?logo=bun"></a></p> |
| 4 | + |
| 5 | +<div align="center"> |
| 6 | + <img src="https://github.com/user-attachments/assets/70e8758e-f363-478a-a013-fd46ca3cf3ec" alt="@ovencord/transcript Logo" width="180"/> |
| 7 | + <p><b>The fastest, lightest, and most faithful Discord HTML transcript generator.</b></p> |
| 8 | + <p><i>Built exclusively for the Bun ecosystem.</i></p> |
| 9 | +</div> |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +Stop simulating browsers to generate simple text logs. **@ovencord/transcript** purges the bloat of JSDOM and React, replacing them with a high-performance, string-based rendering engine powered by Bun and a specialized fork of Mustache. |
| 14 | + |
| 15 | +## **Blazingly Fast** |
| 16 | + |
| 17 | +* **Zero Node Dependencies**: No `ws`, no `http` legacy, no `JSDOM`. Pure Bun-native execution. |
| 18 | +* **Mustache Powered**: Generates complex transcripts in milliseconds using optimized string templates instead of heavy, recursive DOM manipulation. |
| 19 | +* **Zero Memory Overhead**: While other libraries require hundreds of MBs to "render" a virtual DOM, Buncord processes messages through a stream-like logic that keeps your RAM footprint invisible. |
| 20 | + |
| 21 | +## **Absolute Cinema UI** |
| 22 | + |
| 23 | +* **Discord v2 Native**: First-class support for modern components: **Buttons**, **Select Menus**, and the new **Containers**. |
| 24 | +* **1:1 Visual Fidelity**: Unlike libraries with hardcoded styles, Buncord uses a dynamic CSS variable system mirrored directly from the official Discord client. |
| 25 | +* **Media-First**: Native support for **Multi-image Media Galleries**, high-res avatars, and custom emoji rendering. |
| 26 | +* **Smart Mentions**: Intelligently resolves user mentions and relative timestamps within the transcript context. |
| 27 | + |
| 28 | +### **📦 Bundle Size Comparison: Transcripts** |
| 29 | + |
| 30 | +| Package | Size (Unpacked) | Total Files | Dependencies | Install Weight (est.) | |
| 31 | +| :--- | :--- | :--- | :--- | :--- | |
| 32 | +| **discord-html-transcripts** | 170 kB | 87 | React, JSDOM, etc. | **~25.000 kB (25MB)** | |
| 33 | +| **@ovencord/transcript** | 33.8 kB | 8 | **NONE** (Native) | **~34 kB** | |
| 34 | + |
| 35 | +> **Result: 99.8% savings on total installation weight!** |
| 36 | +
|
| 37 | +## **Installation** |
| 38 | + |
| 39 | +```bash |
| 40 | +bun add @ovencord/transcript |
| 41 | +``` |
| 42 | + |
| 43 | +## **Quick Start** |
| 44 | + |
| 45 | +```typescript |
| 46 | +import { createTranscript } from '@ovencord/transcript'; |
| 47 | + |
| 48 | +const messages = [...]; // Your Discord.js / Buncord messages |
| 49 | +const channel = { name: 'ticket-001' }; |
| 50 | + |
| 51 | +const html = await createTranscript(messages, channel); |
| 52 | +// Output is a high-performance HTML buffer/string ready to be served or saved. |
| 53 | +``` |
| 54 | + |
| 55 | +<div align="center"> |
| 56 | +<img width="400" height="500" alt="Buncord-Transcript" src="https://github.com/user-attachments/assets/a63256bd-c22e-465a-a667-74d747526dfb" /> |
| 57 | +</div> |
| 58 | + |
| 59 | +## **The Philosophy** |
| 60 | + |
| 61 | +Built out of frustration with outdated, bloated libraries that fail to render modern Discord components. Buncord-Transcript is a **"Performance Tier 1"** tool for developers who prioritize speed, code purity, and production stability. |
| 62 | + |
| 63 | +--- |
| 64 | +> This project was created using `bun init` in bun v1.3.6. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime. |
0 commit comments