Документация

+ Обновил README ещё.

docs/proto/oneme_tcp.md

@@ -1 +0,0 @@
-TODO

docs/proto/tamtam_ws.md

@@ -1,29 +0,0 @@
-# Описание протокола TamTam по Websocket
-
-## Основная информация
-В веб версии мессенджера ТамТам используется протокол, работающий поверх Websocket. 
-
-Пакеты в этом протоколе являются текстовыми JSON данными.
-
-Структура пакета:
-```
-{
-    ver: int,
-    cmd: int,
-    seq: int,
-    opcode: int,
-    payload: {}
-}
-```
-
-* ver - версия протокола
-* cmd - определяет, от кого отправлен пакет. клиент - 0, сервер - 1
-* seq - порядковый номер пакета (сервер дублирует его из запроса клиента)
-* opcode - команда
-* payload - полезная нагрузка команды
-
-## Команды протокола
-
-### PING (1)
-Клиент периодически отправляет пакет с командой PING и пустой нагрузкой серверу.
-Сервер отвечает ему тем же.

faq/patch_apk.md

@@ -22,3 +22,6 @@
 2. Открываем консоль в той же директории и производим декомпиляцию: `apktool d <имя apk> -o max`
 3. Заходим в папку проекта и заменяем во всех классах "api.oneme.ru" на свой адрес сервера
 4. Производим повторную сборку с помощью команды: `apktool b max -o max_modified.apk`
+
+> [!WARNING]
+> Если у вас возникает ошибка при при повторной сборке, попробуйте декомпилировать клиент с параметром -r

faq/patch_ipa.md

@@ -0,0 +1,8 @@
+# Патч MAX для IOS
+
+1) Распаковываете IPA
+2) Находите файл MAX в Payload/Max.app
+3) Открываете hex-редактор и находите api.oneme.ru и меняете на свой
+   При желании можете поменять другие URL
+   URL не должен привышать количество символов которое было у изначального URL!
+4) Открываете IPA как архив и добавляете патченный файл MAX в Payload/Max.app

faq/readme.md

@@ -1,7 +1,8 @@
 # Навигация по faq
 
 ## Работа с сервером
-[Установка сервера](install.md)
+- [Установка сервера](install.md)
 
 ## Патчинг клиентов
-[Патч apk](patch_apk.md)
+- [Патч мобильного клиента для Android](patch_apk.md)
+- [Патч мобильного клиента для IOS](patch_ipa.md)

faq/servers.md

@@ -0,0 +1,11 @@
+> [!Caution]
+>
+> На данной странице представлены инстансы от сторонних разработчиков.
+>
+> Используйте на свой страх и риск
+> 
+
+# Открытые сервера
+
+* [JustMAX](https://t.me/justmax_official)
+* [mox.nyako.tk](https://t.me/opengrame/296), порт 443 (регистрация по реальному номеру)

readme.md

@@ -1,6 +1,6 @@
 > [!Caution]
 >
-> Проект находится на ранней стадии разработки и вероятно полон багов. 
+> Проект находится на ранней стадии разработки и, вероятно, полон багов.
 >
 > Использование в профессиональных средах не рекомендовано.
 > 
@@ -13,7 +13,7 @@ https://t.me/openmax_alerts
 # Требования
 
 - Python 3.12+ (поддержка версий ниже не гарантирована)
-- MariaDB, MySQL или SQLite
+- MariaDB, MySQL или SQLite (использование последнего не рекомендуется, так как поддержка ещё в разработке)
 - Уметь патчить клиент MAX или собирать Komet из исходного кода (естественно с заменой сервера)
 - Сертификат и приватный ключ X.509 (для тестирования сервера можно сгенерировать самоподписанный: ```openssl req -x509 -newkey rsa:2048 -nodes -keyout key.pem -out cert.pem -days 365```)
 
@@ -22,4 +22,6 @@ https://t.me/openmax_alerts
 Клиент может быть практически любым, главное условие - чтобы он был совместим с официальным сервером (`api.oneme.ru` / `api.tamtam.chat`).
 
 # Дополнительная информация
-[Faq](faq/readme.md)
+- [FAQ](faq/readme.md)
+- [Документация проекта](https://github.com/openmax-server/docs)
+- [Публичные сервера](faq/servers.md)