Updated README.md

2022-04-29 20:56:14 +03:00
parent 57cdcfcbd1
commit dc768952c3
1 changed files with 62 additions and 13 deletions
@@ -1,18 +1,74 @@
 # VTosters Lite

-VTosters Lite - это модифицированный клиент ВКонтакте, основанный на версии 5.29
+VTosters Lite - это модифицированный клиент (декомпиляция) официального ВКонтакте основанный на версии 5.29

 О найденных багах сообщать в [issues](https://github.com/vtosters/lite/issues), просьба не плодить дубликаты, воспользуйтесь поиском перед созданием нового issue

+## Откладка
+
+Для откладки с помощью Android Studio необходимо пройти в `/smali/AndroidManifest.xml`
+```
+android:debuggable="false" -> android:debuggable="true"
+```
+
+Для дополнительной откладки ответов, доп логов и подмены данных для дебаг приложения необходимо включить **Режим разработчика**
+```
+Настройки -> Для разработчиков -> Режим разработчика
+```
+
+Для просмотра трафика необходимо отключить функцию **SSL Pinning**
+
+```
+Настройки -> Для разработчиков -> SSL Pinning
+```
+
+Для логгирования внутренних запросов к API необходимо включить функции **Логгирование API** 
+
+(Работает только при использовании внутреннего логгера!)
+
+```
+Настройки -> Для разработчиков -> Логгирование API
+```
+
+Для использования внутреннего логгера необходимо включить функции **Запись логов в файл** 
+```
+Настройки -> Для разработчиков -> Запись логов в файл
+```
+Сразу после нажатия на запись аппа начнет записывать **все действия** в файлы по пути
+```
+/VK/logs/com.vtosters.lite
+```
+При следующем открытии аппы она автоматически запакует эти файлы и отправит вам в **Документы** ВК
+
+Позже архив можно будет скачать и работать с файлами логов которые находятся в нем
+
 ## Разработка
-Мы всегда готовы к новым предложениям в [Pull Requests](https://github.com/vtosters/lite/pulls)
+
+Для понимания декомпилированного кода требуется использовать **Dex to Java** декомпилятор [jadx](https://github.com/skylot/jadx) или же сторонние варианты как [Fernflower](https://github.com/fesh0r/fernflower)
+
+Рекомендуется установка **Android Debug Bridge** в систему ([Гайд как это сделать](https://technastic.com/system-wide-adb-fastboot-windows-10))
+
+Для индексации декомпилированного кода в Studio используется [dex2jar](https://github.com/pxb1988/dex2jar)
+
+Сгенерированные библиотеки из дексов находятся в `/app/libs`
+
+При чистой перекомпиляции дексов в jar может сломаться некоторая индексация файлов, исправляйте ручками что попадется (К примеру какие-то функции в дексах изменены с **private** на **public**)
+
+Для сборки декомпилированного кода и ресурсов используется [Apktool](https://github.com/iBotPeaches/Apktool)
+
+А при нахождении решения каких-либо проблем ждем вас в [Pull Requests](https://github.com/vtosters/lite/pulls)
+
+### Всё необходимое для сборки и компиляции
+
+`Не меняйте packagename во избежание проблем с приложением`
+
+`Некоторые функции связанные с музыкой не будут работать в пересобранном приложении`

-## Компиляция
 Весь декомпилированный код клиента находится в `/smali`

-Весь исходный код написанный на Java находится в `/app`
+Весь исходный код модификации находится в `/app`

-Все необходимые скрипты для компиляции APK, его подписывании и не только находятся в `/scripts`
+Все необходимые скрипты/жарники для компиляции APK, его подписывании и не только находятся в `/scripts`

 ### Необходимые зависимости
 Требуется установленная **Java** >11 версии
@@ -32,11 +88,4 @@ VTosters Lite - это модифицированный клиент ВКонт
 build.bat
 ```

-![](https://cdn.discordapp.com/attachments/762063967979175946/961682299366309928/unknown.png)
-
-
-## Проверка версии коммита
-
-С версии 0.0.4 доступна прямая проверка версии коммита внутри приложения.
-
-![](https://media.discordapp.net/attachments/762063967979175946/957344234640408606/Screenshot_20220326-212257_VTLite__01.png)
+![](https://cdn.discordapp.com/attachments/762063967979175946/961682299366309928/unknown.png)