- GUI (phases 7-8): BuilderScreen, Panel, NumberSlider, CycleButton, BuilderUi keybinds (Right Shift menu, P pause macro), lang entries, README - ConfigStore.loadOrEmpty/saveQuietly; BuildSettings.Range; BuilderFeature settings()/stage()/togglePause() - Checks: ~60 Checkstyle rules (errors), PMD with 7 categories, checkArchitecture (layer rules + max 4 files per package, with baseline), javac -Xlint:all -Werror, rule rejecting non-English comments - File length limit raised to 250 lines - License: GPL-3.0-only (LICENSE, fabric.mod.json) - All code comments and log messages translated to English
88 lines
4.7 KiB
Markdown
88 lines
4.7 KiB
Markdown
# Satura — авто-билдер для Minecraft (Fabric)
|
||
|
||
Клиентский мод: выделяешь область — мод сам ходит/летает и строит заданную форму.
|
||
GUI-меню, команды `.pos1/.pos2/.sel/.build`, навигация через Baritone (Aethereal),
|
||
инкрементальный подсчёт прогресса, ремонтные проходы по дырам.
|
||
|
||
| Что | Версия |
|
||
|---|---|
|
||
| Minecraft | 1.21.11 |
|
||
| Fabric Loader | 0.20.1 |
|
||
| Fabric API | 0.141.6+1.21.11 |
|
||
| Yarn mappings | 1.21.11+build.6 |
|
||
| Loom | 1.18.4 (нужна JVM 25 для запуска Gradle) |
|
||
| Java | 21 (target), 25 (JVM сборки) |
|
||
|
||
## Сборка и запуск
|
||
|
||
```bash
|
||
./gradlew build # jar в build/libs/satura-<версия>.jar
|
||
./gradlew check # тесты + checkstyle + pmd (гейт проекта)
|
||
./gradlew runClient # dev-запуск игры с модом
|
||
```
|
||
|
||
Gradle запускается на JVM 25: если дефолтная JVM другой версии, укажи её в
|
||
`gradle.properties` (`org.gradle.java.home`) или ключом `-Dorg.gradle.java.home=...`.
|
||
Для dev-запуска с Baritone положи `aethereal-1.21.11.jar` в `libs/`.
|
||
|
||
## Использование
|
||
|
||
### Клавиши (настраиваются в ванильных «Управлении», категория Satura)
|
||
|
||
| Клавиша | Действие |
|
||
|---|---|
|
||
| Right Shift | открыть/закрыть меню билдера |
|
||
| P | макрос: пауза / продолжить текущий билд |
|
||
|
||
### Команды (префикс `.`)
|
||
|
||
| Команда | Действие |
|
||
|---|---|
|
||
| `.pos1` / `.pos2` | задать углы области по позиции ног |
|
||
| `.sel clear` | сбросить выделение |
|
||
| `.build start` / `pause` / `resume` / `stop` / `status` | управление стройкой |
|
||
| `.build block <id>` | блок (`stone`, `minecraft:glass` или `hand` — блок из руки) |
|
||
| `.build shape box\|checker\|walls` | форма застройки области |
|
||
| `.build layers 1..3` | слоёв за один проход колонны |
|
||
| `.build strategy <id>` | стратегия постановки (`band_stack`, `column_drop`) |
|
||
| `.build set <ключ> <знач>` | параметр стратегии (`delayMs`, `reach`, `hover`, `flySpeed`, `bandLayers`) |
|
||
|
||
### GUI (Right Shift)
|
||
|
||
Pos1/Pos2 — зафиксировать текущую позицию ног; Старт/Пауза/Продолжить/Стоп;
|
||
форма; слои; задержка установки; ID блока (Enter — применить). Внизу — живой
|
||
статус: этап, прогресс, блоков/с, дыры. Во время стройки тот же статус раз в
|
||
секунду дублируется над хотбаром.
|
||
|
||
### Стратегии постановки
|
||
|
||
- **BandStack** (дефолт) — за один визит колонны ставится 1–3 слоя снизу вверх.
|
||
- **ColumnDrop** — по одному слою за визит.
|
||
Обе летают над слоем и ставят в колонну под собой. Для серверов с жёстким
|
||
анти-читом используй меньший `delayMs` и без полёта (наземные стратегии — план
|
||
Фазы 9, S5/S6).
|
||
|
||
Настройки хранятся в `config/satura/default.json` и применяются при старте.
|
||
|
||
## Архитектура
|
||
|
||
Слои зависимостей направлены строго вниз, циклы запрещены:
|
||
|
||
```
|
||
mixin → feature → interaction → core → util
|
||
gui → feature (только через фасад BuilderFeature)
|
||
```
|
||
|
||
- `core` — событие/команды/конфиг, ничего не знает о фичах;
|
||
- `feature/builder` — селекция, план (формы), скан (ColumnCache), движок, Baritone-мост;
|
||
- `interaction` — «руки»: постановка блоков (стратегии), инвентарь, движение;
|
||
- `gui` — экран и виджеты, общается с фичей только через фасад;
|
||
- `render` — GUI-рендер (rect/blur/outline/MSDF-текст) и рамка выделения в мире.
|
||
|
||
Правила кода: максимум 250 строк на `.java`-файл, максимум 4 файла на пакет,
|
||
магические числа — в константы, гейт сборки — `./gradlew check` (Checkstyle +
|
||
PMD). Подробный план развития — `todo.md`.
|
||
|
||
## Лицензия
|
||
|
||
GPL-3.0-only, см. `LICENSE`.
|