Project Chimera
Меню

Исходники

251 строк · 21 КиБ

README.md

1# Chimera-Launcher
2
3Переписанный на Rust лаунчер игр Windows для Linux и Steam Deck. Форк по духу,
4но не по коду: StartWine взят как источник знаний о том, что реально нужно для
5запуска игр, а не как база для правки.
6
7Личный проект одного владельца, публиковаться не планируется. Наработки, которые
8окажутся полезными, можно будет потом отдать команде StartWine — они под той же
9лицензией.
10
11## Зачем
12
13StartWine делает нужное дело, но накопил проблемы, которые не лечатся правками:
14
15- конфиг игры — исполняемый bash-скрипт, поэтому лаунчер обязан быть shell;
16- GUI на 19 496 строк в одном файле, логика запуска — 3 883 строки bash;
17- бэкап префикса — полный squashfs-образ, без версий и дедупликации;
18- автообновления Wine и библиотек так и не появились;
19- Epic Games Store показывает только список игр, без магазина и настроек;
20- у половины переключателей непонятно, что они делают.
21
22Подробный замер с цифрами: [`AUDIT-STARTWINE.md`](AUDIT-STARTWINE.md).
23
24## Главные решения
25
26- **Не переписывать с нуля.** Новое ядро с первого дня работает поверх
27 существующей папки `data/` StartWine, подсистемы заменяются по одной. На
28 каждом шаге есть рабочий лаунчер.
29- **Ядро ничего не знает про интерфейс.** Всё, что умеет лаунчер, доступно из
30 CLI. GUI — такая же обёртка над ядром, как и CLI.
31- **Нельзя добавить настройку, не объяснив её.** Обеспечено типами: структура
32 `Spec` требует и описание, и уровень, и «когда это менять». Из реестра
33 генерируются и UI, и справка CLI, и комментарии в конфиге.
34- **Обновление не может сломать работающую игру.** Версия Wine закреплена за
35 игрой; обновление добавляет новую рядом, а переключает её человек руками.
36- **Лаунчер обновляет себя атомарно и умеет откатиться.** Файлы скачиваются
37 рядом, сверяются с подписанным манифестом и переносятся на место через
38 `rename`; прежняя версия остаётся рядом, а прерванное обновление
39 достраивается или откатывается следующим запуском. Подробности и честный
40 список того, чего эта схема не даёт, — ADR-012 в [`DECISIONS.md`](DECISIONS.md).
41
42Обоснования и отвергнутые варианты: [`DECISIONS.md`](DECISIONS.md).
43План по фазам: [`ROADMAP.md`](ROADMAP.md).
44Ход работы по датам: [`DEVLOG.md`](DEVLOG.md).
45
46## Состояние
47
48**Версия 0.1.0.** Как тестировать: [`TESTING.md`](TESTING.md).
49
50Замерено на этой машине: интерфейс открывается за полсекунды, команды `chl`
51отвечают за сотые доли секунды, открытый лаунчер с живым фоном занимает
52около 8% одного ядра и 117 МиБ, без фона — 0,3%. Разделы строятся при первом
53открытии, поэтому WebKit поднимается только если зайти в «Магазин Epic».
54
55Работает интерфейс на GTK4, библиотека с обложками, запуск игр, Steam,
56магазин Epic внутри окна, снимки префиксов, диагностика, управление сборками
57Wine и настройка внешнего вида.
58
59| Крейт | Что делает |
60|---|---|
61| `chl-core` | настройки, конфиги, библиотека игр, палитра, пути |
62| `chl-runtime` | сборка окружения — порт `sw_runlib` |
63| `chl-wine` | каталог, установка и удаление сборок Wine, префиксы, снимки |
64| `chl-steam` | библиотека Steam, Proton, обложки, ярлыки Game Mode |
65| `chl-epic` | вход в Epic, библиотека, чтение установленного Heroic и legendary |
66| `chl-doctor` | проверки готовности системы: графика, синхронизация Wine, лимиты, инструменты |
67| `chl-selfupdate` | обновление самого лаунчера: подписанный манифест, `rename`, откат |
68| `chl-cli` | `chl` — всё то же из терминала |
69| `chl-gui` | `chimera-launcher` — интерфейс |
70
71Больше тысячи тестов, clippy без замечаний.
72
73### Что уже можно делать
74
75Кнопка «Синхронизировать игры» в библиотеке сверяет установки Steam:
76добавляет новые игры, обновляет найденный путь перенесённой игры и убирает
77карточку удалённой, когда её прежний каталог находится непосредственно в
78читаемой зарегистрированной `steamapps/common`, а манифеста больше нет ни
79в одной доступной библиотеке. Ошибки чтения, недоступные диски, повреждённые
80манифесты и незавершённые загрузки блокируют удаление. Свои игры по отсутствию
81файла автоматически не удаляются: без реестра установок это не доказательство
82удаления. Файлы игр, сохранения и отдельные настройки остаются; предыдущий
83список — `library.toml.before-sync`. Формат библиотеки не меняется.
84Ссылки на Telegram проекта и оформление проблемы/пожелания доступны в боковой панели.
85
86- смотреть библиотеку плитками с обложками из кэша Steam;
87- запускать игры: свои — через Wine, из Steam — через Steam;
88- запускать игры Steam через сам Steam, доставляя им настройки лаунчера
89 своим инструментом совместимости;
90- ставить Windows-версию Steam в отдельный префикс — для старых игр и DRM,
91 которые не идут под Proton;
92- подтягивать игры Steam и добавлять свои в Game Mode ярлыками;
93- ходить по магазину Epic внутри окна, входить в аккаунт и скачивать игры;
94 загрузку ведёт legendary, он идёт в комплекте; состояние сессии legendary
95 видно до установки, а на карточке игры и в `chl epic download` можно задать
96 потоки, таймаут, DLC, repair/force и предпочитаемый CDN. Обязательные
97 аргументы запуска из `installed.json` Epic сохраняются в настройках игры —
98 например `--executedbyepiclauncher=true` для VAMPIR;
99- подхватывать игры Epic, скачанные Heroic или legendary, и запускать их;
100- делать снимки префикса за секунду и почти без места (btrfs reflink),
101 откатываться на них; перед сменой сборки Wine и перед новым патчем реестра
102 снимок делается сам;
103- менять 62 из 63 настроек, у каждой видно назначение и «когда менять»;
104- задавать общие настройки для библиотеки и применять их ко всем играм кнопкой
105 «Применить ко всем играм» (или `chl settings --apply-all`). Заменяются только
106 выбранные общие параметры; пути, префиксы и остальные значения сохраняются.
107 Исходные конфиги сохраняются рядом как `.toml.before-global`. Новые игры
108 наследуют общие значения автоматически. Параметры Steam задаются там же:
109 `PROTON_LOG=1 %command% -windowed` или `gamemoderun %command%`.
110 Изменения действуют со следующего запуска через Chimera Launcher;
111- ставить сборки Wine из нескольких сотен доступных, удалять их и видеть, что вышло новее;
112- ставить игры и программы из скачанного установщика: «Открыть с помощью
113 Chimera-Launcher» на `setup_*.exe` спрашивает — установить, создать ярлык
114 или запустить, — установщик работает в префиксе своим обычным окном, а
115 каталог установки лаунчер находит сам, сравнив префикс до и после;
116- проверять систему диагностикой;
117- **отправлять отчёт о проблеме, не умея её описать**: выбрать симптом
118 («чёрный экран», «вылетает», «нет звука») — лаунчер решит, что собрать,
119 напишет описание и покажет целиком, что уйдёт; любой раздел можно
120 выключить (`chl report`, кнопка в «Диагностике»). Пользовательский токен
121 не нужен: сервер создаёт задачу в OpenProject и возвращает её номер
122 либо подтверждает очередь при недоступности OpenProject;
123- менять палитру и выключать живой фон — сразу, без перезапуска;
124- узнавать о новой версии лаунчера маленьким системным уведомлением, читать
125 patch notes прямо в окне и выбирать — поставить сейчас, потом или
126 пропустить эту версию;
127- прочитать «О программе»: чем этот лаунчер обязан StartWine, зачем он
128 вообще написан и на чём стоит, с лицензиями.
129
130### Чего ещё нет
131
132Изоляция игр через bubblewrap, отправка сохранений в облако, профиль геймпада
133на каждую игру, побайтовое сравнение окружения с bash-версией. Одна настройка из
13463 (`controller`) есть в реестре, но кода за ней нет ни здесь, ни в
135StartWine — об этом написано в её описании. Подробно — в конце [`TESTING.md`](TESTING.md).
136
137## Сборка и запуск
138
139```bash
140bash packaging/install.sh # сборка и установка в домашний каталог
141cd code && cargo test # тесты
142```
143
144Каталог сборки намеренно уведён в `~/.cache/chimera-launcher/target`
145(см. `code/.cargo/config.toml`). Отсюда важное: `target/` внутри репозитория —
146мусор от старых сборок, ставить только через `packaging/install.sh`, который
147спрашивает путь у `cargo metadata`.
148
149```bash
150chl add /путь/к/игре.exe # добавить игру
151chl scan ~/Games [--add] # найти игры в каталоге и добавить сразу несколько
152chl install setup_игра.exe # поставить из установщика в префиксе (--prefix, --wine, --add)
153chl fix-paths [--apply] # куда переехали игры, которых нет по записанному пути
154chl dedupe [--apply] # записи, описывающие одну и ту же игру
155chl rename-by-folder [--apply] # имена по папке вместо имени .exe
156chl list # игры в библиотеке
157chl list --import # перенести игры из StartWine
158chl doctor # готова ли система запускать игры
159chl doctor --all # включая то, что в порядке
160chl report --list-kinds # какие бывают отчёты о проблеме и что собирают
161chl report чёрный-экран --game <игра> # собрать отчёт и показать целиком
162chl report вылетает --game <игра> --send # он же, с попыткой отправки
163chl report лаунчер --without env,diagnostics # без указанных разделов
164chl wine list # доступные сборки Wine
165chl wine install <сборка> # поставить сборку
166chl wine installed # что стоит, сколько занимает, что вышло новее
167chl wine remove <сборка> # удалить незанятую сборку
168chl run <игра> --dry-run # что будет запущено
169chl run <игра> --exe путь -- арг # запустить
170chl env <игра> # дамп окружения
171chl env <игра> --notes # расхождения с bash и незакрытое
172chl legacy info # найти установку StartWine
173chl legacy list # игры и число настроек у каждой
174chl legacy show StartWine # настройки с объяснением каждой
175chl legacy verify # проверить разбор на потери
176chl legacy convert StartWine # показать TOML
177chl legacy convert --write # записать конфиги всех игр
178chl settings --tier simple # что видит новый пользователь
179chl settings --grep античит # поиск по описаниям
180chl snapshot create <префикс> # снимок префикса
181chl snapshot list # снимки всех префиксов: дата, место, причина
182chl snapshot restore <снимок> <префикс>
183chl snapshot remove <снимок> … # удалить выбранные, с подтверждением
184chl snapshot prune # убрать лишние автоснимки по политике
185chl steam list | import | shortcuts
186chl steam windows # поставить Windows-версию Steam
187chl epic login [код] | whoami | list | logout
188chl epic download <код> [--to …] [--max-workers N] [--dl-timeout сек]
189 [--with-dlcs | --skip-dlcs] [--repair | --force]
190chl epic installed --import # игры Epic от Heroic и legendary
191chl dirs # какие каталоги использует лаунчер
192chl about # о программе: StartWine, философия, лицензии
193chl update --check # вышла ли новая версия лаунчера
194chl update --notes # что в ней изменилось (patch notes)
195chl update --apply # скачать, проверить подпись и хэши, поставить
196chl update --status # что сейчас с обновлением
197chl update --rollback # вернуть прежнюю версию
198chl update --skip 0.2.0 # больше не сообщать про эту версию
199chl update-manifest --version … # собрать манифест релиза (команда владельца)
200```
201
202`chl legacy verify` разбирает каждый конфиг, собирает обратно и сравнивает с
203исходником побайтово. Пока он не проходит, переносить чужие настройки нельзя.
204
205## Где лежит код
206
207Собственный репозиторий: `git.chimera.local/fanchji/chimera-launcher`, private.
208Рабочая копия — `~/Projects/chimera-launcher`.
209
210До 2026-09-02 проект жил каталогом внутри репозитория `project-chimera` на
211Яндекс.Диске — это было обходом отсутствия доступа к кластеру, а не
212замыслом. Вынесен в свой репозиторий вместе с историей
213(`git subtree split`), см. ADR-011 в [`DECISIONS.md`](DECISIONS.md).
214
215Каталог сборки уведён за пределы репозитория — в
216`~/.cache/chimera-launcher/target` через `code/.cargo/config.toml`. Это
217касается только разработки: у обычной установки (из `.run` или из
218`install.sh`) в этом каталоге ничего не собирается, там только рантайм-кэш
219(см. ниже).
220
221## Где хранятся данные и как их сбросить
222
223Четыре каталога по XDG, отдельно от самой программы (см. `chl-core::paths`):
224
225| Каталог | Что там | Сбрасывается без потери игр |
226|---|---|---|
227| `~/.config/chimera-launcher/` | настройки лаунчера, настройки каждой игры | да |
228| `~/.local/share/chimera-launcher/` | библиотека — список игр, история запусков, обложки, `legendary`/`innoextract` | да |
229| `~/.cache/chimera-launcher/` | кэш: обложки, база знаний, каталог сборок Wine, кэш WebKit | да |
230| `~/.local/state/chimera-launcher/` | логи запусков, сохранённые отчёты о проблемах | да |
231
232Снести все четыре — «чистая установка» без переустановки самой программы:
233
234```sh
235rm -rf ~/.config/chimera-launcher ~/.local/share/chimera-launcher \
236 ~/.cache/chimera-launcher ~/.local/state/chimera-launcher
237```
238
239Отдельно от этого — каталог данных: префиксы Wine, сами сборки, снимки
240(`chl_core::paths::chimera_root`, по умолчанию `~/Games/Chimera`, путь —
241настройка `data_root`). Это не «конфиги»: пересоздание сборок Wine — это
242гигабайты повторной загрузки, а в префиксах — сохранения игр. Команда выше
243его не трогает и трогать не должна.
244
245## Лицензия
246
247GPL-3.0-or-later — та же, что у StartWine. Выбрана сознательно: код StartWine
248использовался как референс при выяснении семантики настроек, а значит
249результат производный. Отдельные заимствованные фрагменты отмечены в
250[`REFERENCES.md`](REFERENCES.md).
251