Project Chimera
Меню

Исходники

403 строк · 28 КиБ

TESTING.md

1# Как это тестировать
2
3Версия 0.2.6. Что делалось по ночам и почему — в [`DEVLOG.md`](DEVLOG.md),
4верхние записи.
5
6**Коротко, за вторую ночь:** новых больших кусков нет, зато прогнано руками
7и глазами всё, что уже было. Нашлось и исправлено: живой фон съедал целое
8ядро процессора (теперь 8%), запуск из интерфейса ждал завершения игры,
9`chl env` показывал не тот префикс и не ту сборку, чем запускал `chl run`,
10плитки в сетке разъезжались, игры Steam уходили в ярлыки Steam, Windows-Steam
11не запускался, а четыре настройки выглядели рабочими, ничего не делая.
12Появились: удаление сборок Wine и сообщение о вышедших новее, поиск по
13библиотеке и по настройкам, чтение игр Epic от Heroic и legendary, снимок
14перед патчем реестра, подсветка фокуса для геймпада.
15
16## Общие настройки и Steam
17
18В «Настройках игры» выбери параметр, включая явное «выключено», и нажми
19«Применить ко всем играм». В существующей игре соответствующее исключение
20должно исчезнуть; остальные параметры, exe, префикс и архитектура сохраняются.
21Рядом с изменённым конфигом появляется `.toml.before-global`. Повторное нажатие
22ничего не меняет. Следующая правка общего значения действует и для этой игры,
23и для новой записи библиотеки. Сброс общего параметра не снимает исключения
24в игре: массово применяются только явно выбранные общие значения.
25
26В поле «Дополнительные параметры Steam» проверь строку
27`PROTON_LOG=1 %command% -windowed`: переменная должна дойти до запуска,
28аргумент — сохраниться целиком, а правка строки — примениться при следующем
29запуске без перезапуска Steam. Требуется подключённая обёртка Chimera Launcher;
30её настройка доступна на этой же странице. Служебные вызовы Proton `run`
31не получают дополнительную строку. Старые параметры в самом Steam остаются
32в силе; новый общий шаблон хранится в `global-game-settings.toml`.
33
34## Запуск
35
36Программа установлена, ярлык в меню приложений есть:
37
38```bash
39chimera-launcher # интерфейс
40chl --help # то же самое из терминала
41```
42
43Если что-то пересобрал сам:
44
45```bash
46bash packaging/install.sh
47```
48
49Ставится в домашний каталог, без sudo. Удаляется `packaging/uninstall.sh`,
50данные при этом остаются.
51
52## Что проверять, по порядку
53
54### 1. Первый взгляд
55
56Открой `chimera-launcher`. Должно быть:
57
58- **Библиотека** — плитки с обложками Absolum и Hellforged Demo, подтянутыми
59 из твоего Steam.
60- Слева семь разделов, у каждого значок.
61- Под интерфейсом медленно плывут световые ленты, панели полупрозрачные.
62
63Строки поиска над сеткой сейчас нет — она появляется, начиная с двенадцати
64игр. Проверял на подставной библиотеке из 204 игр: поиск появляется,
65открытие раздела занимает 0,95 секунды вместо 0,55.
66
67**На что смотреть:** не рябит ли фон, не мешает ли движение, читается ли
68текст поверх стекла. Это вкусовое, и правится в разделе «Внешний вид» —
69шесть палитр, фон выключается, яркость регулируется.
70
71### 2. Библиотека и запуск
72
73Нажми на плитку — откроется страница игры: широкая картинка, кнопка
74«Запустить», сведения о том, чем именно игра запустится.
75
76**Игры Steam запускаются самим Steam**, а не нашим Wine. Это осознанно:
77Steam подберёт Proton, включит облачные сохранения, оверлей и Steam Input.
78Подменять его своим Wine значит всё это потерять и вдобавок получить
79проблемы с античитами.
80
81Проверь: нажми «Запустить» на Absolum — должен подняться Steam и начать
82игру.
83
84**Своя игра** (не из Steam) запускается нашим Wine:
85
86```bash
87chl add "/путь/к/игре.exe"
88chl run <имя>
89```
90
91Проверочная игра уже заведена: `chl run Сапёр` — встроенный «Сапёр» из Wine
92в префиксе `pfx_default`.
93
94**Убрать игру** можно с её же страницы, внизу: «Убрать из библиотеки».
95Файлы игры и префикс при этом остаются на диске — убирается только запись.
96
97### 3. Настройки
98
99Раздел «Настройки». Сверху выбор игры, **уровня сложности** и **поиск**. На
100«простом» видно 21 настройку из 67, остальные не спрятаны, но и не мешают.
101
102Поиск идёт по названию, описанию, «когда менять» и по старому имени из
103StartWine: помнишь не «Масштабирование FSR», а «то, что понижает
104разрешение», — найдётся и так. Уровень при поиске не учитывается: искать
105настройку и не найти её потому, что она «экспертная», — это препятствие, а
106не помощь.
107
108Для не-Steam игр на вкладке «Запуск» есть переключатели собственного
109окружения: «Без видео Wine» добавляет `WINEDLLOVERRIDES=winegstreamer=`,
110«Счётчик FPS (DXVK)» — `DXVK_HUD=fps`, «Без вертикальной синхронизации» —
111`vblank_mode=0`. Произвольные переменные можно вписать в настройке
112«Окружение запуска»; `chl run <игра> --dry-run` показывает итог отдельно.
113
114**Главное, что надо оценить:** под каждой настройкой написано, что она
115делает. Разверни любую — там же «когда менять» и откуда взялось текущее
116значение.
117
118Если хоть про одну настройку непонятно, зачем она, — **это баг и мне он
119интереснее, чем сбой запуска**. Весь смысл проекта в том, чтобы такого
120вопроса не возникало.
121
122### 4. Магазины и Windows-Steam
123
124**Steam** — раздел «Магазины»: твоя библиотека, найденный Proton
125Experimental, кнопка добавления игр Chimera в Steam ярлыками (это
126единственный способ попасть в Game Mode на Steam Deck).
127
128Ярлыки пишутся аккуратно: чужие записи не трогаются, перед записью делается
129резервная копия `.chl-backup`. После добавления Steam надо перезапустить —
130он читает файл при старте.
131
132**Epic** — раздел «Магазин Epic»: настоящий сайт магазина внутри окна, с
133навигацией. Работает без всякого входа, посмотреть можно прямо сейчас.
134
135**Windows-версия Steam** — там же, в разделе «Магазины». Ставится кнопкой:
136скачивается официальный установщик Valve, создаётся отдельный префикс,
137Steam устанавливается тихо. Уже установлен и заведён в библиотеке как
138«Steam-Windows» — можно просто запустить.
139
140Это для старых игр, капризного DRM и лончеров без поддержки Proton.
141Нативный Steam при этом остаётся: игры с античитами EAC и BattlEye работают
142только через него.
143
144Вход в аккаунт Epic — отдельно:
145
146```bash
147chl epic login # напечатает адрес
148# войти в браузере, скопировать authorizationCode
149chl epic login <код>
150chl epic list # библиотека Epic
151```
152
153То же самое можно сделать не выходя из интерфейса: в разделе «Магазины»
154кнопка «Открыть страницу входа» и поле, куда вставить код. Вставлять можно
155что угодно — само значение, строку `"authorizationCode": "..."`, весь JSON
156или адрес из строки браузера: код найдётся сам.
157
158**Пароль Epic я не вижу и не запрашиваю.** Ты входишь на сайте Epic в своём
159браузере, лаунчер получает только одноразовый код, который ты отдаёшь сам.
160Токен ложится в связку ключей системы, не в файл.
161
162**Игры Epic** ставятся кнопкой «Установить» через собственную копию
163`legendary`; перед установкой лаунчер сверяет сессию legendary с входом
164Chimera и показывает её состояние в разделе Epic. В карточке игры и в
165`chl epic download` доступны параметры: каталог, число потоков, сетевой
166таймаут, пропуск DLC, отключение delta-манифестов, repair/force и
167предпочитаемый CDN. Обязательные аргументы Epic из `installed.json`
168сохраняются в настройках игры: например, VAMPIR получает
169`--executedbyepiclauncher=true`, и `chl run VAMPIR --dry-run` должен показать
170его как `аргументы из конфига`. Установленные Heroic или legendary игры по-прежнему
171подхватываются — `chl epic installed --import`, вход для этого не нужен.
172
173### 5. Диагностика
174
175Раздел «Диагностика» или `chl doctor`. 26 проверок: Vulkan, видеокарты,
176ntsync, локаль, лимиты, 32-битные библиотеки (включая GStreamer), инструменты,
177файловая система, снимки префиксов, данные лаунчера.
178
179**Ничего не меняет** — только смотрит и объясняет, что делать.
180
181### 6. Сборки Wine
182
183Раздел «Сборки Wine»: установлено, доступно по каналам, установка кнопкой.
184Каналы названы по-человечески и с пояснением, чем отличаются.
185
186**Сборку видно, сколько она занимает, и её можно удалить** — занятую не
187дадут, и напишут, кто её держит. **Про вышедшие обновления лаунчер
188говорит сам:** рядом с установленной сборкой написано, что вышло новее, и
189стоит кнопка «Поставить новее». Новая ставится рядом, а не вместо: старая
190может быть единственной, на которой работает конкретная игра, поэтому
191выбор сборки у игр не трогается.
192
193GE-Proton проверен вживую: сборка устроена иначе обычной (`files/bin/wine`
194вместо `bin/wine`), лаунчер это распознаёт, префикс создаётся, запуск
195проходит, ntsync поднимается. Установлены две сборки: `GE-Proton10-34` и
196`wine-11.16-staging-amd64` — третья, `wine-11.15-staging-amd64`, была
197удалена ночью при проверке удаления.
198
199**Префикс помнит, какой сборкой он собран** (файл `.chl-wine` внутри него).
200Если в настройках игры сборка не задана, запуск возьмёт именно её, а не
201случайную из установленных. Порядок: настройка игры, метка префикса,
202единственная установленная.
203
204### 7. Снимки префикса
205
206На странице любой игры не из Steam — раздел «Снимки префикса». Это замена
207опасного бэкапа StartWine.
208
209```bash
210chl snapshot create pfx_default --label "перед экспериментом"
211chl snapshot list pfx_default
212chl snapshot restore <имя> pfx_default
213```
214
215**Что проверить:** снимок 943-мегабайтного префикса делается за 0,1 секунды
216и добавляет к занятому месту ноль байт — данные общие с префиксом. Откат
217занимает четверть секунды.
218
219**Снимок делается сам** в двух случаях: перед сменой сборки Wine и перед
220патчем реестра, который появился или изменился с прошлого запуска. Смени
221сборку на странице игры и запусти — увидишь строку «делаю снимок префикса,
222чтобы можно было вернуться». Повторный запуск без изменений снимка не
223делает: снимать одно и то же при каждом старте значит засорять диск.
224
225### 8. Клавиатура и геймпад
226
227Пройди по интерфейсу Tab и стрелками, не трогая мышь. У выбранной плитки и
228у строк должна быть заметная обводка цветом палитры.
229
230Это не мелочь для Steam Deck: там интерфейс проходят геймпадом, а Steam
231Input отдаёт его как клавиатуру и мышь. Не видно, где фокус, — значит
232ходить по библиотеке нельзя вообще. Обводки не было совсем: собственный фон
233плитки перекрывал штатную обводку libadwaita.
234
235### 9. Внешний вид
236
237Шесть палитр с образцами цвета, выключаемый живой фон, регулировка яркости.
238
239**Про расход:** живой фон стоит около 8% одного ядра, без него — 0,3%.
240Замерено. Первая версия съедала целое ядро, это было исправлено ночью
241(рисование в уменьшенном холсте, 12 кадров в секунду вместо 30, таймер
242вместо тиков композитора). Пока идёт игра, окно свёрнуто и фон не рисуется.
243Всё применяется сразу: переключил палитру — фон под интерфейсом сменился
244на этом же кадре. Выбирать цвет, который покажется только после
245перезапуска, значит выбирать вслепую.
246
247### 10. Нативные профили запуска
248
249Shell-профиль можно добавить как игру: `chl add /путь/test.sh --name "DayZ TEST"`.
250Его shebang проверяется перед запуском; `chl run "DayZ TEST" --dry-run`
251не исполняет скрипт. Настройки Wine к нативному скрипту не применяются.
252
253### 11. «О программе» и «Обновления»
254
255Два раздела в группе «О лаунчере», внизу боковой панели.
256
257**«О программе»** — читается, а не проверяется кнопками. Что там должно
258быть: первым разделом StartWine (не в списке библиотек внизу, а первым — так
259и задумано), с рабочими ссылками на их git, Telegram и сообщество
260ВКонтакте; версия и лицензия под названием; список того, на чём лаунчер
261стоит, с лицензией у каждого пункта; ссылка на `PRIVACY.md` вместо копии
262его списка. Тот же текст показывает `chl about` — если они разошлись, это
263баг, а не оформление.
264
265**«Обновления»** — что проверить:
266
267- «Установлено»: версия и **каталог установки** — он должен совпадать с тем,
268 откуда лаунчер реально запущен (`which chimera-launcher`), а не с
269 `~/.local/bin` вслепую;
270- строка с предупреждением «Установка обновлений недоступна в этой сборке»
271 **должна быть**, пока `keys/wine-manifest.pub` пуст. Это не поломка: без
272 вшитого ключа проверить подпись нечем, и обновление намеренно не ставится;
273- «Проверить сейчас» вне LAN/VPN обязан сказать «до сервера обновлений не
274 дошли» и ничего больше — не ругаться и не подвешивать окно;
275- «Что нового в этой сборке» — пять последних записей `DEVLOG.md`,
276 раскрывающихся; то же самое печатает `chl changelog`;
277- переключатель «Проверять при запуске» — та же настройка, что в
278 «Настройках лончера» → «Обновление лаунчера». Переключил здесь — проверь,
279 что там тоже переключилось (файл один, `global.toml`).
280
281**Чего в этом разделе пока не увидеть на живой машине:** самого обновления.
282Механизм готов и проверен, но раздачи по адресу по умолчанию ещё нет и
283настоящего ключа владельца тоже — см. «Чего ещё нет» ниже. Проверять подмену
284и откат сейчас можно только на выброшенном дереве: `chl update --status
285--root <каталог>`, `--recover --root`, `--rollback --root`. **Не на своём
286`~/.local/bin`.**
287
288## Полный список команд
289
290```bash
291chl doctor [--all] диагностика
292chl list [--import] библиотека
293chl add <exe> [--name] [--prefix]
294chl scan <dir> [--add] [--yes] [--depth N]
295chl fix-paths [--apply] [--depth N]
296chl dedupe [--apply]
297chl rename-by-folder [--apply]
298chl forget <игра>
299chl run <игра> [--dry-run] [--exe путь] -- аргументы
300chl env <игра> [--notes] окружение и расхождения с bash
301chl settings [--tier simple] [--grep текст]
302chl wine list | installed | install <сборка> | remove <сборка>
303chl steam list | import | shortcuts | windows
304chl epic login [код] | whoami | list | download | installed | logout
305chl legacy info | list | show | verify | convert
306chl snapshot create | list | restore | remove
307chl dirs
308chl about [--links] о программе, StartWine, лицензии
309chl changelog [--game игра] [--limit N]
310chl update --check | --notes | --apply | --status | --rollback | --recover
311chl update --skip <версия> больше не сообщать про эту версию
312chl update-manifest --version … --binaries … --base-url … (команда владельца)
313```
314
315Интерфейс: `chimera-launcher [--page <раздел>] [--game <игра>] [--scan <каталог>]
316[--fix-paths] [--rename-by-folder]`.
317Разделы: `library`, `stats`, `media`, `epic`, `gog`, `steam`, `browser`,
318`settings`, `wine`, `appearance`, `gamepad`, `launcher`, `backups`, `doctor`,
319`updates`, `about`.
320
321## Чего ещё нет — честно
322
323**Раздачи обновлений лаунчера.** Механизм самообновления написан и проверен
324целиком (подпись, sha256, подмена по `rename`, откат, восстановление после
325обрыва — см. ADR-012), но по адресу по умолчанию
326`chimera-compat.chimera.local/release/chl-release.json` файла ещё нет, и
327настоящего подписывающего ключа владельца тоже нет. Поэтому `chl update
328--check` честно отвечает «до сервера не дошли», а установка отказывается
329работать вслух. Два шага, которых не хватает: `chl wine manifest keygen` от
330владельца (публичный ключ в `keys/wine-manifest.pub`, секретный — вне git) и
331выложенный на хост `chl-release.json` + `.sig` рядом.
332
333**Скачивание игр Epic.** Установка ведёт собственная копия `legendary` — тот
334же проверенный путь, что у Heroic. Своего чанкового загрузчика у лаунчера
335нет, и не будет без возможности проверить его на живом аккаунте. Отмена
336установки, отдельные команды `legendary update/verify` и хранение внутреннего
337`app_name` Epic в формате библиотеки Chimera пока не обёрнуты.
338
339Игры Epic, уже скачанные Heroic или legendary, лаунчер находит, добавляет в
340библиотеку и запускает — `chl epic installed --import` или кнопка в разделе
341«Магазины». Вход в аккаунт для этого не нужен. Разбор `installed.json`
342проверен в том числе на частично битом файле: одна плохая запись не должна
343прячет остальные.
344
345**Одна настройка из 67 ничего не делает, и это видно на экране.** Она
346показана неактивной, с прямо написанной причиной:
347
348- `controller` — не влияет ни на что и в самом StartWine: `sw_runlib` не
349 читает эту переменную ни разу.
350
351(`dgvoodoo2` и `disable_prefix_update` раньше были в этом списке — оба
352портированы: `Prefix::apply_dgvoodoo2`/`set_update_disabled` в `chl-wine`,
353вызываются из `chl run` в `chl-cli/src/main.rs`.)
354
355`chl env <игра> --notes` печатает тот же список.
356
357**Побайтовое сравнение с bash-версией не сделано.** Это критерий готовности
358фазы 0, и для него нужны игры разных типов: DX11, DX12, OpenGL, 32-битная и
359одна с внешним лончером.
360
361**Изоляции через bubblewrap нет.** `bwrap` в системе есть, обвязки нет.
362
363**Установка библиотек в префикс снимка не вызывает.** Смена сборки Wine и
364патч реестра — вызывают.
365
366## Два сознательных расхождения с StartWine
367
368Оба печатаются в `chl env <игра> --notes`:
369
3701. **`fps_limit` работает независимо от оверлеев.** В StartWine своей
371 реализации нет: значение попадает либо в конфиг MangoHud, либо в
372 `DXVK_FRAME_RATE` внутри блока служебного оверлея DXVK. Выключи оба — и
373 настройка уровня «простой» молча перестаёт работать.
3742. **`vkbasalt` получает свой файл конфигурации на каждую игру.** StartWine
375 правит `sed`-ом один общий файл, поэтому игры перезаписывают настройки
376 друг друга.
377
378## Что писать в отчёте
379
380Полезнее всего, в порядке ценности:
381
3821. **Непонятно, что делает настройка** — описание плохое, это баг.
3832. **Игра не запускается**, а сообщение не объясняет почему.
3843. **Разница с StartWine** в поведении одной и той же игры.
3854. **Некрасиво или неудобно** — конкретно: что именно и на каком экране.
386
387## Если что-то пошло не так
388
389Всё обратимо:
390
391```bash
392rm -rf ~/.config/chimera-launcher # конфиги игр, палитра
393rm -rf ~/.local/share/chimera-launcher # библиотека
394rm -rf ~/.cache/chimera-launcher # кэш, скачанные архивы, сборка
395bash packaging/uninstall.sh # сама программа
396```
397
398Префикс и сборки Wine лежат в `~/Games/StartWine/data/` — там же, где их
399держит StartWine.
400
401Ярлыки в Steam: если что-то не так, рядом с `shortcuts.vdf` лежит
402`shortcuts.vdf.chl-backup` — верни его и перезапусти Steam.
403