Быстрый старт#

В пакете для пользователей две программы: клиент termi и чат-сервер termi-server (плюс пример бота termi-bot). Главный сервер — хаб — общий для всех и уже работает: запускать его не нужно.

Требования#

Linux: только kitty. termi использует графический протокол kitty. Если запустить его в другом терминале, клиент напишет «этот терминал не поддерживается» и завершится. Установка: sudo apt install kitty или sudo pacman -S kitty, запуск: kitty ./start-client.sh.

Первый запуск#

1. Распакуйте архив и запустите клиент (start-client.bat / ./start-client.sh).
2. На экране входа введите имя и пароль. F2 — переключение «Вход / Регистрация»; аккаунт создаётся при регистрации. Адрес хаба вводить не нужно — он встроен в клиент.
3. Чтобы пообщаться, добавьте контакт (+ добавить контакт, ник другого пользователя).

Свой сервер#

1. Запустите start-server.bat / ./start-server.sh (по умолчанию порт 7777; параметры: --name, --channels, --voice, --owner, --addr).
2. В клиенте нажмите Ctrl+N и введите адрес сервера. Первый вошедший становится владельцем (или задайте --owner ник).
3. Друзья подключаются к вашему серверу тем же способом. Если вы в одной сети — дайте им IP из ipconfig/ip a и откройте порт 7777.
4. Серверные плагины кладутся в папку plugins/ — см. Плагины. Клиенты сами предложат установить то, что требует сервер.

Обновления#

При запуске клиент проверяет, нет ли новой версии. Если есть, поверх терминала появится окно «доступно обновление»: нажмите Обновить — клиент скачает файл, проверит контрольную сумму SHA-256 и заменит себя. После установки запустите termi заново. Отключить проверку: переменная окружения TERMI_NO_UPDATE=1.

Где лежат данные#

Горячие клавиши#

ctrl+q — выход · F8 — показать/скрыть IP-адреса · esc — закрыть окно · ←→ — выбор в окнах.

Дальше#

Как устроен хаб — Хаб. Серверные плагины — Плагины. Устройство проекта — Архитектура.