diff --git a/README.md b/README.md index fd17a29..d9bc102 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,54 @@ -# Rimpac Records Releases +# Rimpac Records -Публичный репозиторий только для обновлений Rimpac Records. +Rimpac Records - OBS-плагин для чистой локальной записи gameplay отдельно от стрима. -Исходный код хранится в приватном репозитории OBS_Record_Plugin. +Плагин нужен стримерам, которые хотят вести обычный эфир с вебкой, донатами, чатом и оверлеями, но параллельно получать отдельный clean-файл для монтажа: только игра, без лишних элементов стрима. -## latest.json +## Что делает плагин -Плагин проверяет обновления по адресу: +- Записывает выбранную OBS-сцену как отдельный clean-файл. +- Не меняет сцену стрима и не выключает оверлеи в основном эфире. +- Пишет раздельные аудиодорожки для монтажа: + - дорожка 1 - микрофон; + - дорожка 2 - звук игры. +- Использует выбранные источники OBS для микрофона и игры. +- Показывает превью clean-сцены, статус записи и уровни звука. +- Проверяет обновления через этот публичный release-репозиторий. + +## Как пользоваться + +1. Установите плагин через `RimOBSPlugin.exe`. +2. Запустите OBS. +3. Откройте док-панель `Rimpac Records`. +4. Выберите clean-сцену. В ней должен быть только источник игры или нужный gameplay-захват, без вебки, донатов, чата и оверлеев. +5. Выберите микрофон и звук игры. +6. Нажмите `Начать запись`. + +Clean-файл пишется отдельно от обычной записи/стрима OBS. Основной стрим остаётся таким, каким он настроен в OBS. + +## Обновления + +Плагин проверяет файл: https://git.safe-cap.com/RIMPAC/OBS_Record_Plugin_Releases/raw/branch/main/latest.json -## Файлы +Если доступна новая версия, в панели Rimpac Records появляется кнопка обновления. После скачивания обновление устанавливается при закрытии OBS. -- RimpacRecordsUpdate-0.1.1.zip - текущий update package для автообновления. -- RimpacRecordsUpdate-0.1.0.zip - предыдущий beta update package, оставлен для истории. -- RimOBSPlugin.exe - первичный установщик для пользователей. -- RimOBSPlugin.zip - тот же установщик в архиве, резервный вариант. +## Файлы репозитория +- `latest.json` - manifest последней версии для автообновления. +- `RimpacRecordsUpdate-*.zip` - update package для встроенного обновления. +- `RimOBSPlugin.exe` - первичный установщик для пользователей. +- `RimOBSPlugin.zip` - архив с установщиком, резервный вариант. + +## Текущая версия + +Текущая beta-версия: `v0.1.1`. + +Изменение `v0.1.1`: порядок аудиодорожек clean-файла сделан удобнее для монтажа: дорожка 1 = микрофон, дорожка 2 = игра. + +## Исходный код + +Этот репозиторий публичный и используется только для распространения установщика и обновлений. + +Исходный код Rimpac Records хранится в приватном репозитории `OBS_Record_Plugin`.