loki5512344
0ecb4635d1
The repository had no root README at all, and frontend/README.md was still the stock Vite template. Add a bilingual (EN/RU) overview covering the mod, site, and backend plus how they connect (%link, %config save/load), replace the frontend README with the actual stack, layout, and scripts, and fix the mod README's broken DEVELOPMENT.md link to point at DEV_GUIDE.md.
155 lines
8.9 KiB
Markdown
155 lines
8.9 KiB
Markdown
<div align="center">
|
||
|
||
# LoVisual
|
||
|
||
Minecraft utility client for PvP and automation.
|
||
Developed and maintained by loki5512344.
|
||
|
||
|
||
|
||
|
||
|
||
[English](#english) | [Русский](#русский)
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
## English
|
||
|
||
### Overview
|
||
|
||
LoVisual is an open-source legit utility client for Minecraft. It provides configurable visual, HUD, and UI features with a custom ClickGUI, theme system, and addon API.
|
||
|
||
LoVisual is developed and maintained by [loki5512344](https://github.com/loki5512344). The goal is to keep adding new features and maintain compatibility with the latest Minecraft versions.
|
||
|
||
### Quick Start
|
||
|
||
1. Install Fabric Loader 0.19.3+ for MC 26.2+
|
||
2. Download the LoVisual jar
|
||
3. Place it in your `mods/` folder along with Fabric API and Sodium
|
||
4. Open the ClickGUI with **`RShift`** (configurable)
|
||
|
||
### Features
|
||
|
||
| Feature | Description |
|
||
|---------|-------------|
|
||
| Combat | ProjectilePuncher, Reach, RubberHand, SpearAssist, TPSSync, PvpCooldowns, NoFriendDamage, TargetESP, Predictions, DamageTint |
|
||
| Visuals | ESP, NameTags, Chams, Crosshair, FullBright, MotionBlur, NoRender, Freecam, Hitboxes, Light, ChinaHat, Trinkets, SpatialGui, and more |
|
||
| Player | AutoTool, ClickPearl, FakeLag, NoDelay, LockSlot, AutoRespawn, DeathCoords, NoInteract |
|
||
| Misc | BetterMinecraft, FakePlayer, HitSounds, NameProtect, MessageFilter, NoSound, DefineTarget |
|
||
| HUD | Draggable & static elements: TargetHUD, ModuleList, Watermark, Reach, Armor, Potions, Keystrokes, Coords, Notifications, Scoreboard |
|
||
| ClickGUI | Full-featured GUI with module browser, settings editor, theme editor, config profiles |
|
||
| Config profiles | `.lvcfg` profiles for modules, HUD, and themes — shareable between users |
|
||
| Addon API | Versioned addon API for extending the client |
|
||
| Custom renderer | Custom UI rendering with MSDF fonts, SVG icons, and shader support |
|
||
| Iris/Sodium/Xaero | Optional compatibility with popular mods |
|
||
|
||
### Compatibility
|
||
|
||
| Mod | Status |
|
||
|-----|--------|
|
||
| Sodium | ✅ Required |
|
||
| Iris | ✅ Optional — shaderpack support |
|
||
| ImmediatelyFast | ✅ Optional — performance |
|
||
| Entity Culling | ✅ Optional — performance |
|
||
| Xaero's Minimap | ✅ Optional — waypoint integration |
|
||
| Xaero's World Map | ✅ Optional — waypoint integration |
|
||
| ViaFabricPlus | ✅ Optional — protocol translation |
|
||
|
||
### Dependencies
|
||
|
||
- **Required:** Fabric Loader 0.19.3+, Fabric API, Sodium, Java 25+
|
||
- **Optional:** Iris, ImmediatelyFast, ViaFabricPlus, Entity Culling, Xaero's Minimap, Xaero's World Map
|
||
|
||
### Installation
|
||
|
||
1. Download the jar from [Releases](../../releases)
|
||
2. Place it in your `mods/` folder
|
||
3. Restart the game
|
||
|
||
---
|
||
|
||
## Русский
|
||
|
||
### Обзор
|
||
|
||
LoVisual — открытый легитный утилитарный клиент для Minecraft. Включает настраиваемые визуальные, HUD и UI-модули, кастомный ClickGUI, систему тем и API для аддонов.
|
||
|
||
LoVisual разрабатывается и поддерживается [loki5512344](https://github.com/loki5512344). Цель — добавлять новые возможности и поддерживать актуальные версии Minecraft.
|
||
|
||
### Быстрый старт
|
||
|
||
1. Установите Fabric Loader 0.19.3+ для MC 26.2+
|
||
2. Скачайте LoVisual jar
|
||
3. Положите в папку `mods/` вместе с Fabric API и Sodium
|
||
4. Откройте ClickGUI через **`RShift`** (настраивается)
|
||
|
||
### Возможности
|
||
|
||
| Возможность | Описание |
|
||
|-------------|----------|
|
||
| Combat | ProjectilePuncher, Reach, RubberHand, SpearAssist, TPSSync, PvpCooldowns, NoFriendDamage, TargetESP, Predictions, DamageTint |
|
||
| Visuals | ESP, NameTags, Chams, Crosshair, FullBright, MotionBlur, NoRender, Freecam, Hitboxes, Light, ChinaHat, Trinkets, SpatialGui и другие |
|
||
| Player | AutoTool, ClickPearl, FakeLag, NoDelay, LockSlot, AutoRespawn, DeathCoords, NoInteract |
|
||
| Misc | BetterMinecraft, FakePlayer, HitSounds, NameProtect, MessageFilter, NoSound, DefineTarget |
|
||
| HUD | Перетаскиваемые и статические элементы: TargetHUD, ModuleList, Watermark, Reach, Armor, Potions, Keystrokes, Coords, Notifications, Scoreboard |
|
||
| ClickGUI | Полноценный GUI с браузером модулей, редактором настроек, тем и профилей конфигов |
|
||
| Профили `.lvcfg` | Профили для модулей, HUD и тем — можно шарить между пользователями |
|
||
| Addon API | Версионированное API для аддонов |
|
||
| Кастомный рендер | UI-рендеринг с MSDF-шрифтами, SVG-иконками и шейдерами |
|
||
| Iris/Sodium/Xaero | Опциональная совместимость с популярными модами |
|
||
|
||
### Совместимость
|
||
|
||
| Мод | Статус |
|
||
|-----|--------|
|
||
| Sodium | ✅ Требуется |
|
||
| Iris | ✅ Опционально — шейдерпаки |
|
||
| ImmediatelyFast | ✅ Опционально — производительность |
|
||
| Entity Culling | ✅ Опционально — производительность |
|
||
| Xaero's Minimap | ✅ Опционально — интеграция waypoint |
|
||
| Xaero's World Map | ✅ Опционально — интеграция waypoint |
|
||
| ViaFabricPlus | ✅ Опционально — протокол |
|
||
|
||
### Зависимости
|
||
|
||
- **Обязательные:** Fabric Loader 0.19.3+, Fabric API, Sodium, Java 25+
|
||
- **Опциональные:** Iris, ImmediatelyFast, ViaFabricPlus, Entity Culling, Xaero's Minimap, Xaero's World Map
|
||
|
||
### Установка
|
||
|
||
1. Скачайте jar из [Releases](../../releases)
|
||
2. Положите в папку `mods/`
|
||
3. Перезапустите игру
|
||
|
||
---
|
||
|
||
## Development
|
||
|
||
### Building
|
||
|
||
```bash
|
||
./gradlew build
|
||
```
|
||
|
||
### Docs
|
||
|
||
- [Development guide](DEV_GUIDE.md) — project rules, how to add modules/HUD/events/config
|
||
|
||
### License
|
||
|
||
GNU General Public License v3.0. See [LICENSE](LICENSE).
|
||
|
||
### Credits
|
||
|
||
- The `SpatialGui` module (rendering the open screen as a 3D plane in the world) is adapted from
|
||
[Spatial GUI](https://github.com/tastytrash/Spatial-GUI) (MIT License).
|
||
|
||
---
|
||
|
||
## TODO
|
||
|
||
План разработки и актуальный статус ведутся в [TODO.md](TODO.md).
|
||
|
||
[loki5512344]: https://github.com/loki5512344
|