Skip to content

Commit bea2551

Browse files
authored
Create README.md
1 parent 0068a10 commit bea2551

1 file changed

Lines changed: 67 additions & 0 deletions

File tree

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Ventauri
2+
3+
Ventauri is a custom desktop client for Discord built with Tauri, focused on performance, customization, and a native desktop experience integrating [Vencord](https://vencord.dev/).
4+
5+
It enhances the Discord web app by injecting custom scripts and styles at runtime, allowing deep UI modifications while remaining lightweight compared to Electron-based clients.
6+
7+
---
8+
9+
## ✨ Features
10+
11+
* Frameless and transparent window for a native feel
12+
* Custom window controls (minimize, maximize, close)
13+
* Smooth drag system for moving the window
14+
* Runtime CSS and script injection
15+
* Compatible with Vencord-style modifications
16+
* Performance-oriented architecture using Tauri (Rust + WebView)
17+
* Optional DevTools control and environment hardening
18+
19+
---
20+
21+
## 🚀 Tech Stack
22+
23+
* **Tauri** – lightweight desktop framework
24+
* **Rust** – backend commands and window management
25+
* **JavaScript** – DOM manipulation and runtime injection
26+
27+
---
28+
29+
## 📦 Installation
30+
31+
```bash
32+
# Clone the repository
33+
git clone https://github.com/your-username/ventauri.git
34+
35+
# Enter the project folder
36+
cd ventauri
37+
38+
# Install dependencies
39+
npm install
40+
41+
# Run in development
42+
npm run tauri dev
43+
```
44+
45+
---
46+
47+
## ⚙️ Usage
48+
49+
Ventauri launches Discord inside a customized Tauri window and applies runtime modifications automatically.
50+
51+
You can:
52+
53+
* Inject custom CSS
54+
* Modify UI elements
55+
* Extend functionality via scripts
56+
57+
---
58+
59+
## ⚠️ Disclaimer
60+
61+
This project modifies the Discord web client at runtime. It is not affiliated with or endorsed by Discord Inc.
62+
63+
---
64+
65+
## 📌 Status
66+
67+
This project is under active development. Features, optimizations, and internal structure may change frequently.

0 commit comments

Comments
 (0)