diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..3eff997 --- /dev/null +++ b/README.MD @@ -0,0 +1,48 @@ +# SS14: Content Extractor + +Программа предназначена для выгрузки загруженного через ["Space Station 14 Launcher"](https://github.com/space-wizards/SS14.Launcher) контента. + +## Как пользоваться + +В начале необходимо открыть файл базы данных контента "Space Station 14 Launcher". + +1. Откройте меню "Файл" -> "Открыть" +2. Выберите файл базы данных "лаунчера". + Для Windows, файл находиться по одному из следующих путей: + - `%LOCALAPPDATA%\Space Station 14\launcher\content.db` + - `C:\Users\\AppData\Local\Space Station 14\launcher\content.db` + +После загрузки появится список, состоящий из HEX последовательностей. Каждая из этих последовательностей - +это контент сервера, на который вы когда-либо заходили через "лаунчер". +К сожалению, в данной версии программы не встроен механизм, позволяющий "дешифровать" данные последовательности, +а потому вам придётся экспериментально выяснять, какая из представленных HEX последовательностей является +искомым сервером. + +Раскрытие списка HEX последовательности загружает информацию о контенте выбранного сервера. + +После этого, вы можете либо выгрузить конкретный файл (контент), либо выгрузить папку целиком. +Для этого нажмите на нужном элементе Правой Кнопкой Мыши (ПКМ) и выберите единственный пункт "Сохранить". + +Так же, после раскрытия HEX последовательности, вы можете нажать ПКМ на неё и выгрузить весь контент по +выбранному серверу. + +## Сборка и запуск + +Требуется: + +- Java 21 +- Gradle 8 + +Команда сборки + +```shell +gradlew shadowJar +``` + +В итоговый JAR будет находиться в `build/libs/ss14-launcher-extractor-1.0-SNAPSHOT.jar`. + +Команда запуска: + +```shell +java -jar ss14-launcher-extractor-1.0-SNAPSHOT.jar +```